Struct aws_sdk_ses::input::SendTemplatedEmailInput [−][src]
#[non_exhaustive]pub struct SendTemplatedEmailInput {
pub source: Option<String>,
pub destination: Option<Destination>,
pub reply_to_addresses: Option<Vec<String>>,
pub return_path: Option<String>,
pub source_arn: Option<String>,
pub return_path_arn: Option<String>,
pub tags: Option<Vec<MessageTag>>,
pub configuration_set_name: Option<String>,
pub template: Option<String>,
pub template_arn: Option<String>,
pub template_data: Option<String>,
}
Expand description
Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.source: 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 local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=
.
destination: 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.
reply_to_addresses: Option<Vec<String>>
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
return_path: Option<String>
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be 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.
source_arn: 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.
return_path_arn: 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.
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.
configuration_set_name: Option<String>
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
template: Option<String>
The template to use when sending this email.
template_arn: Option<String>
The ARN of the template to use when sending this email.
template_data: 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.
Implementations
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<SendTemplatedEmail, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<SendTemplatedEmail, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<SendTemplatedEmail
>
Creates a new builder-style object to manufacture SendTemplatedEmailInput
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 local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=
.
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be 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.
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.
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.
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.
The name of the configuration set to use when you send an email using SendTemplatedEmail
.
The ARN of the template to use when sending this email.
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
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for SendTemplatedEmailInput
impl Send for SendTemplatedEmailInput
impl Sync for SendTemplatedEmailInput
impl Unpin for SendTemplatedEmailInput
impl UnwindSafe for SendTemplatedEmailInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more