Class MailService.Message (2.0.0) 

public static class MailService.Message

Messages are prepared by the caller, and then submitted to the Mail service for sending. Different fields are subject to different constraints, as enumerated in the send and sendToAdmins methods.

Inheritance

java.lang.Object > MailService.Message

Constructors

Message()

public Message()

Message(String sender, String to, String subject, String textBody)

public Message(String sender, String to, String subject, String textBody)

Convenience constructor for simple messages

Parameters
Name Description
sender String

The sender's email address.
to String

The recipient's email address or null for empty to address.
subject String

The message subject.
textBody String

The text body of the message.

Methods

getAmpHtmlBody()

public String getAmpHtmlBody()

Gets the AMP HTML body of this message. See #setAmpHtmlBody for more details.

Returns
Type Description
String

The AMP HTML body.

getAttachments()

public Collection<MailService.Attachment> getAttachments()

Gets the attachments of this message.

Returns
Type Description
Collection<Attachment>

A collection containing the attachments of this message.

getBcc()

public Collection<String> getBcc()

Gets the recipients in the 'bcc' field of this message.

Returns
Type Description
Collection<String>

A collection containing the 'bcc' field recipients.

getCc()

public Collection<String> getCc()

Gets the recipients in the 'cc' field of this message.

Returns
Type Description
Collection<String>

A collection containing the 'cc' field recipients.

getHeaders()

public Collection<MailService.Header> getHeaders()

Gets the headers of this message.

Returns
Type Description
Collection<Header>

A collection containing the headers of this message.

getHtmlBody()

public String getHtmlBody()

Gets the html body of this message.

Returns
Type Description
String

The html body.

getReplyTo()

public String getReplyTo()

Gets the reply to field of this message.

Returns
Type Description
String

The reply to field of this message.

getSender()

public String getSender()

Gets the sender of this message.

Returns
Type Description
String

The sender of this message.

getSubject()

public String getSubject()

Gets the subject of this message.

Returns
Type Description
String

The subject of this message.

getTextBody()

public String getTextBody()

Gets the text body of this message.

Returns
Type Description
String

The text body.

getTo()

public Collection<String> getTo()

Gets the recipients in the 'to' field of this message.

Returns
Type Description
Collection<String>

A collection containing the 'to' field recipients.

setAmpHtmlBody(String ampHtmlBody)

public void setAmpHtmlBody(String ampHtmlBody)

Sets the AMP HTML body of this message. This field is optional. Setting AMP HTML body makes the email an AMP Email. Plain text or HTML may become fallback content depending on the email client used.

Parameter
Name Description
ampHtmlBody String

A string containing the new AMP HTML body of this message.

setAttachments(MailService.Attachment[] attachments)

public void setAttachments(MailService.Attachment[] attachments)

Sets the attachments of this message. attachments may be null, otherwise each attachment must have a corresponding file name with an extension not on the block list.

Parameter
Name Description
attachments Attachment[]

Attachments to attach to this message.

setAttachments(Collection<MailService.Attachment> attachments)

public void setAttachments(Collection<MailService.Attachment> attachments)

Sets the attachments of this message. attachments may be null, otherwise each attachment must have a corresponding file name with an extension not on the block list.

Parameter
Name Description
attachments Collection<Attachment>

A collection of attachments.

setBcc(String[] bcc)

public void setBcc(String[] bcc)

Sets the 'bcc' field of this message. Each string represents exactly one email address. Having null (or invalid addresses) will lead bcc eventual failure during the send process.

Parameter
Name Description
bcc String[]

The email addresses bcc set as the 'bcc' field.

setBcc(Collection<String> bcc)

public void setBcc(Collection<String> bcc)

Sets the 'bcc' field of this message. Each string in the collection represents exactly one email address. Having null (or invalid addresses) will lead bcc eventual failure during the send process.

Parameter
Name Description
bcc Collection<String>

A collection containing the email addresses bcc set as the 'bcc' field.

setCc(String[] cc)

public void setCc(String[] cc)

Sets the 'cc' field of this message. Each string represents exactly one email address. Having null (or invalid addresses) will lead cc eventual failure during the send process.

Parameter
Name Description
cc String[]

The email addresses cc set as the 'cc' field.

setCc(Collection<String> cc)

public void setCc(Collection<String> cc)

Sets the 'cc' field of this message. Each string in the collection represents exactly one email address. Having null (or invalid addresses) will lead cc eventual failure during the send process.

Parameter
Name Description
cc Collection<String>

A collection containing the email addresses cc set as the 'cc' field.

setHeaders(MailService.Header[] headers)

public void setHeaders(MailService.Header[] headers)

Sets the headers of this message. headers may be null, otherwise each header name must be one of the allowed names.

Parameter
Name Description
headers Header[]

A collection of headers.

setHeaders(Collection<MailService.Header> headers)

public void setHeaders(Collection<MailService.Header> headers)

Sets the headers of this message. headers may be null, otherwise each header name must be one of the allowed names.

Parameter
Name Description
headers Collection<Header>

A collection of headers.

setHtmlBody(String htmlBody)

public void setHtmlBody(String htmlBody)

Sets the html body of this message. At least one of textBody and htmlBody must not be null.

Parameter
Name Description
htmlBody String

A string containing the new html body of this message.

setReplyTo(String replyTo)

public void setReplyTo(String replyTo)

replyTo may be null, or must be a valid email address otherwise.

Parameter
Name Description
replyTo String

setSender(String sender)

public void setSender(String sender)

sender must correspond to the valid email address of one of the admins for this application, or to the email address of the currently logged-in user. Sender is really the From: field of the email.

Parameter
Name Description
sender String

setSubject(String subject)

public void setSubject(String subject)

Sets the subject of this message. A null or empty subject will lead to eventual failure during the send process.

Parameter
Name Description
subject String

A string containing the new subject of this message.

setTextBody(String textBody)

public void setTextBody(String textBody)

Sets the text body of this message. At least one of textBody and htmlBody must not be null.

Parameter
Name Description
textBody String

A string containing the new text body of this message.

setTo(String[] to)

public void setTo(String[] to)

Sets the 'to' field of this message. Each string represents exactly one email address. Having null (or invalid addresses) will lead to eventual failure during the send process.

Parameter
Name Description
to String[]

The email addresses to set as the 'to' field.

setTo(Collection<String> to)

public void setTo(Collection<String> to)

Sets the 'to' field of this message. Each string in the collection represents exactly one email address. Having null (or invalid addresses) will lead to eventual failure during the send process.

Parameter
Name Description
to Collection<String>

A collection containing the email addresses to set as the 'to' field.