Interface Message

Interface representing a Nylas Message object.

Hierarchy

  • BaseMessage
    • Message

Properties

attachments?: File[]

An array of files attached to the message.

bcc?: EmailName[]

An array of bcc recipients.

body?: string

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

cc?: EmailName[]

An array of cc recipients.

createdAt: number

Unix timestamp of when the message was created.

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: string[]

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

from?: EmailName[]

An array of message senders.

grantId: string

Grant ID of the Nylas account.

headers?: MessageHeaders[]

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

id: string

The unique identifier for the message.

metadata?: Record<string, unknown>

A list of key-value pairs storing additional data.

object: "message"

The type of object.

replyTo?: EmailName[]

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

snippet?: string

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

starred?: boolean

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

subject?: string

The message subject.

threadId?: string

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

to: EmailName[]

An array of message recipients.

unread?: boolean

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

Generated using TypeDoc