nylas/com.nylas.models/SendMessageRequest

SendMessageRequest

public final class SendMessageRequest implements IMessageAttachmentRequest

Class representing a request to send a message.

Constructors

SendMessageRequest

public SendMessageRequest SendMessageRequest(@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 = "subject") String subject, @Json(name = "body") String body, @Json(name = "starred") Boolean starred, @Json(name = "send_at") Integer 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)

Types

public final class Builder

Builder for SendMessageRequest.

Properties

private final transient List<CreateAttachmentRequest> attachments

An array of files to attach to the message.

private final List<EmailName> bcc

An array of bcc recipients.

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.

private final List<CustomHeader> customHeaders

A list of custom headers to add to the message.

private final List<EmailName> replyTo

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

replyToMessageId

private final String replyToMessageId

The ID of the message that you are replying to.

private final Integer sendAt

Unix timestamp to send the message at.

private final Boolean starred

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

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.

private final Boolean useDraft

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

Functions

public List<CreateAttachmentRequest> getAttachments()

An array of files to attach to the message.

public final List<EmailName> getBcc()

An array of bcc recipients.

public final String getBody()

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

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.

public final List<EmailName> getReplyTo()

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

getReplyToMessageId

public final String getReplyToMessageId()

The ID of the message that you are replying to.

public final Integer getSendAt()

Unix timestamp to send the message at.

public final Boolean getStarred()

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

public final String getSubject()

The message subject.

public final List<EmailName> getTo()

An array of message recipients.

getTrackingOptions

public final TrackingOptions getTrackingOptions()

Options for tracking opens, links, and thread replies.

public final Boolean getUseDraft()

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