Interface Folder

Interface of a folder object from Nylas.

Hierarchy

  • Folder

Properties

attributes? backgroundColor? childCount? grantId id name object parentId? systemFolder? textColor? totalCount? unreadCount?

Properties

Optional attributes

attributes?: string[]

Common attribute descriptors shared by system folders across providers. For example, Sent email folders have the ["\\Sent"] attribute. For IMAP grants, IMAP providers provide the attributes. For Google and Microsoft Graph, Nylas matches system folders to a set of common attributes.

Optional backgroundColor

backgroundColor?: string

(Google only) Folder background color.

Optional childCount

childCount?: number

(Microsoft only) The number of immediate child folders in the current folder.

grantId

grantId: string

Grant ID of the Nylas account

id

id: string

A globally unique object identifier.

name

name: string

Folder name.

object

object: string

The type of object.

Optional parentId

parentId?: string

(Microsoft only) ID of the parent folder.

Optional systemFolder

systemFolder?: boolean

(Google only) Indicates if the folder is user created or system created.

Optional textColor

textColor?: string

(Google only) Folder text color.

Optional totalCount

totalCount?: number

The number of items inside of a folder.

Optional unreadCount

unreadCount?: number

The number of unread items inside of a folder.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc