Package software.amazon.awssdk.services.sesv2.model

Interface Template.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Template.Builder,Template>, SdkBuilder<Template.Builder,Template>, SdkPojo

Enclosing class:

Template

public static interface Template.Builder
extends SdkPojo, CopyableBuilder<Template.Builder,Template>

Method Summary

Modifier and Type	Method	Description
Template.Builder	headers(Collection<MessageHeader> headers)	The list of message headers that will be added to the email message.
Template.Builder	headers(Consumer<MessageHeader.Builder>... headers)	The list of message headers that will be added to the email message.
Template.Builder	headers(MessageHeader... headers)	The list of message headers that will be added to the email message.
Template.Builder	templateArn(String templateArn)	The Amazon Resource Name (ARN) of the template.
default Template.Builder	templateContent(Consumer<EmailTemplateContent.Builder> templateContent)	The content of the template.
Template.Builder	templateContent(EmailTemplateContent templateContent)	The content of the template.
Template.Builder	templateData(String templateData)	An object that defines the values to use for message variables in the template.
Template.Builder	templateName(String templateName)	The name of the template.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

templateName

Template.Builder templateName(String templateName)

The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

Parameters:

templateName - The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

Returns:

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

templateArn

Template.Builder templateArn(String templateArn)

The Amazon Resource Name (ARN) of the template.

Parameters:

templateArn - The Amazon Resource Name (ARN) of the template.

Returns:

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

templateContent

Template.Builder templateContent(EmailTemplateContent templateContent)

The content of the template.

Amazon SES supports only simple substitions when you send email using the SendEmail or SendBulkEmail operations and you provide the full template content in the request.

Parameters:

templateContent - The content of the template.

Amazon SES supports only simple substitions when you send email using the SendEmail or SendBulkEmail operations and you provide the full template content in the request.

Returns:

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

templateContent

default Template.Builder templateContent(Consumer<EmailTemplateContent.Builder> templateContent)

The content of the template.

Amazon SES supports only simple substitions when you send email using the SendEmail or SendBulkEmail operations and you provide the full template content in the request.

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

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

Parameters:

templateContent - a consumer that will call methods on EmailTemplateContent.Builder

Returns:

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

See Also:

templateContent(EmailTemplateContent)

templateData

Template.Builder templateData(String templateData)

An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

Parameters:

templateData - An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

Returns:

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

headers

Template.Builder headers(Collection<MessageHeader> headers)

The list of message headers that will be added to the email message.

Parameters:

headers - The list of message headers that will be added to the email message.

Returns:

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

headers

Template.Builder headers(MessageHeader... headers)

The list of message headers that will be added to the email message.

Parameters:

headers - The list of message headers that will be added to the email message.

Returns:

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

headers

Template.Builder headers(Consumer<MessageHeader.Builder>... headers)

The list of message headers that will be added to the email message.

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

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

Parameters:

headers - a consumer that will call methods on MessageHeader.Builder

Returns:

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

See Also:

#headers(java.util.Collection)