@Generated(value="software.amazon.awssdk:codegen") public class SendBulkTemplatedEmailRequest extends SESRequest implements ToCopyableBuilder<SendBulkTemplatedEmailRequest.Builder,SendBulkTemplatedEmailRequest>
Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
Modifier and Type | Class and Description |
---|---|
static interface |
SendBulkTemplatedEmailRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SendBulkTemplatedEmailRequest.Builder |
builder() |
String |
configurationSetName()
The name of the configuration set to use when you send an email using
SendBulkTemplatedEmail . |
List<MessageTag> |
defaultTags()
A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using
SendBulkTemplatedEmail . |
String |
defaultTemplateData()
A list of replacement values to apply to the template when replacement data is not specified in a Destination
object.
|
List<BulkEmailDestination> |
destinations()
One or more
Destination objects. |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<String> |
replyToAddresses()
The reply-to email address(es) for the message.
|
String |
returnPath()
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
|
String |
returnPathArn()
This parameter is used only for sending authorization.
|
static Class<? extends SendBulkTemplatedEmailRequest.Builder> |
serializableBuilderClass() |
String |
source()
The email address that is sending the email.
|
String |
sourceArn()
This parameter is used only for sending authorization.
|
String |
template()
The template to use when sending this email.
|
String |
templateArn()
The ARN of the template to use when sending this email.
|
SendBulkTemplatedEmailRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String source()
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy,
then you must also specify the SourceArn
parameter. For more information about sending
authorization, see the Amazon SES Developer
Guide.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following
form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization
policy, then you must also specify the SourceArn
parameter. For more information about
sending authorization, see the Amazon SES
Developer Guide.
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then
you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax
uses the following form: =?charset?encoding?encoded-text?=
. For more information, see RFC 2047.
public String sourceArn()
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the
sending authorization policy that permits you to send for the email address specified in the Source
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you
to send from user@example.com
, then you would specify the SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be
user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
Source
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that
authorizes you to send from user@example.com
, then you would specify the
SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
public List<String> replyToAddresses()
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String returnPath()
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP;
this message will then be forwarded to the email address specified by the ReturnPath
parameter. The
ReturnPath
parameter is never overwritten. This email address must be either individually verified
with Amazon SES, or from a domain that has been verified with Amazon SES.
ReturnPath
parameter. The ReturnPath
parameter is never overwritten. This email
address must be either individually verified with Amazon SES, or from a domain that has been verified
with Amazon SES.public String returnPathArn()
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the
sending authorization policy that permits you to use the email address specified in the ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you
to use feedback@example.com
, then you would specify the ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be
feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that
authorizes you to use feedback@example.com
, then you would specify the
ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
,
and the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
public String configurationSetName()
The name of the configuration set to use when you send an email using SendBulkTemplatedEmail
.
SendBulkTemplatedEmail
.public List<MessageTag> defaultTags()
A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using
SendBulkTemplatedEmail
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
SendBulkTemplatedEmail
.public String template()
The template to use when sending this email.
public String templateArn()
The ARN of the template to use when sending this email.
public String defaultTemplateData()
A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.
The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
public List<BulkEmailDestination> destinations()
One or more Destination
objects. All of the recipients in a Destination
will receive
the same version of the email. You can specify up to 50 Destination
objects within a
Destinations
array.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Destination
objects. All of the recipients in a Destination
will
receive the same version of the email. You can specify up to 50 Destination
objects within a
Destinations
array.public SendBulkTemplatedEmailRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SendBulkTemplatedEmailRequest.Builder,SendBulkTemplatedEmailRequest>
toBuilder
in class SESRequest
public static SendBulkTemplatedEmailRequest.Builder builder()
public static Class<? extends SendBulkTemplatedEmailRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.