nylas
    Preparing search index...

    Interface ListFolderQueryParams

    Interface representing the query parameters for listing folders.

    interface ListFolderQueryParams {
        includeHiddenFolders?: boolean;
        limit?: number;
        pageToken?: string;
        parentId?: string;
        select?: string;
        singleLevel?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    includeHiddenFolders? limit? pageToken? parentId? select? singleLevel?

    Properties

    includeHiddenFolders?: boolean

    (Microsoft only) When true, Nylas includes hidden folders in its response.

    limit?: number

    The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

    pageToken?: string

    An identifier that specifies which page of data to return. This value should be taken from the [ListResponse.nextCursor] response field.

    parentId?: string

    (Microsoft and EWS only.) Use the ID of a folder to find all child folders it contains.

    select?: string

    Specify fields that you want Nylas to return as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in.

    singleLevel?: boolean

    (Microsoft only) If true, retrieves folders from a single-level hierarchy only. If false, retrieves folders across a multi-level hierarchy.

    false

    Settings

    Member Visibility

    On This Page

    Properties