Class Destination
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Destination.Builder,
Destination>
An object that describes the recipients for an email.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionAn array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.static Destination.Builder
builder()
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the BccAddresses property.final boolean
For responses, this returns true if the service returned a value for the CcAddresses property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ToAddresses property.static Class
<? extends Destination.Builder> An array that contains the email addresses of the "To" recipients for the email.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
An array that contains the email addresses of the "To" recipients for the email.
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:
- An array that contains the email addresses of the "To" recipients for the email.
-
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 theisEmpty()
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
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
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:
- An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
-
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 theisEmpty()
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
An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
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:
- An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Destination.Builder,
Destination> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-