Struct aws_sdk_ses::operation::send_bulk_templated_email::builders::SendBulkTemplatedEmailInputBuilder

#[non_exhaustive]
pub struct SendBulkTemplatedEmailInputBuilder { /* private fields */ }

A builder for SendBulkTemplatedEmailInput.

Implementations

impl SendBulkTemplatedEmailInputBuilder

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.

This field is required.

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.

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.

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.

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.

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.

pub fn reply_to_addresses(self, input: impl Into<String>) -> Self

Appends an item to reply_to_addresses.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 SendBulkTemplatedEmail.

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 SendBulkTemplatedEmail.

pub fn get_configuration_set_name(&self) -> &Option<String>

The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.

pub fn default_tags(self, input: MessageTag) -> Self

Appends an item to default_tags.

To override the contents of this collection use set_default_tags.

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

pub fn set_default_tags(self, input: Option<Vec<MessageTag>>) -> Self

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

pub fn get_default_tags(&self) -> &Option<Vec<MessageTag>>

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

pub fn template(self, input: impl Into<String>) -> Self

The template to use when sending this email.

This field is required.

pub fn set_template(self, input: Option<String>) -> Self

The template to use when sending this email.

pub fn get_template(&self) -> &Option<String>

The template to use when sending this email.

pub fn template_arn(self, input: impl Into<String>) -> Self

The ARN of the template to use when sending this email.

pub fn set_template_arn(self, input: Option<String>) -> Self

The ARN of the template to use when sending this email.

pub fn get_template_arn(&self) -> &Option<String>

The ARN of the template to use when sending this email.

pub fn default_template_data(self, input: impl Into<String>) -> Self

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

pub fn set_default_template_data(self, input: Option<String>) -> Self

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

pub fn get_default_template_data(&self) -> &Option<String>

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

pub fn destinations(self, input: BulkEmailDestination) -> Self

Appends an item to destinations.

To override the contents of this collection use set_destinations.

One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

pub fn set_destinations(self, input: Option<Vec<BulkEmailDestination>>) -> Self

One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

pub fn get_destinations(&self) -> &Option<Vec<BulkEmailDestination>>

One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

pub fn build(self) -> Result<SendBulkTemplatedEmailInput, BuildError>

Consumes the builder and constructs a SendBulkTemplatedEmailInput.

impl SendBulkTemplatedEmailInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<SendBulkTemplatedEmailOutput, SdkError<SendBulkTemplatedEmailError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for SendBulkTemplatedEmailInputBuilder

fn clone(&self) -> SendBulkTemplatedEmailInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendBulkTemplatedEmailInputBuilder

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

Formats the value using the given formatter.

impl Default for SendBulkTemplatedEmailInputBuilder

fn default() -> SendBulkTemplatedEmailInputBuilder

Returns the “default value” for a type.

impl PartialEq for SendBulkTemplatedEmailInputBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SendBulkTemplatedEmailInputBuilder