Interface Message

Interface representing a Nylas Message object.

Hierarchy

  • BaseMessage
    • Message

Properties

attachments? bcc? body? cc? createdAt date folders from? grantId headers? id metadata? object replyTo? scheduleId? sendAt? snippet? starred? subject? threadId? to unread? useDraft?

Properties

Optional attachments

attachments?: Attachment[]

An array of files attached to the message.

Optional bcc

bcc?: EmailName[]

An array of bcc recipients.

Optional body

body?: string

The full HTML message body. Messages with only plain-text representations are up-converted to HTML.

Optional cc

cc?: EmailName[]

An array of cc recipients.

createdAt

createdAt: number

Unix timestamp of when the message was created.

date

date: number

Unix timestamp of when the message was received by the mail server. This may be different from the unverified Date header in raw message object.

folders

folders: string[]

The ID of the folder(s) the message appears in.

Optional from

from?: EmailName[]

An array of message senders.

grantId

grantId: string

Grant ID of the Nylas account.

Optional headers

headers?: MessageHeaders[]

The message headers. Only present if the 'fields' query parameter is set to includeHeaders.

id

id: string

The unique identifier for the message.

Optional metadata

metadata?: Record<string, unknown>

A list of key-value pairs storing additional data.

object

object: "message"

The type of object.

Optional replyTo

replyTo?: EmailName[]

An array of name and email pairs that override the sent reply-to headers.

Optional scheduleId

scheduleId?: string

The unique identifier for the scheduled message.

Optional sendAt

sendAt?: number

Unix timestamp to send the message at.

Optional snippet

snippet?: string

A short snippet of the message body. This is the first 100 characters of the message body, with any HTML tags removed.

Optional starred

starred?: boolean

Whether or not the message has been starred by the user.

Optional subject

subject?: string

The message subject.

Optional threadId

threadId?: string

A reference to the parent thread object. If this is a new draft, the thread will be empty.

to

to: EmailName[]

An array of message recipients.

Optional unread

unread?: boolean

Whether or not the message has been read by the user.

Optional useDraft

useDraft?: boolean

Whether or not to use draft support. This is primarily used when dealing with large attachments.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc