Struct aws_sdk_ses::operation::send_templated_email::builders::SendTemplatedEmailFluentBuilder
source · pub struct SendTemplatedEmailFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SendTemplatedEmail
.
Composes an email message using an email template and immediately queues it for sending.
To send email using this operation, your call must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using the
CreateTemplate
operation. -
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
-
The maximum message size is 10 MB.
-
Calls to the
SendTemplatedEmail
operation may only include oneDestination
parameter. A destination is a set of recipients that receives the same version of the email. TheDestination
parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. -
The
Destination
parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
If your call to the SendTemplatedEmail
operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
Implementations§
source§impl SendTemplatedEmailFluentBuilder
impl SendTemplatedEmailFluentBuilder
sourcepub fn as_input(&self) -> &SendTemplatedEmailInputBuilder
pub fn as_input(&self) -> &SendTemplatedEmailInputBuilder
Access the SendTemplatedEmail as a reference.
sourcepub async fn send(
self
) -> Result<SendTemplatedEmailOutput, SdkError<SendTemplatedEmailError, HttpResponse>>
pub async fn send( self ) -> Result<SendTemplatedEmailOutput, SdkError<SendTemplatedEmailError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<SendTemplatedEmailOutput, SendTemplatedEmailError, Self>
pub fn customize( self ) -> CustomizableOperation<SendTemplatedEmailOutput, SendTemplatedEmailError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn source(self, input: impl Into<String>) -> Self
pub fn source(self, input: impl Into<String>) -> Self
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn
parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. for this reason, The email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
sourcepub fn set_source(self, input: Option<String>) -> Self
pub fn set_source(self, input: Option<String>) -> Self
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn
parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. for this reason, The email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
sourcepub fn get_source(&self) -> &Option<String>
pub fn get_source(&self) -> &Option<String>
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn
parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. for this reason, The email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
sourcepub fn destination(self, input: Destination) -> Self
pub fn destination(self, input: Destination) -> Self
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
sourcepub fn set_destination(self, input: Option<Destination>) -> Self
pub fn set_destination(self, input: Option<Destination>) -> Self
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
sourcepub fn get_destination(&self) -> &Option<Destination>
pub fn get_destination(&self) -> &Option<Destination>
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
sourcepub fn reply_to_addresses(self, input: impl Into<String>) -> Self
pub fn reply_to_addresses(self, input: impl Into<String>) -> Self
Appends an item to ReplyToAddresses
.
To override the contents of this collection use set_reply_to_addresses
.
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
sourcepub fn set_reply_to_addresses(self, input: Option<Vec<String>>) -> Self
pub fn set_reply_to_addresses(self, input: Option<Vec<String>>) -> Self
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
sourcepub fn get_reply_to_addresses(&self) -> &Option<Vec<String>>
pub fn get_reply_to_addresses(&self) -> &Option<Vec<String>>
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
sourcepub fn return_path(self, input: impl Into<String>) -> Self
pub fn return_path(self, input: impl Into<String>) -> Self
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath
parameter. The ReturnPath
parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
sourcepub fn set_return_path(self, input: Option<String>) -> Self
pub fn set_return_path(self, input: Option<String>) -> Self
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath
parameter. The ReturnPath
parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
sourcepub fn get_return_path(&self) -> &Option<String>
pub fn get_return_path(&self) -> &Option<String>
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath
parameter. The ReturnPath
parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
sourcepub fn source_arn(self, input: impl Into<String>) -> Self
pub fn source_arn(self, input: impl Into<String>) -> Self
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send from user@example.com
, then you would specify the SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
sourcepub fn set_source_arn(self, input: Option<String>) -> Self
pub fn set_source_arn(self, input: Option<String>) -> Self
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send from user@example.com
, then you would specify the SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
sourcepub fn get_source_arn(&self) -> &Option<String>
pub fn get_source_arn(&self) -> &Option<String>
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send from user@example.com
, then you would specify the SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
sourcepub fn return_path_arn(self, input: impl Into<String>) -> Self
pub fn return_path_arn(self, input: impl Into<String>) -> Self
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to use feedback@example.com
, then you would specify the ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
sourcepub fn set_return_path_arn(self, input: Option<String>) -> Self
pub fn set_return_path_arn(self, input: Option<String>) -> Self
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to use feedback@example.com
, then you would specify the ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
sourcepub fn get_return_path_arn(&self) -> &Option<String>
pub fn get_return_path_arn(&self) -> &Option<String>
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to use feedback@example.com
, then you would specify the ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
sourcepub fn configuration_set_name(self, input: impl Into<String>) -> Self
pub fn configuration_set_name(self, input: impl Into<String>) -> Self
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
sourcepub fn set_configuration_set_name(self, input: Option<String>) -> Self
pub fn set_configuration_set_name(self, input: Option<String>) -> Self
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
sourcepub fn get_configuration_set_name(&self) -> &Option<String>
pub fn get_configuration_set_name(&self) -> &Option<String>
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
sourcepub fn template(self, input: impl Into<String>) -> Self
pub fn template(self, input: impl Into<String>) -> Self
The template to use when sending this email.
sourcepub fn set_template(self, input: Option<String>) -> Self
pub fn set_template(self, input: Option<String>) -> Self
The template to use when sending this email.
sourcepub fn get_template(&self) -> &Option<String>
pub fn get_template(&self) -> &Option<String>
The template to use when sending this email.
sourcepub fn template_arn(self, input: impl Into<String>) -> Self
pub fn template_arn(self, input: impl Into<String>) -> Self
The ARN of the template to use when sending this email.
sourcepub fn set_template_arn(self, input: Option<String>) -> Self
pub fn set_template_arn(self, input: Option<String>) -> Self
The ARN of the template to use when sending this email.
sourcepub fn get_template_arn(&self) -> &Option<String>
pub fn get_template_arn(&self) -> &Option<String>
The ARN of the template to use when sending this email.
sourcepub fn template_data(self, input: impl Into<String>) -> Self
pub fn template_data(self, input: impl Into<String>) -> Self
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
sourcepub fn set_template_data(self, input: Option<String>) -> Self
pub fn set_template_data(self, input: Option<String>) -> Self
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
sourcepub fn get_template_data(&self) -> &Option<String>
pub fn get_template_data(&self) -> &Option<String>
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
Trait Implementations§
source§impl Clone for SendTemplatedEmailFluentBuilder
impl Clone for SendTemplatedEmailFluentBuilder
source§fn clone(&self) -> SendTemplatedEmailFluentBuilder
fn clone(&self) -> SendTemplatedEmailFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for SendTemplatedEmailFluentBuilder
impl !RefUnwindSafe for SendTemplatedEmailFluentBuilder
impl Send for SendTemplatedEmailFluentBuilder
impl Sync for SendTemplatedEmailFluentBuilder
impl Unpin for SendTemplatedEmailFluentBuilder
impl !UnwindSafe for SendTemplatedEmailFluentBuilder
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> 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 more