You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::EmailTemplateRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EmailTemplateRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  default_substitutions: "__string",
  html_part: "__string",
  recommender_id: "__string",
  subject: "__string",
  tags: {
    "__string" => "__string",
  },
  template_description: "__string",
  text_part: "__string",
}

Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#default_substitutions ⇒ String

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:

  • (String) —

    A JSON object that specifies the default values to use for message variables in the message template.

#html_part ⇒ String

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:

  • (String) —

    The message body, in HTML format, to use in email messages that are based on the message template.

#recommender_id ⇒ String

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:

  • (String) —

    The unique identifier for the recommender model to use for the message template.

#subject ⇒ String

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

Returns:

  • (String) —

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

#tags ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    A string-to-string map of key-value pairs that defines the tags to associate with the message template.

#template_description ⇒ String

A custom description of the message template.

Returns:

  • (String) —

    A custom description of the message template.

#text_part ⇒ String

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:

  • (String) —

    The message body, in plain text format, to use in email messages that are based on the message template.