nylas/com.nylas.models/SendTransactionalEmailRequest

SendTransactionalEmailRequest

public final class SendTransactionalEmailRequest implements IMessageAttachmentRequest

Class representing a request to send a transactional email from a verified domain.

Constructors

public SendTransactionalEmailRequest SendTransactionalEmailRequest(@Json(name = "to") List<EmailName> to, @Json(name = "from") EmailName from, @Json(name = "bcc") List<EmailName> bcc, @Json(name = "cc") List<EmailName> cc, @Json(name = "reply_to") List<EmailName> replyTo, @Json(name = "attachments") List<CreateAttachmentRequest> attachments, @Json(name = "subject") String subject, @Json(name = "body") String body, @Json(name = "send_at") Long sendAt, @Json(name = "reply_to_message_id") String replyToMessageId, @Json(name = "tracking_options") TrackingOptions trackingOptions, @Json(name = "use_draft") Boolean useDraft, @Json(name = "custom_headers") List<CustomHeader> customHeaders, @Json(name = "is_plaintext") Boolean isPlaintext)

Types

Builder

public final class Builder

Builder for SendTransactionalEmailRequest.

Properties

attachments

private final List<CreateAttachmentRequest> attachments

An array of files to attach to the message.

bcc

private final List<EmailName> bcc

An array of bcc recipients.

body

private final String body

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

private final List<EmailName> cc

An array of cc recipients.

customHeaders

private final List<CustomHeader> customHeaders

A list of custom headers to add to the message.

from

private final EmailName from

The sender. Must use a verified domain email address.

isPlaintext

private final Boolean isPlaintext

When true, the message body is sent as plain text and the MIME data doesn't include the HTML version of the message. When false, the message body is sent as HTML.

replyTo

private final List<EmailName> replyTo

An array of name and email pairs that override the sent reply-to headers. Recommended if there is no Agent Account on the domain to receive replies.

replyToMessageId

private final String replyToMessageId

The ID of the message that you are replying to.

sendAt

private final Long sendAt

Unix timestamp to send the message at.

subject

private final String subject

The message subject.

private final List<EmailName> to

An array of message recipients.

trackingOptions

private final TrackingOptions trackingOptions

Options for tracking opens, links, and thread replies.

useDraft

private final Boolean useDraft

Whether or not to use draft support. This is primarily used when dealing with large attachments.

Functions

getAttachments

public List<CreateAttachmentRequest> getAttachments()

An array of files to attach to the message.

getBcc

public final List<EmailName> getBcc()

An array of bcc recipients.

getBody

public final String getBody()

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

getCc

public final List<EmailName> getCc()

An array of cc recipients.

getCustomHeaders

public final List<CustomHeader> getCustomHeaders()

A list of custom headers to add to the message.

getFrom

public final EmailName getFrom()

The sender. Must use a verified domain email address.

getReplyTo

public final List<EmailName> getReplyTo()

An array of name and email pairs that override the sent reply-to headers. Recommended if there is no Agent Account on the domain to receive replies.

getReplyToMessageId

public final String getReplyToMessageId()

The ID of the message that you are replying to.

getSendAt

public final Long getSendAt()

Unix timestamp to send the message at.

getSubject

public final String getSubject()

The message subject.

getTo

public final List<EmailName> getTo()

An array of message recipients.

getTrackingOptions

public final TrackingOptions getTrackingOptions()

Options for tracking opens, links, and thread replies.

getUseDraft

public final Boolean getUseDraft()

Whether or not to use draft support. This is primarily used when dealing with large attachments.

isPlaintext

public final Boolean isPlaintext()

When true, the message body is sent as plain text and the MIME data doesn't include the HTML version of the message. When false, the message body is sent as HTML.