Interface EmailTemplateRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EmailTemplateRequest.Builder,EmailTemplateRequest>, SdkBuilder<EmailTemplateRequest.Builder,EmailTemplateRequest>, SdkPojo
Enclosing class:
EmailTemplateRequest
@Mutable @NotThreadSafe public static interface EmailTemplateRequest.Builder extends SdkPojo, CopyableBuilder<EmailTemplateRequest.Builder,EmailTemplateRequest>

  • Method Details

    • defaultSubstitutions

      EmailTemplateRequest.Builder defaultSubstitutions(String defaultSubstitutions)

      A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

      Parameters:
      defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • htmlPart

      EmailTemplateRequest.Builder htmlPart(String htmlPart)

      The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

      Parameters:
      htmlPart - The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recommenderId

      EmailTemplateRequest.Builder recommenderId(String recommenderId)

      The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

      Parameters:
      recommenderId - The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subject

      EmailTemplateRequest.Builder subject(String subject)

      The subject line, or title, to use in email messages that are based on the message template.

      Parameters:
      subject - The subject line, or title, to use in email messages that are based on the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      EmailTemplateRequest.Builder headers(Collection<MessageHeader> headers)

      The list of MessageHeaders for the email. You can have up to 15 Headers.

      Parameters:
      headers - The list of MessageHeaders for the email. You can have up to 15 Headers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      EmailTemplateRequest.Builder headers(MessageHeader... headers)

      The list of MessageHeaders for the email. You can have up to 15 Headers.

      Parameters:
      headers - The list of MessageHeaders for the email. You can have up to 15 Headers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

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

      The list of MessageHeaders for the email. You can have up to 15 Headers.

      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<MessageHeader>).

      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:

    • tags

      EmailTemplateRequest.Builder tags(Map<String,String> tags)

      As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

      (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

      Parameters:
      tags - As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

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

    • templateDescription

      EmailTemplateRequest.Builder templateDescription(String templateDescription)

      A custom description of the message template.

      Parameters:
      templateDescription - A custom description of the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • textPart

      EmailTemplateRequest.Builder textPart(String textPart)

      The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

      Parameters:
      textPart - The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
      Returns:
      Returns a reference to this object so that method calls can be chained together.