#[non_exhaustive]pub struct EmailTemplateRequestBuilder { /* private fields */ }Expand description
A builder for EmailTemplateRequest.
Implementations§
Source§impl EmailTemplateRequestBuilder
impl EmailTemplateRequestBuilder
Sourcepub fn default_substitutions(self, input: impl Into<String>) -> Self
pub fn default_substitutions(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_default_substitutions(self, input: Option<String>) -> Self
pub fn set_default_substitutions(self, input: Option<String>) -> Self
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.
Sourcepub fn get_default_substitutions(&self) -> &Option<String>
pub fn get_default_substitutions(&self) -> &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.
Sourcepub fn html_part(self, input: impl Into<String>) -> Self
pub fn html_part(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_html_part(self, input: Option<String>) -> Self
pub fn set_html_part(self, input: Option<String>) -> Self
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.
Sourcepub fn get_html_part(&self) -> &Option<String>
pub fn get_html_part(&self) -> &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.
Sourcepub fn recommender_id(self, input: impl Into<String>) -> Self
pub fn recommender_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_recommender_id(self, input: Option<String>) -> Self
pub fn set_recommender_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_recommender_id(&self) -> &Option<String>
pub fn get_recommender_id(&self) -> &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.
Sourcepub fn subject(self, input: impl Into<String>) -> Self
pub fn subject(self, input: impl Into<String>) -> Self
The subject line, or title, to use in email messages that are based on the message template.
Sourcepub fn set_subject(self, input: Option<String>) -> Self
pub fn set_subject(self, input: Option<String>) -> Self
The subject line, or title, to use in email messages that are based on the message template.
Sourcepub fn get_subject(&self) -> &Option<String>
pub fn get_subject(&self) -> &Option<String>
The subject line, or title, to use in email messages that are based on the message template.
Sourcepub fn headers(self, input: MessageHeader) -> Self
pub fn headers(self, input: MessageHeader) -> Self
Appends an item to headers.
To override the contents of this collection use set_headers.
The list of MessageHeaders for the email. You can have up to 15 Headers.
Sourcepub fn set_headers(self, input: Option<Vec<MessageHeader>>) -> Self
pub fn set_headers(self, input: Option<Vec<MessageHeader>>) -> Self
The list of MessageHeaders for the email. You can have up to 15 Headers.
Sourcepub fn get_headers(&self) -> &Option<Vec<MessageHeader>>
pub fn get_headers(&self) -> &Option<Vec<MessageHeader>>
The list of MessageHeaders for the email. You can have up to 15 Headers.
Adds a key-value pair to tags.
To override the contents of this collection use set_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.
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.
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.
Sourcepub fn template_description(self, input: impl Into<String>) -> Self
pub fn template_description(self, input: impl Into<String>) -> Self
A custom description of the message template.
Sourcepub fn set_template_description(self, input: Option<String>) -> Self
pub fn set_template_description(self, input: Option<String>) -> Self
A custom description of the message template.
Sourcepub fn get_template_description(&self) -> &Option<String>
pub fn get_template_description(&self) -> &Option<String>
A custom description of the message template.
Sourcepub fn text_part(self, input: impl Into<String>) -> Self
pub fn text_part(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_text_part(self, input: Option<String>) -> Self
pub fn set_text_part(self, input: Option<String>) -> Self
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.
Sourcepub fn get_text_part(&self) -> &Option<String>
pub fn get_text_part(&self) -> &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.
Sourcepub fn build(self) -> EmailTemplateRequest
pub fn build(self) -> EmailTemplateRequest
Consumes the builder and constructs a EmailTemplateRequest.
Trait Implementations§
Source§impl Clone for EmailTemplateRequestBuilder
impl Clone for EmailTemplateRequestBuilder
Source§fn clone(&self) -> EmailTemplateRequestBuilder
fn clone(&self) -> EmailTemplateRequestBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for EmailTemplateRequestBuilder
impl Debug for EmailTemplateRequestBuilder
Source§impl Default for EmailTemplateRequestBuilder
impl Default for EmailTemplateRequestBuilder
Source§fn default() -> EmailTemplateRequestBuilder
fn default() -> EmailTemplateRequestBuilder
impl StructuralPartialEq for EmailTemplateRequestBuilder
Auto Trait Implementations§
impl Freeze for EmailTemplateRequestBuilder
impl RefUnwindSafe for EmailTemplateRequestBuilder
impl Send for EmailTemplateRequestBuilder
impl Sync for EmailTemplateRequestBuilder
impl Unpin for EmailTemplateRequestBuilder
impl UnwindSafe for EmailTemplateRequestBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);