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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass EmailTemplateRequest data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_substitutionsString

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)


6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6317

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

#html_partString

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)


6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6317

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

#recommender_idString

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)


6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6317

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

#subjectString

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

Returns:

  • (String)


6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6317

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

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


6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6317

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

#template_descriptionString

A custom description of the message template.

Returns:

  • (String)


6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6317

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

#text_partString

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)


6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6317

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