com.amazonaws.services.pinpoint.model

Class EmailMessage

java.lang.Object

com.amazonaws.services.pinpoint.model.EmailMessage

All Implemented Interfaces:

Serializable

public class EmailMessage
extends Object
implements Serializable

Email Message.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EmailMessage()

Method Summary

Modifier and Type	Method and Description
EmailMessage	addSubstitutionsEntry(String key, List<String> value) Default message substitutions.
EmailMessage	clearSubstitutionsEntries() Removes all the entries added into Substitutions.
boolean	equals(Object obj)
String	getBody() The body of the email message.
String	getFeedbackForwardingAddress() The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
String	getFromAddress() The email address used to send the email from.
RawEmail	getRawEmail() An email represented as a raw MIME message.
List<String>	getReplyToAddresses() The reply-to email address(es) for the email.
SimpleEmail	getSimpleEmail() An email composed of a subject, a text part and a html part.
Map<String,List<String>>	getSubstitutions() Default message substitutions.
int	hashCode()
void	setBody(String body) The body of the email message.
void	setFeedbackForwardingAddress(String feedbackForwardingAddress) The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
void	setFromAddress(String fromAddress) The email address used to send the email from.
void	setRawEmail(RawEmail rawEmail) An email represented as a raw MIME message.
void	setReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the email.
void	setSimpleEmail(SimpleEmail simpleEmail) An email composed of a subject, a text part and a html part.
void	setSubstitutions(Map<String,List<String>> substitutions) Default message substitutions.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EmailMessage	withBody(String body) The body of the email message.
EmailMessage	withFeedbackForwardingAddress(String feedbackForwardingAddress) The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
EmailMessage	withFromAddress(String fromAddress) The email address used to send the email from.
EmailMessage	withRawEmail(RawEmail rawEmail) An email represented as a raw MIME message.
EmailMessage	withReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the email.
EmailMessage	withReplyToAddresses(String... replyToAddresses) The reply-to email address(es) for the email.
EmailMessage	withSimpleEmail(SimpleEmail simpleEmail) An email composed of a subject, a text part and a html part.
EmailMessage	withSubstitutions(Map<String,List<String>> substitutions) Default message substitutions.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EmailMessage

public EmailMessage()

Method Detail

getBody

public String getBody()

The body of the email message.

Returns:

The body of the email message.

setBody

public void setBody(String body)

The body of the email message.

Parameters:

body - The body of the email message.

withBody

public EmailMessage withBody(String body)

The body of the email message.

Returns a reference to this object so that method calls can be chained together.

Parameters:

body - The body of the email message.

Returns:

A reference to this updated object so that method calls can be chained together.

getFeedbackForwardingAddress

public String getFeedbackForwardingAddress()

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

Returns:

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

setFeedbackForwardingAddress

public void setFeedbackForwardingAddress(String feedbackForwardingAddress)

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

Parameters:

feedbackForwardingAddress - The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

withFeedbackForwardingAddress

public EmailMessage withFeedbackForwardingAddress(String feedbackForwardingAddress)

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

Returns a reference to this object so that method calls can be chained together.

Parameters:

feedbackForwardingAddress - The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

Returns:

A reference to this updated object so that method calls can be chained together.

getFromAddress

public String getFromAddress()

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

Returns:

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

setFromAddress

public void setFromAddress(String fromAddress)

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

Parameters:

fromAddress - The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

withFromAddress

public EmailMessage withFromAddress(String fromAddress)

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

Returns a reference to this object so that method calls can be chained together.

Parameters:

fromAddress - The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

Returns:

A reference to this updated object so that method calls can be chained together.

getRawEmail

public RawEmail getRawEmail()

An email represented as a raw MIME message.

Returns:

An email represented as a raw MIME message.

setRawEmail

public void setRawEmail(RawEmail rawEmail)

An email represented as a raw MIME message.

Parameters:

rawEmail - An email represented as a raw MIME message.

withRawEmail

public EmailMessage withRawEmail(RawEmail rawEmail)

An email represented as a raw MIME message.

Returns a reference to this object so that method calls can be chained together.

Parameters:

rawEmail - An email represented as a raw MIME message.

Returns:

A reference to this updated object so that method calls can be chained together.

getReplyToAddresses

public List<String> getReplyToAddresses()

The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

Returns:

The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

setReplyToAddresses

public void setReplyToAddresses(Collection<String> replyToAddresses)

The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

Parameters:

replyToAddresses - The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

withReplyToAddresses

public EmailMessage withReplyToAddresses(String... replyToAddresses)

The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

Returns a reference to this object so that method calls can be chained together.

Parameters:

replyToAddresses - The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

Returns:

A reference to this updated object so that method calls can be chained together.

withReplyToAddresses

public EmailMessage withReplyToAddresses(Collection<String> replyToAddresses)

The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

Returns a reference to this object so that method calls can be chained together.

Parameters:

replyToAddresses - The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

Returns:

A reference to this updated object so that method calls can be chained together.

getSimpleEmail

public SimpleEmail getSimpleEmail()

An email composed of a subject, a text part and a html part.

Returns:

An email composed of a subject, a text part and a html part.

setSimpleEmail

public void setSimpleEmail(SimpleEmail simpleEmail)

An email composed of a subject, a text part and a html part.

Parameters:

simpleEmail - An email composed of a subject, a text part and a html part.

withSimpleEmail

public EmailMessage withSimpleEmail(SimpleEmail simpleEmail)

An email composed of a subject, a text part and a html part.

Returns a reference to this object so that method calls can be chained together.

Parameters:

simpleEmail - An email composed of a subject, a text part and a html part.

Returns:

A reference to this updated object so that method calls can be chained together.

getSubstitutions

public Map<String,List<String>> getSubstitutions()

Default message substitutions. Can be overridden by individual address substitutions.

Returns:

Default message substitutions. Can be overridden by individual address substitutions.

setSubstitutions

public void setSubstitutions(Map<String,List<String>> substitutions)

Default message substitutions. Can be overridden by individual address substitutions.

Parameters:

substitutions - Default message substitutions. Can be overridden by individual address substitutions.

withSubstitutions

public EmailMessage withSubstitutions(Map<String,List<String>> substitutions)

Default message substitutions. Can be overridden by individual address substitutions.

Returns a reference to this object so that method calls can be chained together.

Parameters:

substitutions - Default message substitutions. Can be overridden by individual address substitutions.

Returns:

A reference to this updated object so that method calls can be chained together.

addSubstitutionsEntry

public EmailMessage addSubstitutionsEntry(String key,
                                          List<String> value)

Default message substitutions. Can be overridden by individual address substitutions.

The method adds a new key-value pair into Substitutions parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Substitutions.

value - The corresponding value of the entry to be added into Substitutions.

Returns:

A reference to this updated object so that method calls can be chained together.

clearSubstitutionsEntries

public EmailMessage clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object