Interface CreateDraftRequest

Interface representing a request to create a draft.

Hierarchy

Properties

attachments? bcc? body? cc? replyTo? replyToMessageId? sendAt? snippet? starred? subject? threadId? to trackingOptions? unread?

Properties

Optional attachments

attachments?: CreateFileRequest[]

An array of files to attach 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.

Optional replyTo

replyTo?: EmailName[]

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

Optional replyToMessageId

replyToMessageId?: string

The ID of the message that you are replying to.

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 trackingOptions

trackingOptions?: TrackingOptions

Options for tracking opens, links, and thread replies.

Optional unread

unread?: boolean

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc