/AWS1/CL_PPTEMAILTMPLREQUEST¶
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_defaultsubstitutions TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
iv_htmlpart TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
iv_recommenderid TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
iv_subject TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The subject line, or title, to use in email messages that are based on the message template.
it_headers TYPE /AWS1/CL_PPTMESSAGEHEADER=>TT_LISTOFMESSAGEHEADER TT_LISTOFMESSAGEHEADER¶
The list of MessageHeaders for the email. You can have up to 15 Headers.
it_tags TYPE /AWS1/CL_PPTMAPOF__STRING_W=>TT_MAPOF__STRING TT_MAPOF__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.
iv_templatedescription TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
A custom description of the message template.
iv_textpart TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
Queryable Attributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTSUBSTITUTIONS() |
Getter for DEFAULTSUBSTITUTIONS, with configurable default |
ASK_DEFAULTSUBSTITUTIONS() |
Getter for DEFAULTSUBSTITUTIONS w/ exceptions if field has n |
HAS_DEFAULTSUBSTITUTIONS() |
Determine if DEFAULTSUBSTITUTIONS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HTMLPART() |
Getter for HTMLPART, with configurable default |
ASK_HTMLPART() |
Getter for HTMLPART w/ exceptions if field has no value |
HAS_HTMLPART() |
Determine if HTMLPART has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RECOMMENDERID() |
Getter for RECOMMENDERID, with configurable default |
ASK_RECOMMENDERID() |
Getter for RECOMMENDERID w/ exceptions if field has no value |
HAS_RECOMMENDERID() |
Determine if RECOMMENDERID has a value |
Subject¶
The subject line, or title, to use in email messages that are based on the message template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBJECT() |
Getter for SUBJECT, with configurable default |
ASK_SUBJECT() |
Getter for SUBJECT w/ exceptions if field has no value |
HAS_SUBJECT() |
Determine if SUBJECT has a value |
Headers¶
The list of MessageHeaders for the email. You can have up to 15 Headers.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEADERS() |
Getter for HEADERS, with configurable default |
ASK_HEADERS() |
Getter for HEADERS w/ exceptions if field has no value |
HAS_HEADERS() |
Determine if HEADERS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
TemplateDescription¶
A custom description of the message template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATEDESCRIPTION() |
Getter for TEMPLATEDESCRIPTION, with configurable default |
ASK_TEMPLATEDESCRIPTION() |
Getter for TEMPLATEDESCRIPTION w/ exceptions if field has no |
HAS_TEMPLATEDESCRIPTION() |
Determine if TEMPLATEDESCRIPTION has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEXTPART() |
Getter for TEXTPART, with configurable default |
ASK_TEXTPART() |
Getter for TEXTPART w/ exceptions if field has no value |
HAS_TEXTPART() |
Determine if TEXTPART has a value |