com.amazonaws.services.simpleemail.model

Class Destination

java.lang.Object

com.amazonaws.services.simpleemail.model.Destination

All Implemented Interfaces:

Serializable, Cloneable

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

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Destination() Default constructor for Destination object.
Destination(List<String> toAddresses) Constructs a new Destination object.

Method Summary

Modifier and Type	Method and Description
Destination	clone()
boolean	equals(Object obj)
List<String>	getBccAddresses() The recipients to place on the BCC: line of the message.
List<String>	getCcAddresses() The recipients to place on the CC: line of the message.
List<String>	getToAddresses() The recipients to place on the To: line of the message.
int	hashCode()
void	setBccAddresses(Collection<String> bccAddresses) The recipients to place on the BCC: line of the message.
void	setCcAddresses(Collection<String> ccAddresses) The recipients to place on the CC: line of the message.
void	setToAddresses(Collection<String> toAddresses) The recipients to place on the To: line of the message.
String	toString() Returns a string representation of this object.
Destination	withBccAddresses(Collection<String> bccAddresses) The recipients to place on the BCC: line of the message.
Destination	withBccAddresses(String... bccAddresses) The recipients to place on the BCC: line of the message.
Destination	withCcAddresses(Collection<String> ccAddresses) The recipients to place on the CC: line of the message.
Destination	withCcAddresses(String... ccAddresses) The recipients to place on the CC: line of the message.
Destination	withToAddresses(Collection<String> toAddresses) The recipients to place on the To: line of the message.
Destination	withToAddresses(String... toAddresses) The recipients to place on the To: line of the message.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Destination

public Destination()

Default constructor for Destination object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

Destination

public Destination(List<String> toAddresses)

Constructs a new Destination object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

toAddresses - The recipients to place on the To: line of the message.

Method Detail

getToAddresses

public List<String> getToAddresses()

The recipients to place on the To: line of the message.

Returns:

The recipients to place on the To: line of the message.

setToAddresses

public void setToAddresses(Collection<String> toAddresses)

The recipients to place on the To: line of the message.

Parameters:

toAddresses - The recipients to place on the To: line of the message.

withToAddresses

public Destination withToAddresses(String... toAddresses)

The recipients to place on the To: line of the message.

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

Parameters:

toAddresses - The recipients to place on the To: line of the message.

Returns:

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

withToAddresses

public Destination withToAddresses(Collection<String> toAddresses)

The recipients to place on the To: line of the message.

Parameters:

toAddresses - The recipients to place on the To: line of the message.

Returns:

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

getCcAddresses

public List<String> getCcAddresses()

The recipients to place on the CC: line of the message.

Returns:

The recipients to place on the CC: line of the message.

setCcAddresses

public void setCcAddresses(Collection<String> ccAddresses)

The recipients to place on the CC: line of the message.

Parameters:

ccAddresses - The recipients to place on the CC: line of the message.

withCcAddresses

public Destination withCcAddresses(String... ccAddresses)

The recipients to place on the CC: line of the message.

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

Parameters:

ccAddresses - The recipients to place on the CC: line of the message.

Returns:

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

withCcAddresses

public Destination withCcAddresses(Collection<String> ccAddresses)

The recipients to place on the CC: line of the message.

Parameters:

ccAddresses - The recipients to place on the CC: line of the message.

Returns:

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

getBccAddresses

public List<String> getBccAddresses()

The recipients to place on the BCC: line of the message.

Returns:

The recipients to place on the BCC: line of the message.

setBccAddresses

public void setBccAddresses(Collection<String> bccAddresses)

The recipients to place on the BCC: line of the message.

Parameters:

bccAddresses - The recipients to place on the BCC: line of the message.

withBccAddresses

public Destination withBccAddresses(String... bccAddresses)

The recipients to place on the BCC: line of the message.

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

Parameters:

bccAddresses - The recipients to place on the BCC: line of the message.

Returns:

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

withBccAddresses

public Destination withBccAddresses(Collection<String> bccAddresses)

The recipients to place on the BCC: line of the message.

Parameters:

bccAddresses - The recipients to place on the BCC: line of the message.

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 Destination clone()

Overrides:

clone in class Object