CreateDraftRequest

public final class CreateDraftRequest implements IMessageAttachmentRequest

Class representing a request to create a draft.

Constructors

Link copied to clipboard
public CreateDraftRequest CreateDraftRequest(@Json(name = "to") List<EmailName> to, @Json(name = "bcc") List<EmailName> bcc, @Json(name = "cc") List<EmailName> cc, @Json(name = "reply_to") List<EmailName> replyTo, List<CreateAttachmentRequest> attachments, @Json(name = "snippet") String snippet, @Json(name = "subject") String subject, @Json(name = "thread_id") String threadId, @Json(name = "body") String body, @Json(name = "starred") Boolean starred, @Json(name = "unread") Boolean unread, @Json(name = "send_at") Integer sendAt, @Json(name = "reply_to_message_id") String replyToMessageId, @Json(name = "tracking_options") TrackingOptions trackingOptions)

Types

Link copied to clipboard
public final class Builder

Builder for CreateDraftRequest.

Properties

Link copied to clipboard
private final transient List<CreateAttachmentRequest> attachments

An array of files to attach to the message.

Link copied to clipboard
private final List<EmailName> bcc

An array of bcc recipients.

Link copied to clipboard
private final String body

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

Link copied to clipboard
private final List<EmailName> cc

An array of cc recipients.

Link copied to clipboard
private final List<EmailName> replyTo

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

Link copied to clipboard
private final String replyToMessageId

The ID of the message that you are replying to.

Link copied to clipboard
private final Integer sendAt

Unix timestamp to send the message at.

Link copied to clipboard
private final String snippet

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

Link copied to clipboard
private final Boolean starred

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

Link copied to clipboard
private final String subject

The message subject.

Link copied to clipboard
private final String threadId

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

Link copied to clipboard
private final List<EmailName> to

An array of message recipients.

Link copied to clipboard

Options for tracking opens, links, and thread replies.

Link copied to clipboard
private final Boolean unread

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

Functions

Link copied to clipboard

An array of files to attach to the message.

Link copied to clipboard
public final List<EmailName> getBcc()

An array of bcc recipients.

Link copied to clipboard
public final String getBody()

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

Link copied to clipboard
public final List<EmailName> getCc()

An array of cc recipients.

Link copied to clipboard
public final List<EmailName> getReplyTo()

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

Link copied to clipboard
public final String getReplyToMessageId()

The ID of the message that you are replying to.

Link copied to clipboard
public final Integer getSendAt()

Unix timestamp to send the message at.

Link copied to clipboard
public final String getSnippet()

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

Link copied to clipboard
public final Boolean getStarred()

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

Link copied to clipboard
public final String getSubject()

The message subject.

Link copied to clipboard
public final String getThreadId()

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

Link copied to clipboard
public final List<EmailName> getTo()

An array of message recipients.

Link copied to clipboard

Options for tracking opens, links, and thread replies.

Link copied to clipboard
public final Boolean getUnread()

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