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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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:

Constant Summary collapse

SENSITIVE = 
[]

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) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

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

#headers ⇒ Array<Types::MessageHeader>

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

Returns:



4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :headers,
  :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) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :headers,
  :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) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :headers,
  :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) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

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

#tags ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

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

#template_description ⇒ String

A custom description of the message template.

Returns:

  • (String) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

class EmailTemplateRequest < Struct.new(
  :default_substitutions,
  :html_part,
  :recommender_id,
  :subject,
  :headers,
  :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) 


4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4455

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