com.amazonaws.services.pinpoint.model

Class EmailMessage

java.lang.Object

com.amazonaws.services.pinpoint.model.EmailMessage

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EmailMessage
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EmailMessage()

Method Summary

Modifier and Type	Method and Description
EmailMessage	addSubstitutionsEntry(String key, List<String> value) Add a single Substitutions entry
EmailMessage	clearSubstitutionsEntries() Removes all the entries added into Substitutions.
EmailMessage	clone()
boolean	equals(Object obj)
String	getBody() The body of the email message.
String	getFeedbackForwardingAddress() The email address to forward bounces and complaints to, if feedback forwarding is enabled.
String	getFromAddress() The verified email address to send the email message from.
RawEmail	getRawEmail() The email message, represented as a raw MIME message.
List<String>	getReplyToAddresses() The reply-to email address(es) for the email message.
SimpleEmail	getSimpleEmail() The email message, composed of a subject, a text part, and an HTML part.
Map<String,List<String>>	getSubstitutions() The default message variables to use in the email message.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setBody(String body) The body of the email message.
void	setFeedbackForwardingAddress(String feedbackForwardingAddress) The email address to forward bounces and complaints to, if feedback forwarding is enabled.
void	setFromAddress(String fromAddress) The verified email address to send the email message from.
void	setRawEmail(RawEmail rawEmail) The email message, represented as a raw MIME message.
void	setReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the email message.
void	setSimpleEmail(SimpleEmail simpleEmail) The email message, composed of a subject, a text part, and an HTML part.
void	setSubstitutions(Map<String,List<String>> substitutions) The default message variables to use in the email message.
String	toString() Returns a string representation of this object.
EmailMessage	withBody(String body) The body of the email message.
EmailMessage	withFeedbackForwardingAddress(String feedbackForwardingAddress) The email address to forward bounces and complaints to, if feedback forwarding is enabled.
EmailMessage	withFromAddress(String fromAddress) The verified email address to send the email message from.
EmailMessage	withRawEmail(RawEmail rawEmail) The email message, represented as a raw MIME message.
EmailMessage	withReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the email message.
EmailMessage	withReplyToAddresses(String... replyToAddresses) The reply-to email address(es) for the email message.
EmailMessage	withSimpleEmail(SimpleEmail simpleEmail) The email message, composed of a subject, a text part, and an HTML part.
EmailMessage	withSubstitutions(Map<String,List<String>> substitutions) The default message variables to use in the email message.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailMessage

public EmailMessage()

Method Detail

setBody

public void setBody(String body)

The body of the email message.

Parameters:

body - The body of the email message.

getBody

public String getBody()

The body of the email message.

Returns:

The body of the email message.

withBody

public EmailMessage withBody(String body)

The body of the email message.

Parameters:

body - The body of the email message.

Returns:

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

setFeedbackForwardingAddress

public void setFeedbackForwardingAddress(String feedbackForwardingAddress)

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

Parameters:

feedbackForwardingAddress - The email address to forward bounces and complaints to, if feedback forwarding is enabled.

getFeedbackForwardingAddress

public String getFeedbackForwardingAddress()

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

Returns:

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

withFeedbackForwardingAddress

public EmailMessage withFeedbackForwardingAddress(String feedbackForwardingAddress)

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

Parameters:

feedbackForwardingAddress - The email address to forward bounces and complaints to, if feedback forwarding is enabled.

Returns:

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

setFromAddress

public void setFromAddress(String fromAddress)

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

Parameters:

fromAddress - The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

getFromAddress

public String getFromAddress()

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

Returns:

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

withFromAddress

public EmailMessage withFromAddress(String fromAddress)

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

Parameters:

fromAddress - The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

Returns:

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

setRawEmail

public void setRawEmail(RawEmail rawEmail)

The email message, represented as a raw MIME message.

Parameters:

rawEmail - The email message, represented as a raw MIME message.

getRawEmail

public RawEmail getRawEmail()

The email message, represented as a raw MIME message.

Returns:

The email message, represented as a raw MIME message.

withRawEmail

public EmailMessage withRawEmail(RawEmail rawEmail)

The email message, represented as a raw MIME message.

Parameters:

rawEmail - The email message, represented as a raw MIME message.

Returns:

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

getReplyToAddresses

public List<String> getReplyToAddresses()

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

Returns:

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

setReplyToAddresses

public void setReplyToAddresses(Collection<String> replyToAddresses)

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

Parameters:

replyToAddresses - The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

withReplyToAddresses

public EmailMessage withReplyToAddresses(String... replyToAddresses)

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

NOTE: This method appends the values to the existing list (if any). Use setReplyToAddresses(java.util.Collection) or withReplyToAddresses(java.util.Collection) if you want to override the existing values.

Parameters:

replyToAddresses - The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

Returns:

Returns a reference to this 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 message. If a recipient replies to the email, each reply-to address receives the reply.

Parameters:

replyToAddresses - The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

Returns:

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

setSimpleEmail

public void setSimpleEmail(SimpleEmail simpleEmail)

The email message, composed of a subject, a text part, and an HTML part.

Parameters:

simpleEmail - The email message, composed of a subject, a text part, and an HTML part.

getSimpleEmail

public SimpleEmail getSimpleEmail()

The email message, composed of a subject, a text part, and an HTML part.

Returns:

The email message, composed of a subject, a text part, and an HTML part.

withSimpleEmail

public EmailMessage withSimpleEmail(SimpleEmail simpleEmail)

The email message, composed of a subject, a text part, and an HTML part.

Parameters:

simpleEmail - The email message, composed of a subject, a text part, and an HTML part.

Returns:

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

getSubstitutions

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

The default message variables to use in the email message. You can override the default variables with individual address variables.

Returns:

The default message variables to use in the email message. You can override the default variables with individual address variables.

setSubstitutions

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

The default message variables to use in the email message. You can override the default variables with individual address variables.

Parameters:

substitutions - The default message variables to use in the email message. You can override the default variables with individual address variables.

withSubstitutions

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

The default message variables to use in the email message. You can override the default variables with individual address variables.

Parameters:

substitutions - The default message variables to use in the email message. You can override the default variables with individual address variables.

Returns:

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

addSubstitutionsEntry

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

Add a single Substitutions entry

See Also:

withSubstitutions(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearSubstitutionsEntries

public EmailMessage clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

Returns:

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EmailMessage clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo