Draft message

A draft is a message that has not been sent yet.

Properties

Property

Type

Description

id

String

ID of the draft

channel

Channel

Channel that will be used to send the message.

to

Array of

Recipient

List of recipients the draft is addressed to.

cc

Array of

Recipient

(optional)

List of recipient in copy of the draft.

bcc

Array of

Recipient

(optional)

List of recipients in blind copy of the draft.

subject

String (optional)

Subject of the draft.

content

Object

content.body

String

Body of the draft.

content.type

String

Content type of the

body

. Can be either

html

or

text

.

content.attachments

Array of

Attachment

List of attachments in the draft.

isEditable

Boolean

Flag which determines if the draft is editable.

Draft vs Message

The Plugin SDK makes the distinction between a Draft message and a Message.
While they have similar properties, the plugin SDK can interact with a Draft by creating and updating them.