Interface SendMessageRequest

Interface representing a request to send a message.

Hierarchy

Properties

attachments? bcc? body? cc? customHeaders? from? replyTo? replyToMessageId? sendAt? starred? subject? to trackingOptions? useDraft?

Properties

Optional attachments

attachments?: CreateAttachmentRequest[]

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 customHeaders

customHeaders?: CustomHeader[]

An array of custom headers to add to the message.

Optional from

from?: EmailName[]

An array of message senders.

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 starred

starred?: boolean

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

Optional subject

subject?: string

The message subject.

to

to: EmailName[]

An array of message recipients.

Optional trackingOptions

trackingOptions?: TrackingOptions

Options for tracking opens, links, and thread replies.

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