Interface ListThreadsQueryParams

Interface representing the query parameters for listing drafts.

Hierarchy

Properties

anyEmail? bcc? cc? from? hasAttachment? in? latestMessageAfter? latestMessageBefore? limit? pageToken? searchQueryNative? select? starred? subject? to? unread?

Properties

Optional anyEmail

anyEmail?: string[]

Return threads that contain messages that have been sent or received from this list of email addresses.

Optional bcc

bcc?: string[]

Return threads containing messages bcc'd on these email address.

Optional cc

cc?: string[]

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

Optional from

from?: string[]

Return threads containing messages sent from these email address.

Optional hasAttachment

hasAttachment?: boolean

Return threads with messages that contain attachments.

Optional in

in?: string[]

Return threads with messages that belong to these specified folder IDs.

Optional latestMessageAfter

latestMessageAfter?: number

Return threads whose most recent message was received after this Unix timestamp.

Optional latestMessageBefore

latestMessageBefore?: number

Return threads whose most recent message was received before this Unix timestamp.

Optional limit

limit?: number

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

Optional pageToken

pageToken?: string

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

Optional searchQueryNative

searchQueryNative?: string

The provider-specific query string used to search threads. Available for Google only.

Optional select

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.

Optional starred

starred?: boolean

Return threads with starred messages.

Optional subject

subject?: string

Return items with a matching literal subject.

Optional to

to?: string[]

Return threads containing messages sent to these email address.

Optional unread

unread?: boolean

Return threads with unread messages.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc