nylas
    Preparing search index...

    Interface Folder

    Interface of a folder object from Nylas.

    interface Folder {
        attributes?: string[];
        backgroundColor?: string;
        childCount?: number;
        grantId: string;
        id: string;
        name: string;
        object: string;
        parentId?: string;
        systemFolder?: boolean;
        textColor?: string;
        totalCount?: number;
        unreadCount?: number;
    }
    Index

    Properties

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

    Properties

    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.

    backgroundColor?: string

    (Google only) Folder background color.

    childCount?: number

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

    grantId: string

    Grant ID of the Nylas account

    id: string

    A globally unique object identifier.

    name: string

    Folder name.

    object: string

    The type of object.

    parentId?: string

    (Microsoft only) ID of the parent folder.

    systemFolder?: boolean

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

    textColor?: string

    (Google only) Folder text color.

    totalCount?: number

    The number of items inside of a folder.

    unreadCount?: number

    The number of unread items inside of a folder.

    Settings

    Member Visibility

    On This Page

    Properties