nylas
    Preparing search index...

    Interface ListMessagesQueryParams

    Interface representing the query parameters for listing messages.

    interface ListMessagesQueryParams {
        anyEmail?: string[];
        bcc?: string[];
        cc?: string[];
        fields?: MessageFields;
        from?: string[];
        hasAttachment?: boolean;
        in?: string[];
        limit?: number;
        pageToken?: string;
        receivedAfter?: number;
        receivedBefore?: number;
        searchQueryNative?: string;
        select?: string;
        starred?: boolean;
        subject?: string;
        threadId?: string;
        to?: string[];
        unread?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    anyEmail? bcc? cc? fields? from? hasAttachment? in? limit? pageToken? receivedAfter? receivedBefore? searchQueryNative? 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 messages bcc'd on these email address.

    cc?: string[]

    Return items containing messages cc'd on these email address.

    fields?: MessageFields

    Allows you to specify to return messages with headers included.

    from?: string[]

    Return items containing messages sent from these email address.

    hasAttachment?: boolean

    Return emails that contain attachments.

    in?: string[]

    Return emails that are in these folder IDs.

    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.

    receivedAfter?: number

    Return emails that have been received after this timestamp.

    receivedBefore?: number

    Return emails that have been received before this timestamp.

    searchQueryNative?: string

    The provider-specific query string used to search messages. Available for Google and Microsoft Graph only.

    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 emails that are starred.

    subject?: string

    Return items with a matching literal subject.

    threadId?: string

    Return emails that belong to this thread.

    to?: string[]

    Return items containing messages sent to these email address.

    unread?: boolean

    Return emails that are unread.

    Settings

    Member Visibility

    On This Page

    Properties