#[non_exhaustive]pub struct IdentityMailFromDomainAttributesBuilder { /* private fields */ }
Expand description
A builder for IdentityMailFromDomainAttributes
.
Implementations§
Source§impl IdentityMailFromDomainAttributesBuilder
impl IdentityMailFromDomainAttributesBuilder
Sourcepub fn mail_from_domain(self, input: impl Into<String>) -> Self
pub fn mail_from_domain(self, input: impl Into<String>) -> Self
The custom MAIL FROM domain that the identity is configured to use.
This field is required.Sourcepub fn set_mail_from_domain(self, input: Option<String>) -> Self
pub fn set_mail_from_domain(self, input: Option<String>) -> Self
The custom MAIL FROM domain that the identity is configured to use.
Sourcepub fn get_mail_from_domain(&self) -> &Option<String>
pub fn get_mail_from_domain(&self) -> &Option<String>
The custom MAIL FROM domain that the identity is configured to use.
Sourcepub fn mail_from_domain_status(self, input: CustomMailFromStatus) -> Self
pub fn mail_from_domain_status(self, input: CustomMailFromStatus) -> Self
The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success
, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure
.
Sourcepub fn set_mail_from_domain_status(
self,
input: Option<CustomMailFromStatus>,
) -> Self
pub fn set_mail_from_domain_status( self, input: Option<CustomMailFromStatus>, ) -> Self
The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success
, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure
.
Sourcepub fn get_mail_from_domain_status(&self) -> &Option<CustomMailFromStatus>
pub fn get_mail_from_domain_status(&self) -> &Option<CustomMailFromStatus>
The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success
, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure
.
Sourcepub fn behavior_on_mx_failure(self, input: BehaviorOnMxFailure) -> Self
pub fn behavior_on_mx_failure(self, input: BehaviorOnMxFailure) -> Self
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue
indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage
indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified
error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are Pending
, Failed
, and TemporaryFailure
.
Sourcepub fn set_behavior_on_mx_failure(
self,
input: Option<BehaviorOnMxFailure>,
) -> Self
pub fn set_behavior_on_mx_failure( self, input: Option<BehaviorOnMxFailure>, ) -> Self
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue
indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage
indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified
error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are Pending
, Failed
, and TemporaryFailure
.
Sourcepub fn get_behavior_on_mx_failure(&self) -> &Option<BehaviorOnMxFailure>
pub fn get_behavior_on_mx_failure(&self) -> &Option<BehaviorOnMxFailure>
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue
indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage
indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified
error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are Pending
, Failed
, and TemporaryFailure
.
Sourcepub fn build(self) -> Result<IdentityMailFromDomainAttributes, BuildError>
pub fn build(self) -> Result<IdentityMailFromDomainAttributes, BuildError>
Consumes the builder and constructs a IdentityMailFromDomainAttributes
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for IdentityMailFromDomainAttributesBuilder
impl Clone for IdentityMailFromDomainAttributesBuilder
Source§fn clone(&self) -> IdentityMailFromDomainAttributesBuilder
fn clone(&self) -> IdentityMailFromDomainAttributesBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for IdentityMailFromDomainAttributesBuilder
impl Default for IdentityMailFromDomainAttributesBuilder
Source§fn default() -> IdentityMailFromDomainAttributesBuilder
fn default() -> IdentityMailFromDomainAttributesBuilder
Source§impl PartialEq for IdentityMailFromDomainAttributesBuilder
impl PartialEq for IdentityMailFromDomainAttributesBuilder
Source§fn eq(&self, other: &IdentityMailFromDomainAttributesBuilder) -> bool
fn eq(&self, other: &IdentityMailFromDomainAttributesBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for IdentityMailFromDomainAttributesBuilder
Auto Trait Implementations§
impl Freeze for IdentityMailFromDomainAttributesBuilder
impl RefUnwindSafe for IdentityMailFromDomainAttributesBuilder
impl Send for IdentityMailFromDomainAttributesBuilder
impl Sync for IdentityMailFromDomainAttributesBuilder
impl Unpin for IdentityMailFromDomainAttributesBuilder
impl UnwindSafe for IdentityMailFromDomainAttributesBuilder
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);