Struct EmailTemplateRequest 

#[non_exhaustive]
pub struct EmailTemplateRequest {
    pub default_substitutions: Option<String>,
    pub html_part: Option<String>,
    pub recommender_id: Option<String>,
    pub subject: Option<String>,
    pub headers: Option<Vec<MessageHeader>>,
    pub tags: Option<HashMap<String, String>>,
    pub template_description: Option<String>,
    pub text_part: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

default_substitutions: Option<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.

html_part: Option<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.

recommender_id: Option<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.

subject: Option<String>

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

headers: Option<Vec<MessageHeader>>

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

tags: Option<HashMap<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.

template_description: Option<String>

A custom description of the message template.

text_part: Option<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.

Implementations

impl EmailTemplateRequest

pub fn default_substitutions(&self) -> Option<&str>

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.

pub fn html_part(&self) -> Option<&str>

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.

pub fn recommender_id(&self) -> Option<&str>

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.

pub fn subject(&self) -> Option<&str>

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

pub fn headers(&self) -> &[MessageHeader]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .headers.is_none().

pub fn tags(&self) -> Option<&HashMap<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.

pub fn template_description(&self) -> Option<&str>

A custom description of the message template.

pub fn text_part(&self) -> Option<&str>

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.

impl EmailTemplateRequest

pub fn builder() -> EmailTemplateRequestBuilder

Creates a new builder-style object to manufacture EmailTemplateRequest.

Trait Implementations

impl Clone for EmailTemplateRequest

fn clone(&self) -> EmailTemplateRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EmailTemplateRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for EmailTemplateRequest

fn eq(&self, other: &EmailTemplateRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EmailTemplateRequest