Class BulkEmailEntry
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BulkEmailEntry.Builder,
BulkEmailEntry>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BulkEmailEntry.Builder
builder()
final Destination
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReplacementHeaders property.final boolean
For responses, this returns true if the service returned a value for the ReplacementTags property.final ReplacementEmailContent
TheReplacementEmailContent
associated with aBulkEmailEntry
.final List
<MessageHeader> The list of message headers associated with theBulkEmailEntry
data type.final List
<MessageTag> A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendBulkTemplatedEmail
operation.static Class
<? extends BulkEmailEntry.Builder> 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
-
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 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.
- Returns:
- 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 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.
-
hasReplacementTags
public final boolean hasReplacementTags()For responses, this returns true if the service returned a value for the ReplacementTags 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. -
replacementTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendBulkTemplatedEmail
operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.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
hasReplacementTags()
method.- Returns:
- A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendBulkTemplatedEmail
operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
-
replacementEmailContent
The
ReplacementEmailContent
associated with aBulkEmailEntry
.- Returns:
- The
ReplacementEmailContent
associated with aBulkEmailEntry
.
-
hasReplacementHeaders
public final boolean hasReplacementHeaders()For responses, this returns true if the service returned a value for the ReplacementHeaders 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. -
replacementHeaders
The list of message headers associated with the
BulkEmailEntry
data type.-
Headers Not Present in
BulkEmailEntry
: If a header is specified inTemplate
but not inBulkEmailEntry
, the header fromTemplate
will be added to the outgoing email. -
Headers Present in
BulkEmailEntry
: If a header is specified inBulkEmailEntry
, it takes precedence over any header of the same name specified inTemplate
:-
If the header is also defined within
Template
, the value fromBulkEmailEntry
will replace the header's value in the email. -
If the header is not defined within
Template
, it will simply be added to the email as specified inBulkEmailEntry
.
-
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
hasReplacementHeaders()
method.- Returns:
- The list of message headers associated with the
BulkEmailEntry
data type.-
Headers Not Present in
BulkEmailEntry
: If a header is specified inTemplate
but not inBulkEmailEntry
, the header fromTemplate
will be added to the outgoing email. -
Headers Present in
BulkEmailEntry
: If a header is specified inBulkEmailEntry
, it takes precedence over any header of the same name specified inTemplate
:-
If the header is also defined within
Template
, the value fromBulkEmailEntry
will replace the header's value in the email. -
If the header is not defined within
Template
, it will simply be added to the email as specified inBulkEmailEntry
.
-
-
-
-
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<BulkEmailEntry.Builder,
BulkEmailEntry> - 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
-