Interface Template.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Template.Builder,
,Template> SdkBuilder<Template.Builder,
,Template> SdkPojo
- Enclosing class:
Template
-
Method Summary
Modifier and TypeMethodDescriptionattachments
(Collection<Attachment> attachments) The List of attachments to include in your email.attachments
(Consumer<Attachment.Builder>... attachments) The List of attachments to include in your email.attachments
(Attachment... attachments) The List of attachments to include in your email.headers
(Collection<MessageHeader> headers) The list of message headers that will be added to the email message.headers
(Consumer<MessageHeader.Builder>... headers) The list of message headers that will be added to the email message.headers
(MessageHeader... headers) The list of message headers that will be added to the email message.templateArn
(String templateArn) The Amazon Resource Name (ARN) of the template.default Template.Builder
templateContent
(Consumer<EmailTemplateContent.Builder> templateContent) The content of the template.templateContent
(EmailTemplateContent templateContent) The content of the template.templateData
(String templateData) An object that defines the values to use for message variables in the template.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 Details
-
templateName
The name of the template. You will refer to this name when you send email using the
SendEmail
orSendBulkEmail
operations.- Parameters:
templateName
- The name of the template. You will refer to this name when you send email using theSendEmail
orSendBulkEmail
operations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The content of the template.
Amazon SES supports only simple substitions when you send email using the
SendEmail
orSendBulkEmail
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
orSendBulkEmail
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
The content of the template.
Amazon SES supports only simple substitions when you send email using the
SendEmail
orSendBulkEmail
operations and you provide the full template content in the request.EmailTemplateContent.Builder
avoiding the need to create one manually viaEmailTemplateContent.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totemplateContent(EmailTemplateContent)
.- Parameters:
templateContent
- a consumer that will call methods onEmailTemplateContent.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
The list of message headers that will be added to the email message.
This is a convenience method that creates an instance of theMessageHeader.Builder
avoiding the need to create one manually viaMessageHeader.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toheaders(List<MessageHeader>)
.- Parameters:
headers
- a consumer that will call methods onMessageHeader.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
attachments
The List of attachments to include in your email. All recipients will receive the same attachments.
- Parameters:
attachments
- The List of attachments to include in your email. All recipients will receive the same attachments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachments
The List of attachments to include in your email. All recipients will receive the same attachments.
- Parameters:
attachments
- The List of attachments to include in your email. All recipients will receive the same attachments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachments
The List of attachments to include in your email. All recipients will receive the same attachments.
This is a convenience method that creates an instance of theAttachment.Builder
avoiding the need to create one manually viaAttachment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toattachments(List<Attachment>)
.- Parameters:
attachments
- a consumer that will call methods onAttachment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-