nylas
    Preparing search index...

    Interface ListDraftsQueryParams

    Interface representing the query parameters for listing drafts.

    interface ListDraftsQueryParams {
        anyEmail?: string[];
        bcc?: string[];
        cc?: string[];
        hasAttachment?: boolean;
        limit?: number;
        pageToken?: string;
        select?: string;
        starred?: boolean;
        subject?: string;
        threadId?: string;
        to?: string[];
        unread?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    anyEmail? bcc? cc? hasAttachment? limit? pageToken? select? starred? subject? threadId? to? unread?

    Properties

    anyEmail?: string[]

    Return emails that have been sent or received from this list of email addresses.

    bcc?: string[]

    Return items containing drafts bcc'ing these email address.

    cc?: string[]

    Return items containing drafts cc'ing these email address.

    hasAttachment?: boolean

    Return drafts that contain attachments.

    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.

    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.

    starred?: boolean

    Return drafts that are starred.

    subject?: string

    Return items with a matching literal subject.

    threadId?: string

    Return drafts that belong to this thread.

    to?: string[]

    Return items containing drafts to be sent these email address.

    unread?: boolean

    Return drafts that are unread.

    Settings

    Member Visibility

    On This Page

    Properties