software.amazon.awssdk.services.ses.model

Class Destination

java.lang.Object

software.amazon.awssdk.services.ses.model.Destination

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Destination.Builder,Destination>

@Generated(value="software.amazon.awssdk:codegen")
public final class Destination
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Destination.Builder,Destination>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Destination.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	bccAddresses() The recipients to place on the BCC: line of the message.
static Destination.Builder	builder()
List<String>	ccAddresses() The recipients to place on the CC: line of the message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBccAddresses() For responses, this returns true if the service returned a value for the BccAddresses property.
boolean	hasCcAddresses() For responses, this returns true if the service returned a value for the CcAddresses property.
int	hashCode()
boolean	hasToAddresses() For responses, this returns true if the service returned a value for the ToAddresses property.
List<SdkField<?>>	sdkFields()
static Class<? extends Destination.Builder>	serializableBuilderClass()
List<String>	toAddresses() The recipients to place on the To: line of the message.
Destination.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasToAddresses

public final boolean hasToAddresses()

For responses, this returns true if the service returned a value for the ToAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

toAddresses

public final List<String> toAddresses()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasToAddresses() method.

Returns:

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

hasCcAddresses

public final boolean hasCcAddresses()

For responses, this returns true if the service returned a value for the CcAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ccAddresses

public final List<String> ccAddresses()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCcAddresses() method.

Returns:

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

hasBccAddresses

public final boolean hasBccAddresses()

For responses, this returns true if the service returned a value for the BccAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

bccAddresses

public final List<String> bccAddresses()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBccAddresses() method.

Returns:

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

toBuilder

public Destination.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Destination.Builder,Destination>

builder

public static Destination.Builder builder()

serializableBuilderClass

public static Class<? extends Destination.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo