public static interface SendBulkTemplatedEmailRequest.Builder extends SesRequest.Builder, CopyableBuilder<SendBulkTemplatedEmailRequest.Builder,SendBulkTemplatedEmailRequest>
Modifier and Type | Method and Description |
---|---|
SendBulkTemplatedEmailRequest.Builder |
configurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using
SendBulkTemplatedEmail . |
SendBulkTemplatedEmailRequest.Builder |
defaultTags(Collection<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 . |
SendBulkTemplatedEmailRequest.Builder |
defaultTags(Consumer<MessageTag.Builder>... 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 . |
SendBulkTemplatedEmailRequest.Builder |
defaultTags(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 . |
SendBulkTemplatedEmailRequest.Builder |
defaultTemplateData(String defaultTemplateData)
A list of replacement values to apply to the template when replacement data is not specified in a Destination
object.
|
SendBulkTemplatedEmailRequest.Builder |
destinations(BulkEmailDestination... destinations)
One or more
Destination objects. |
SendBulkTemplatedEmailRequest.Builder |
destinations(Collection<BulkEmailDestination> destinations)
One or more
Destination objects. |
SendBulkTemplatedEmailRequest.Builder |
destinations(Consumer<BulkEmailDestination.Builder>... destinations)
One or more
Destination objects. |
SendBulkTemplatedEmailRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
SendBulkTemplatedEmailRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
SendBulkTemplatedEmailRequest.Builder |
replyToAddresses(Collection<String> replyToAddresses)
The reply-to email address(es) for the message.
|
SendBulkTemplatedEmailRequest.Builder |
replyToAddresses(String... replyToAddresses)
The reply-to email address(es) for the message.
|
SendBulkTemplatedEmailRequest.Builder |
returnPath(String returnPath)
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
|
SendBulkTemplatedEmailRequest.Builder |
returnPathArn(String returnPathArn)
This parameter is used only for sending authorization.
|
SendBulkTemplatedEmailRequest.Builder |
source(String source)
The email address that is sending the email.
|
SendBulkTemplatedEmailRequest.Builder |
sourceArn(String sourceArn)
This parameter is used only for sending authorization.
|
SendBulkTemplatedEmailRequest.Builder |
template(String template)
The template to use when sending this email.
|
SendBulkTemplatedEmailRequest.Builder |
templateArn(String templateArn)
The ARN of the template to use when sending this email.
|
build
overrideConfiguration
copy
applyMutation, build
SendBulkTemplatedEmailRequest.Builder source(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.
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.
SendBulkTemplatedEmailRequest.Builder sourceArn(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.
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.
SendBulkTemplatedEmailRequest.Builder replyToAddresses(Collection<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.
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.SendBulkTemplatedEmailRequest.Builder replyToAddresses(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.
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.SendBulkTemplatedEmailRequest.Builder returnPath(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
- 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.SendBulkTemplatedEmailRequest.Builder returnPathArn(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.
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.
SendBulkTemplatedEmailRequest.Builder configurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using SendBulkTemplatedEmail
.
configurationSetName
- The name of the configuration set to use when you send an email using
SendBulkTemplatedEmail
.SendBulkTemplatedEmailRequest.Builder defaultTags(Collection<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
.
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
.SendBulkTemplatedEmailRequest.Builder defaultTags(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
.
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
.SendBulkTemplatedEmailRequest.Builder defaultTags(Consumer<MessageTag.Builder>... 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
.
List.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #defaultTags(List)
.defaultTags
- a consumer that will call methods on List.Builder
#defaultTags(List)
SendBulkTemplatedEmailRequest.Builder template(String template)
The template to use when sending this email.
template
- The template to use when sending this email.SendBulkTemplatedEmailRequest.Builder templateArn(String templateArn)
The ARN of the template to use when sending this email.
templateArn
- The ARN of the template to use when sending this email.SendBulkTemplatedEmailRequest.Builder defaultTemplateData(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.
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.
SendBulkTemplatedEmailRequest.Builder destinations(Collection<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.
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.SendBulkTemplatedEmailRequest.Builder destinations(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.
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.SendBulkTemplatedEmailRequest.Builder destinations(Consumer<BulkEmailDestination.Builder>... 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.
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #destinations(List)
.destinations
- a consumer that will call methods on List.Builder
#destinations(List)
SendBulkTemplatedEmailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.SendBulkTemplatedEmailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.