Interface ListDraftsQueryParams

Interface representing the query parameters for listing drafts.

Hierarchy

Properties

anyEmail? bcc? cc? hasAttachment? limit? pageToken? 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 drafts bcc'ing these email address.

Optional cc

cc?: string[]

Return items containing drafts cc'ing these email address.

Optional hasAttachment

hasAttachment?: boolean

Return drafts that contain attachments.

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

Optional subject

subject?: string

Return items with a matching literal subject.

Optional threadId

threadId?: string

Return drafts that belong to this thread.

Optional to

to?: string[]

Return items containing drafts to be sent these email address.

Optional unread

unread?: boolean

Return drafts that are unread.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc