Interface ListMessagesQueryParams

Interface representing the query parameters for listing messages.

Hierarchy

Properties

anyEmail? bcc? cc? fields? from? hasAttachment? in? limit? pageToken? receivedAfter? receivedBefore? searchQueryNative? select? starred? subject? threadId? to? unread?

Properties

Optional anyEmail

anyEmail?: string[]

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

Optional bcc

bcc?: string[]

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

Optional cc

cc?: string[]

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

Optional fields

fields?: MessageFields

Allows you to specify to return messages with headers included.

Optional from

from?: string[]

Return items containing messages sent from these email address.

Optional hasAttachment

hasAttachment?: boolean

Return emails that contain attachments.

Optional in

in?: string[]

Return emails that are in these folder IDs.

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 receivedAfter

receivedAfter?: number

Return emails that have been received after this timestamp.

Optional receivedBefore

receivedBefore?: number

Return emails that have been received before this timestamp.

Optional searchQueryNative

searchQueryNative?: string

The provider-specific query string used to search messages. Available for Google and Microsoft Graph 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 emails that are starred.

Optional subject

subject?: string

Return items with a matching literal subject.

Optional threadId

threadId?: string

Return emails that belong to this thread.

Optional to

to?: string[]

Return items containing messages sent to these email address.

Optional unread

unread?: boolean

Return emails that are unread.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc