/AWS1/CL_PPTEMAILTMPLRESPONSE¶
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_creationdate TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The date, in ISO 8601 format, when the message template was created.
iv_lastmodifieddate TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The date, in ISO 8601 format, when the message template was last modified.
iv_templatename TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The name of the message template.
iv_templatetype TYPE /AWS1/PPTTEMPLATETYPE /AWS1/PPTTEMPLATETYPE¶
The type of channel that the message template is designed for. For an email template, this value is EMAIL.
Optional arguments:¶
iv_arn TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The Amazon Resource Name (ARN) of the message template.
iv_defaultsubstitutions TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The JSON object that specifies the default values that are used 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.
iv_htmlpart TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The message body, in HTML format, that's used in email messages that are based on the message template.
iv_recommenderid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The unique identifier for the recommender model that's used by the message template.
iv_subject TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The subject line, or title, that's used 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¶
A string-to-string map of key-value pairs that identifies the tags that are associated 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¶
The custom description of the message template.
iv_textpart TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The message body, in plain text format, that's used in email messages that are based on the message template.
iv_version TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
Queryable Attributes¶
Arn¶
The Amazon Resource Name (ARN) of the message template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
CreationDate¶
The date, in ISO 8601 format, when the message template was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
DefaultSubstitutions¶
The JSON object that specifies the default values that are used 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.
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, that's used in email messages that are based on the message template.
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 |
LastModifiedDate¶
The date, in ISO 8601 format, when the message template was last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
RecommenderId¶
The unique identifier for the recommender model that's used by the message template.
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, that's used 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¶
A string-to-string map of key-value pairs that identifies the tags that are associated 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¶
The 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 |
TemplateName¶
The name of the message template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATENAME() |
Getter for TEMPLATENAME, with configurable default |
ASK_TEMPLATENAME() |
Getter for TEMPLATENAME w/ exceptions if field has no value |
HAS_TEMPLATENAME() |
Determine if TEMPLATENAME has a value |
TemplateType¶
The type of channel that the message template is designed for. For an email template, this value is EMAIL.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATETYPE() |
Getter for TEMPLATETYPE, with configurable default |
ASK_TEMPLATETYPE() |
Getter for TEMPLATETYPE w/ exceptions if field has no value |
HAS_TEMPLATETYPE() |
Determine if TEMPLATETYPE has a value |
TextPart¶
The message body, in plain text format, that's used in email messages that are based on the message template.
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 |
Version¶
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION, with configurable default |
ASK_VERSION() |
Getter for VERSION w/ exceptions if field has no value |
HAS_VERSION() |
Determine if VERSION has a value |