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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EmailTemplateRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_substitutions ⇒ 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.

• #recommender_id ⇒ 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.

• #tags ⇒ Hash<String,String>

  <note markdown=“1”>As of 22-05-2023 tags has been deprecated for update operations.

• #template_description ⇒ 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.

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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4436

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :tags,
  :template_description,
  :text_part)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4436

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :tags,
  :template_description,
  :text_part)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4436

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :tags,
  :template_description,
  :text_part)
  SENSITIVE = []
  include Aws::Structure
end

#subject ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4436

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :tags,
  :template_description,
  :text_part)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

<note markdown=“1”>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][2

commands in the *AWS Command Line

Interface Documentation* or [resourcegroupstaggingapi] in the *AWS SDK*.

</note>

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

[1]: docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html [2]: docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html [3]: sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4436

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :tags,
  :template_description,
  :text_part)
  SENSITIVE = []
  include Aws::Structure
end

#template_description ⇒ String

A custom description of the message template.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4436

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :tags,
  :template_description,
  :text_part)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4436

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :tags,
  :template_description,
  :text_part)
  SENSITIVE = []
  include Aws::Structure
end