#[non_exhaustive]pub struct SendEmailInputBuilder { /* private fields */ }
Expand description
A builder for SendEmailInput
.
Implementations§
Source§impl SendEmailInputBuilder
impl SendEmailInputBuilder
Sourcepub fn from_email_address(self, input: impl Into<String>) -> Self
pub fn from_email_address(self, input: impl Into<String>) -> Self
The email address to use as the "From" address for the email. The address that you specify has to be verified.
Sourcepub fn set_from_email_address(self, input: Option<String>) -> Self
pub fn set_from_email_address(self, input: Option<String>) -> Self
The email address to use as the "From" address for the email. The address that you specify has to be verified.
Sourcepub fn get_from_email_address(&self) -> &Option<String>
pub fn get_from_email_address(&self) -> &Option<String>
The email address to use as the "From" address for the email. The address that you specify has to be verified.
Sourcepub fn from_email_address_identity_arn(self, input: impl Into<String>) -> Self
pub fn from_email_address_identity_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 FromEmailAddress
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 sender@example.com, then you would specify the FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress
to be sender@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
For Raw emails, the FromEmailAddressIdentityArn
value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.
Sourcepub fn set_from_email_address_identity_arn(self, input: Option<String>) -> Self
pub fn set_from_email_address_identity_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 FromEmailAddress
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 sender@example.com, then you would specify the FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress
to be sender@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
For Raw emails, the FromEmailAddressIdentityArn
value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.
Sourcepub fn get_from_email_address_identity_arn(&self) -> &Option<String>
pub fn get_from_email_address_identity_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 FromEmailAddress
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 sender@example.com, then you would specify the FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress
to be sender@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
For Raw emails, the FromEmailAddressIdentityArn
value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.
Sourcepub fn destination(self, input: Destination) -> Self
pub fn destination(self, input: Destination) -> Self
An object that contains the recipients of the email message.
Sourcepub fn set_destination(self, input: Option<Destination>) -> Self
pub fn set_destination(self, input: Option<Destination>) -> Self
An object that contains the recipients of the email message.
Sourcepub fn get_destination(&self) -> &Option<Destination>
pub fn get_destination(&self) -> &Option<Destination>
An object that contains the recipients of the email message.
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 reply_to_addresses
.
To override the contents of this collection use set_reply_to_addresses
.
The "Reply-to" email addresses for the message. When 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 addresses for the message. When 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 addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
Sourcepub fn feedback_forwarding_email_address(self, input: impl Into<String>) -> Self
pub fn feedback_forwarding_email_address(self, input: impl Into<String>) -> Self
The address that you want bounce and complaint notifications to be sent to.
Sourcepub fn set_feedback_forwarding_email_address(
self,
input: Option<String>,
) -> Self
pub fn set_feedback_forwarding_email_address( self, input: Option<String>, ) -> Self
The address that you want bounce and complaint notifications to be sent to.
Sourcepub fn get_feedback_forwarding_email_address(&self) -> &Option<String>
pub fn get_feedback_forwarding_email_address(&self) -> &Option<String>
The address that you want bounce and complaint notifications to be sent to.
Sourcepub fn feedback_forwarding_email_address_identity_arn(
self,
input: impl Into<String>,
) -> Self
pub fn feedback_forwarding_email_address_identity_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 FeedbackForwardingEmailAddress
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 FeedbackForwardingEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress
to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
Sourcepub fn set_feedback_forwarding_email_address_identity_arn(
self,
input: Option<String>,
) -> Self
pub fn set_feedback_forwarding_email_address_identity_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 FeedbackForwardingEmailAddress
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 FeedbackForwardingEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress
to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
Sourcepub fn get_feedback_forwarding_email_address_identity_arn(
&self,
) -> &Option<String>
pub fn get_feedback_forwarding_email_address_identity_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 FeedbackForwardingEmailAddress
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 FeedbackForwardingEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress
to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
Sourcepub fn content(self, input: EmailContent) -> Self
pub fn content(self, input: EmailContent) -> Self
An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
This field is required.Sourcepub fn set_content(self, input: Option<EmailContent>) -> Self
pub fn set_content(self, input: Option<EmailContent>) -> Self
An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
Sourcepub fn get_content(&self) -> &Option<EmailContent>
pub fn get_content(&self) -> &Option<EmailContent>
An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
Appends an item to email_tags
.
To override the contents of this collection use set_email_tags
.
A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail
operation. 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 the SendEmail
operation. 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 the SendEmail
operation. 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 sending the email.
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 sending the email.
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 sending the email.
Sourcepub fn endpoint_id(self, input: impl Into<String>) -> Self
pub fn endpoint_id(self, input: impl Into<String>) -> Self
The ID of the multi-region endpoint (global-endpoint).
Sourcepub fn set_endpoint_id(self, input: Option<String>) -> Self
pub fn set_endpoint_id(self, input: Option<String>) -> Self
The ID of the multi-region endpoint (global-endpoint).
Sourcepub fn get_endpoint_id(&self) -> &Option<String>
pub fn get_endpoint_id(&self) -> &Option<String>
The ID of the multi-region endpoint (global-endpoint).
Sourcepub fn tenant_name(self, input: impl Into<String>) -> Self
pub fn tenant_name(self, input: impl Into<String>) -> Self
The name of the tenant through which this email will be sent.
The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.
Sourcepub fn set_tenant_name(self, input: Option<String>) -> Self
pub fn set_tenant_name(self, input: Option<String>) -> Self
The name of the tenant through which this email will be sent.
The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.
Sourcepub fn get_tenant_name(&self) -> &Option<String>
pub fn get_tenant_name(&self) -> &Option<String>
The name of the tenant through which this email will be sent.
The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.
Sourcepub fn list_management_options(self, input: ListManagementOptions) -> Self
pub fn list_management_options(self, input: ListManagementOptions) -> Self
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
Sourcepub fn set_list_management_options(
self,
input: Option<ListManagementOptions>,
) -> Self
pub fn set_list_management_options( self, input: Option<ListManagementOptions>, ) -> Self
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
Sourcepub fn get_list_management_options(&self) -> &Option<ListManagementOptions>
pub fn get_list_management_options(&self) -> &Option<ListManagementOptions>
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
Sourcepub fn build(self) -> Result<SendEmailInput, BuildError>
pub fn build(self) -> Result<SendEmailInput, BuildError>
Consumes the builder and constructs a SendEmailInput
.
Source§impl SendEmailInputBuilder
impl SendEmailInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<SendEmailOutput, SdkError<SendEmailError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<SendEmailOutput, SdkError<SendEmailError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for SendEmailInputBuilder
impl Clone for SendEmailInputBuilder
Source§fn clone(&self) -> SendEmailInputBuilder
fn clone(&self) -> SendEmailInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SendEmailInputBuilder
impl Debug for SendEmailInputBuilder
Source§impl Default for SendEmailInputBuilder
impl Default for SendEmailInputBuilder
Source§fn default() -> SendEmailInputBuilder
fn default() -> SendEmailInputBuilder
Source§impl PartialEq for SendEmailInputBuilder
impl PartialEq for SendEmailInputBuilder
impl StructuralPartialEq for SendEmailInputBuilder
Auto Trait Implementations§
impl Freeze for SendEmailInputBuilder
impl RefUnwindSafe for SendEmailInputBuilder
impl Send for SendEmailInputBuilder
impl Sync for SendEmailInputBuilder
impl Unpin for SendEmailInputBuilder
impl UnwindSafe for SendEmailInputBuilder
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);