software.amazon.awssdk.services.ses.model

Interface SendTemplatedEmailRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SendTemplatedEmailRequest.Builder,SendTemplatedEmailRequest>, SdkBuilder<SendTemplatedEmailRequest.Builder,SendTemplatedEmailRequest>, SdkPojo, SdkRequest.Builder, SesRequest.Builder

Enclosing class:

SendTemplatedEmailRequest

public static interface SendTemplatedEmailRequest.Builder
extends SesRequest.Builder, SdkPojo, CopyableBuilder<SendTemplatedEmailRequest.Builder,SendTemplatedEmailRequest>

Method Summary

Modifier and Type	Method and Description
SendTemplatedEmailRequest.Builder	configurationSetName(String configurationSetName) The name of the configuration set to use when you send an email using SendTemplatedEmail.
default SendTemplatedEmailRequest.Builder	destination(Consumer<Destination.Builder> destination) The destination for this email, composed of To:, CC:, and BCC: fields.
SendTemplatedEmailRequest.Builder	destination(Destination destination) The destination for this email, composed of To:, CC:, and BCC: fields.
SendTemplatedEmailRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SendTemplatedEmailRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SendTemplatedEmailRequest.Builder	replyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the message.
SendTemplatedEmailRequest.Builder	replyToAddresses(String... replyToAddresses) The reply-to email address(es) for the message.
SendTemplatedEmailRequest.Builder	returnPath(String returnPath) The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
SendTemplatedEmailRequest.Builder	returnPathArn(String returnPathArn) This parameter is used only for sending authorization.
SendTemplatedEmailRequest.Builder	source(String source) The email address that is sending the email.
SendTemplatedEmailRequest.Builder	sourceArn(String sourceArn) This parameter is used only for sending authorization.
SendTemplatedEmailRequest.Builder	tags(Collection<MessageTag> tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail.
SendTemplatedEmailRequest.Builder	tags(Consumer<MessageTag.Builder>... tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail.
SendTemplatedEmailRequest.Builder	tags(MessageTag... tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail.
SendTemplatedEmailRequest.Builder	template(String template) The template to use when sending this email.
SendTemplatedEmailRequest.Builder	templateArn(String templateArn) The ARN of the template to use when sending this email.
SendTemplatedEmailRequest.Builder	templateData(String templateData) A list of replacement values to apply to the template.

Methods inherited from interface software.amazon.awssdk.services.ses.model.SesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

source

SendTemplatedEmailRequest.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.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source 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. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Parameters:

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.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source 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. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Returns:

Returns a reference to this object so that method calls can be chained together.

destination

SendTemplatedEmailRequest.Builder destination(Destination destination)

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Parameters:

destination - The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

Returns:

Returns a reference to this object so that method calls can be chained together.

destination

default SendTemplatedEmailRequest.Builder destination(Consumer<Destination.Builder> destination)

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

This is a convenience method that creates an instance of the Destination.Builder avoiding the need to create one manually via Destination.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destination(Destination).

Parameters:

destination - a consumer that will call methods on Destination.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

destination(Destination)

replyToAddresses

SendTemplatedEmailRequest.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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

replyToAddresses

SendTemplatedEmailRequest.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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

returnPath

SendTemplatedEmailRequest.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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceArn

SendTemplatedEmailRequest.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 [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

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 [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

returnPathArn

SendTemplatedEmailRequest.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 [email protected], then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

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 [email protected], then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

SendTemplatedEmailRequest.Builder tags(Collection<MessageTag> tags)

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Parameters:

tags - A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

SendTemplatedEmailRequest.Builder tags(MessageTag... tags)

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Parameters:

tags - A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

SendTemplatedEmailRequest.Builder tags(Consumer<MessageTag.Builder>... tags)

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

This is a convenience method that creates an instance of the MessageTag.Builder avoiding the need to create one manually via MessageTag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on MessageTag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

configurationSetName

SendTemplatedEmailRequest.Builder configurationSetName(String configurationSetName)

The name of the configuration set to use when you send an email using SendTemplatedEmail.

Parameters:

configurationSetName - The name of the configuration set to use when you send an email using SendTemplatedEmail.

Returns:

Returns a reference to this object so that method calls can be chained together.

template

SendTemplatedEmailRequest.Builder template(String template)

The template to use when sending this email.

Parameters:

template - The template to use when sending this email.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateArn

SendTemplatedEmailRequest.Builder templateArn(String templateArn)

The ARN of the template to use when sending this email.

Parameters:

templateArn - The ARN of the template to use when sending this email.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateData

SendTemplatedEmailRequest.Builder templateData(String templateData)

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Parameters:

templateData - A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

SendTemplatedEmailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

SendTemplatedEmailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder