pub struct Client { /* private fields */ }
Expand description
Client for Amazon Simple Email Service
Client for invoking operations on Amazon Simple Email Service. Each operation on Amazon Simple Email Service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_ses::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_ses::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CloneReceiptRuleSet
operation has
a Client::clone_receipt_rule_set
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.clone_receipt_rule_set()
.rule_set_name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
Source§impl Client
impl Client
Sourcepub fn clone_receipt_rule_set(&self) -> CloneReceiptRuleSetFluentBuilder
pub fn clone_receipt_rule_set(&self) -> CloneReceiptRuleSetFluentBuilder
Constructs a fluent builder for the CloneReceiptRuleSet
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the rule set to create. The name must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
-
Start and end with a letter or number.
-
Contain 64 characters or fewer.
-
original_rule_set_name(impl Into<String>)
/set_original_rule_set_name(Option<String>)
:
required: trueThe name of the rule set to clone.
- On success, responds with
CloneReceiptRuleSetOutput
- On failure, responds with
SdkError<CloneReceiptRuleSetError>
Source§impl Client
impl Client
Sourcepub fn create_configuration_set(&self) -> CreateConfigurationSetFluentBuilder
pub fn create_configuration_set(&self) -> CreateConfigurationSetFluentBuilder
Constructs a fluent builder for the CreateConfigurationSet
operation.
- The fluent builder is configurable:
configuration_set(ConfigurationSet)
/set_configuration_set(Option<ConfigurationSet>)
:
required: trueA data structure that contains the name of the configuration set.
- On success, responds with
CreateConfigurationSetOutput
- On failure, responds with
SdkError<CreateConfigurationSetError>
Source§impl Client
impl Client
Sourcepub fn create_configuration_set_event_destination(
&self,
) -> CreateConfigurationSetEventDestinationFluentBuilder
pub fn create_configuration_set_event_destination( &self, ) -> CreateConfigurationSetEventDestinationFluentBuilder
Constructs a fluent builder for the CreateConfigurationSetEventDestination
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set that the event destination should be associated with.
event_destination(EventDestination)
/set_event_destination(Option<EventDestination>)
:
required: trueAn object that describes the Amazon Web Services service that email sending event where information is published.
- On success, responds with
CreateConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<CreateConfigurationSetEventDestinationError>
Source§impl Client
impl Client
Sourcepub fn create_configuration_set_tracking_options(
&self,
) -> CreateConfigurationSetTrackingOptionsFluentBuilder
pub fn create_configuration_set_tracking_options( &self, ) -> CreateConfigurationSetTrackingOptionsFluentBuilder
Constructs a fluent builder for the CreateConfigurationSetTrackingOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set that the tracking options should be associated with.
tracking_options(TrackingOptions)
/set_tracking_options(Option<TrackingOptions>)
:
required: trueA domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
- On success, responds with
CreateConfigurationSetTrackingOptionsOutput
- On failure, responds with
SdkError<CreateConfigurationSetTrackingOptionsError>
Source§impl Client
impl Client
Sourcepub fn create_custom_verification_email_template(
&self,
) -> CreateCustomVerificationEmailTemplateFluentBuilder
pub fn create_custom_verification_email_template( &self, ) -> CreateCustomVerificationEmailTemplateFluentBuilder
Constructs a fluent builder for the CreateCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the custom verification email template.
from_email_address(impl Into<String>)
/set_from_email_address(Option<String>)
:
required: trueThe email address that the custom verification email is sent from.
template_subject(impl Into<String>)
/set_template_subject(Option<String>)
:
required: trueThe subject line of the custom verification email.
template_content(impl Into<String>)
/set_template_content(Option<String>)
:
required: trueThe content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
success_redirection_url(impl Into<String>)
/set_success_redirection_url(Option<String>)
:
required: trueThe URL that the recipient of the verification email is sent to if his or her address is successfully verified.
failure_redirection_url(impl Into<String>)
/set_failure_redirection_url(Option<String>)
:
required: trueThe URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
- On success, responds with
CreateCustomVerificationEmailTemplateOutput
- On failure, responds with
SdkError<CreateCustomVerificationEmailTemplateError>
Source§impl Client
impl Client
Sourcepub fn create_receipt_filter(&self) -> CreateReceiptFilterFluentBuilder
pub fn create_receipt_filter(&self) -> CreateReceiptFilterFluentBuilder
Constructs a fluent builder for the CreateReceiptFilter
operation.
- The fluent builder is configurable:
filter(ReceiptFilter)
/set_filter(Option<ReceiptFilter>)
:
required: trueA data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
- On success, responds with
CreateReceiptFilterOutput
- On failure, responds with
SdkError<CreateReceiptFilterError>
Source§impl Client
impl Client
Sourcepub fn create_receipt_rule(&self) -> CreateReceiptRuleFluentBuilder
pub fn create_receipt_rule(&self) -> CreateReceiptRuleFluentBuilder
Constructs a fluent builder for the CreateReceiptRule
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the rule set where the receipt rule is added.
after(impl Into<String>)
/set_after(Option<String>)
:
required: falseThe name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
rule(ReceiptRule)
/set_rule(Option<ReceiptRule>)
:
required: trueA data structure that contains the specified rule’s name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- On success, responds with
CreateReceiptRuleOutput
- On failure, responds with
SdkError<CreateReceiptRuleError>
Source§impl Client
impl Client
Sourcepub fn create_receipt_rule_set(&self) -> CreateReceiptRuleSetFluentBuilder
pub fn create_receipt_rule_set(&self) -> CreateReceiptRuleSetFluentBuilder
Constructs a fluent builder for the CreateReceiptRuleSet
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the rule set to create. The name must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
-
Start and end with a letter or number.
-
Contain 64 characters or fewer.
-
- On success, responds with
CreateReceiptRuleSetOutput
- On failure, responds with
SdkError<CreateReceiptRuleSetError>
Source§impl Client
impl Client
Sourcepub fn create_template(&self) -> CreateTemplateFluentBuilder
pub fn create_template(&self) -> CreateTemplateFluentBuilder
Constructs a fluent builder for the CreateTemplate
operation.
- The fluent builder is configurable:
template(Template)
/set_template(Option<Template>)
:
required: trueThe content of the email, composed of a subject line and either an HTML part or a text-only part.
- On success, responds with
CreateTemplateOutput
- On failure, responds with
SdkError<CreateTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_set(&self) -> DeleteConfigurationSetFluentBuilder
pub fn delete_configuration_set(&self) -> DeleteConfigurationSetFluentBuilder
Constructs a fluent builder for the DeleteConfigurationSet
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set to delete.
- On success, responds with
DeleteConfigurationSetOutput
- On failure, responds with
SdkError<DeleteConfigurationSetError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_set_event_destination(
&self,
) -> DeleteConfigurationSetEventDestinationFluentBuilder
pub fn delete_configuration_set_event_destination( &self, ) -> DeleteConfigurationSetEventDestinationFluentBuilder
Constructs a fluent builder for the DeleteConfigurationSetEventDestination
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set from which to delete the event destination.
event_destination_name(impl Into<String>)
/set_event_destination_name(Option<String>)
:
required: trueThe name of the event destination to delete.
- On success, responds with
DeleteConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<DeleteConfigurationSetEventDestinationError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_set_tracking_options(
&self,
) -> DeleteConfigurationSetTrackingOptionsFluentBuilder
pub fn delete_configuration_set_tracking_options( &self, ) -> DeleteConfigurationSetTrackingOptionsFluentBuilder
Constructs a fluent builder for the DeleteConfigurationSetTrackingOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set.
- On success, responds with
DeleteConfigurationSetTrackingOptionsOutput
- On failure, responds with
SdkError<DeleteConfigurationSetTrackingOptionsError>
Source§impl Client
impl Client
Sourcepub fn delete_custom_verification_email_template(
&self,
) -> DeleteCustomVerificationEmailTemplateFluentBuilder
pub fn delete_custom_verification_email_template( &self, ) -> DeleteCustomVerificationEmailTemplateFluentBuilder
Constructs a fluent builder for the DeleteCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the custom verification email template to delete.
- On success, responds with
DeleteCustomVerificationEmailTemplateOutput
- On failure, responds with
SdkError<DeleteCustomVerificationEmailTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_identity(&self) -> DeleteIdentityFluentBuilder
pub fn delete_identity(&self) -> DeleteIdentityFluentBuilder
Constructs a fluent builder for the DeleteIdentity
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity to be removed from the list of identities for the Amazon Web Services account.
- On success, responds with
DeleteIdentityOutput
- On failure, responds with
SdkError<DeleteIdentityError>
Source§impl Client
impl Client
Sourcepub fn delete_identity_policy(&self) -> DeleteIdentityPolicyFluentBuilder
pub fn delete_identity_policy(&self) -> DeleteIdentityPolicyFluentBuilder
Constructs a fluent builder for the DeleteIdentityPolicy
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity that is associated with the policy to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com
,example.com
,arn:aws:ses:us-east-1:123456789012:identity/example.com
.To successfully call this operation, you must own the identity.
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:
required: trueThe name of the policy to be deleted.
- On success, responds with
DeleteIdentityPolicyOutput
- On failure, responds with
SdkError<DeleteIdentityPolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_receipt_filter(&self) -> DeleteReceiptFilterFluentBuilder
pub fn delete_receipt_filter(&self) -> DeleteReceiptFilterFluentBuilder
Constructs a fluent builder for the DeleteReceiptFilter
operation.
- The fluent builder is configurable:
filter_name(impl Into<String>)
/set_filter_name(Option<String>)
:
required: trueThe name of the IP address filter to delete.
- On success, responds with
DeleteReceiptFilterOutput
- On failure, responds with
SdkError<DeleteReceiptFilterError>
Source§impl Client
impl Client
Sourcepub fn delete_receipt_rule(&self) -> DeleteReceiptRuleFluentBuilder
pub fn delete_receipt_rule(&self) -> DeleteReceiptRuleFluentBuilder
Constructs a fluent builder for the DeleteReceiptRule
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the receipt rule set that contains the receipt rule to delete.
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:
required: trueThe name of the receipt rule to delete.
- On success, responds with
DeleteReceiptRuleOutput
- On failure, responds with
SdkError<DeleteReceiptRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_receipt_rule_set(&self) -> DeleteReceiptRuleSetFluentBuilder
pub fn delete_receipt_rule_set(&self) -> DeleteReceiptRuleSetFluentBuilder
Constructs a fluent builder for the DeleteReceiptRuleSet
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the receipt rule set to delete.
- On success, responds with
DeleteReceiptRuleSetOutput
- On failure, responds with
SdkError<DeleteReceiptRuleSetError>
Source§impl Client
impl Client
Sourcepub fn delete_template(&self) -> DeleteTemplateFluentBuilder
pub fn delete_template(&self) -> DeleteTemplateFluentBuilder
Constructs a fluent builder for the DeleteTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the template to be deleted.
- On success, responds with
DeleteTemplateOutput
- On failure, responds with
SdkError<DeleteTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_verified_email_address(
&self,
) -> DeleteVerifiedEmailAddressFluentBuilder
pub fn delete_verified_email_address( &self, ) -> DeleteVerifiedEmailAddressFluentBuilder
Constructs a fluent builder for the DeleteVerifiedEmailAddress
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:
required: trueAn email address to be removed from the list of verified addresses.
- On success, responds with
DeleteVerifiedEmailAddressOutput
- On failure, responds with
SdkError<DeleteVerifiedEmailAddressError>
Source§impl Client
impl Client
Sourcepub fn describe_active_receipt_rule_set(
&self,
) -> DescribeActiveReceiptRuleSetFluentBuilder
pub fn describe_active_receipt_rule_set( &self, ) -> DescribeActiveReceiptRuleSetFluentBuilder
Constructs a fluent builder for the DescribeActiveReceiptRuleSet
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeActiveReceiptRuleSetOutput
with field(s):metadata(Option<ReceiptRuleSetMetadata>)
:The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
rules(Option<Vec::<ReceiptRule>>)
:The receipt rules that belong to the active rule set.
- On failure, responds with
SdkError<DescribeActiveReceiptRuleSetError>
Source§impl Client
impl Client
Sourcepub fn describe_configuration_set(
&self,
) -> DescribeConfigurationSetFluentBuilder
pub fn describe_configuration_set( &self, ) -> DescribeConfigurationSetFluentBuilder
Constructs a fluent builder for the DescribeConfigurationSet
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set to describe.
configuration_set_attribute_names(ConfigurationSetAttribute)
/set_configuration_set_attribute_names(Option<Vec::<ConfigurationSetAttribute>>)
:
required: falseA list of configuration set attributes to return.
- On success, responds with
DescribeConfigurationSetOutput
with field(s):configuration_set(Option<ConfigurationSet>)
:The configuration set object associated with the specified configuration set.
event_destinations(Option<Vec::<EventDestination>>)
:A list of event destinations associated with the configuration set.
tracking_options(Option<TrackingOptions>)
:The name of the custom open and click tracking domain associated with the configuration set.
delivery_options(Option<DeliveryOptions>)
:Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
reputation_options(Option<ReputationOptions>)
:An object that represents the reputation settings for the configuration set.
- On failure, responds with
SdkError<DescribeConfigurationSetError>
Source§impl Client
impl Client
Sourcepub fn describe_receipt_rule(&self) -> DescribeReceiptRuleFluentBuilder
pub fn describe_receipt_rule(&self) -> DescribeReceiptRuleFluentBuilder
Constructs a fluent builder for the DescribeReceiptRule
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the receipt rule set that the receipt rule belongs to.
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:
required: trueThe name of the receipt rule.
- On success, responds with
DescribeReceiptRuleOutput
with field(s):rule(Option<ReceiptRule>)
:A data structure that contains the specified receipt rule’s name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
- On failure, responds with
SdkError<DescribeReceiptRuleError>
Source§impl Client
impl Client
Sourcepub fn describe_receipt_rule_set(&self) -> DescribeReceiptRuleSetFluentBuilder
pub fn describe_receipt_rule_set(&self) -> DescribeReceiptRuleSetFluentBuilder
Constructs a fluent builder for the DescribeReceiptRuleSet
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the receipt rule set to describe.
- On success, responds with
DescribeReceiptRuleSetOutput
with field(s):metadata(Option<ReceiptRuleSetMetadata>)
:The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
rules(Option<Vec::<ReceiptRule>>)
:A list of the receipt rules that belong to the specified receipt rule set.
- On failure, responds with
SdkError<DescribeReceiptRuleSetError>
Source§impl Client
impl Client
Sourcepub fn get_account_sending_enabled(
&self,
) -> GetAccountSendingEnabledFluentBuilder
pub fn get_account_sending_enabled( &self, ) -> GetAccountSendingEnabledFluentBuilder
Constructs a fluent builder for the GetAccountSendingEnabled
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetAccountSendingEnabledOutput
with field(s):enabled(bool)
:Describes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.
- On failure, responds with
SdkError<GetAccountSendingEnabledError>
Source§impl Client
impl Client
Sourcepub fn get_custom_verification_email_template(
&self,
) -> GetCustomVerificationEmailTemplateFluentBuilder
pub fn get_custom_verification_email_template( &self, ) -> GetCustomVerificationEmailTemplateFluentBuilder
Constructs a fluent builder for the GetCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the custom verification email template to retrieve.
- On success, responds with
GetCustomVerificationEmailTemplateOutput
with field(s):template_name(Option<String>)
:The name of the custom verification email template.
from_email_address(Option<String>)
:The email address that the custom verification email is sent from.
template_subject(Option<String>)
:The subject line of the custom verification email.
template_content(Option<String>)
:The content of the custom verification email.
success_redirection_url(Option<String>)
:The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
failure_redirection_url(Option<String>)
:The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
- On failure, responds with
SdkError<GetCustomVerificationEmailTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_identity_dkim_attributes(
&self,
) -> GetIdentityDkimAttributesFluentBuilder
pub fn get_identity_dkim_attributes( &self, ) -> GetIdentityDkimAttributesFluentBuilder
Constructs a fluent builder for the GetIdentityDkimAttributes
operation.
- The fluent builder is configurable:
identities(impl Into<String>)
/set_identities(Option<Vec::<String>>)
:
required: trueA list of one or more verified identities - email addresses, domains, or both.
- On success, responds with
GetIdentityDkimAttributesOutput
with field(s):dkim_attributes(HashMap::<String, IdentityDkimAttributes>)
:The DKIM attributes for an email address or a domain.
- On failure, responds with
SdkError<GetIdentityDkimAttributesError>
Source§impl Client
impl Client
Sourcepub fn get_identity_mail_from_domain_attributes(
&self,
) -> GetIdentityMailFromDomainAttributesFluentBuilder
pub fn get_identity_mail_from_domain_attributes( &self, ) -> GetIdentityMailFromDomainAttributesFluentBuilder
Constructs a fluent builder for the GetIdentityMailFromDomainAttributes
operation.
- The fluent builder is configurable:
identities(impl Into<String>)
/set_identities(Option<Vec::<String>>)
:
required: trueA list of one or more identities.
- On success, responds with
GetIdentityMailFromDomainAttributesOutput
with field(s):mail_from_domain_attributes(HashMap::<String, IdentityMailFromDomainAttributes>)
:A map of identities to custom MAIL FROM attributes.
- On failure, responds with
SdkError<GetIdentityMailFromDomainAttributesError>
Source§impl Client
impl Client
Sourcepub fn get_identity_notification_attributes(
&self,
) -> GetIdentityNotificationAttributesFluentBuilder
pub fn get_identity_notification_attributes( &self, ) -> GetIdentityNotificationAttributesFluentBuilder
Constructs a fluent builder for the GetIdentityNotificationAttributes
operation.
- The fluent builder is configurable:
identities(impl Into<String>)
/set_identities(Option<Vec::<String>>)
:
required: trueA list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com
,example.com
,arn:aws:ses:us-east-1:123456789012:identity/example.com
.
- On success, responds with
GetIdentityNotificationAttributesOutput
with field(s):notification_attributes(HashMap::<String, IdentityNotificationAttributes>)
:A map of Identity to IdentityNotificationAttributes.
- On failure, responds with
SdkError<GetIdentityNotificationAttributesError>
Source§impl Client
impl Client
Sourcepub fn get_identity_policies(&self) -> GetIdentityPoliciesFluentBuilder
pub fn get_identity_policies(&self) -> GetIdentityPoliciesFluentBuilder
Constructs a fluent builder for the GetIdentityPolicies
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity for which the policies are retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com
,example.com
,arn:aws:ses:us-east-1:123456789012:identity/example.com
.To successfully call this operation, you must own the identity.
policy_names(impl Into<String>)
/set_policy_names(Option<Vec::<String>>)
:
required: trueA list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use
ListIdentityPolicies
.
- On success, responds with
GetIdentityPoliciesOutput
with field(s):policies(HashMap::<String, String>)
:A map of policy names to policies.
- On failure, responds with
SdkError<GetIdentityPoliciesError>
Source§impl Client
impl Client
Sourcepub fn get_identity_verification_attributes(
&self,
) -> GetIdentityVerificationAttributesFluentBuilder
pub fn get_identity_verification_attributes( &self, ) -> GetIdentityVerificationAttributesFluentBuilder
Constructs a fluent builder for the GetIdentityVerificationAttributes
operation.
- The fluent builder is configurable:
identities(impl Into<String>)
/set_identities(Option<Vec::<String>>)
:
required: trueA list of identities.
- On success, responds with
GetIdentityVerificationAttributesOutput
with field(s):verification_attributes(HashMap::<String, IdentityVerificationAttributes>)
:A map of Identities to IdentityVerificationAttributes objects.
- On failure, responds with
SdkError<GetIdentityVerificationAttributesError>
Source§impl Client
impl Client
Sourcepub fn get_send_quota(&self) -> GetSendQuotaFluentBuilder
pub fn get_send_quota(&self) -> GetSendQuotaFluentBuilder
Constructs a fluent builder for the GetSendQuota
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetSendQuotaOutput
with field(s):max24_hour_send(f64)
:The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
max_send_rate(f64)
:The maximum number of emails that Amazon SES can accept from the user’s account per second.
The rate at which Amazon SES accepts the user’s messages might be less than the maximum send rate.
sent_last24_hours(f64)
:The number of emails sent during the previous 24 hours.
- On failure, responds with
SdkError<GetSendQuotaError>
Source§impl Client
impl Client
Sourcepub fn get_send_statistics(&self) -> GetSendStatisticsFluentBuilder
pub fn get_send_statistics(&self) -> GetSendStatisticsFluentBuilder
Constructs a fluent builder for the GetSendStatistics
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetSendStatisticsOutput
with field(s):send_data_points(Option<Vec::<SendDataPoint>>)
:A list of data points, each of which represents 15 minutes of activity.
- On failure, responds with
SdkError<GetSendStatisticsError>
Source§impl Client
impl Client
Sourcepub fn get_template(&self) -> GetTemplateFluentBuilder
pub fn get_template(&self) -> GetTemplateFluentBuilder
Constructs a fluent builder for the GetTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the template to retrieve.
- On success, responds with
GetTemplateOutput
with field(s):template(Option<Template>)
:The content of the email, composed of a subject line and either an HTML part or a text-only part.
- On failure, responds with
SdkError<GetTemplateError>
Source§impl Client
impl Client
Sourcepub fn list_configuration_sets(&self) -> ListConfigurationSetsFluentBuilder
pub fn list_configuration_sets(&self) -> ListConfigurationSetsFluentBuilder
Constructs a fluent builder for the ListConfigurationSets
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token returned from a previous call to
ListConfigurationSets
to indicate the position of the configuration set in the configuration set list.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe number of configuration sets to return.
- On success, responds with
ListConfigurationSetsOutput
with field(s):configuration_sets(Option<Vec::<ConfigurationSet>>)
:A list of configuration sets.
next_token(Option<String>)
:A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of
ListConfigurationSets
.
- On failure, responds with
SdkError<ListConfigurationSetsError>
Source§impl Client
impl Client
Sourcepub fn list_custom_verification_email_templates(
&self,
) -> ListCustomVerificationEmailTemplatesFluentBuilder
pub fn list_custom_verification_email_templates( &self, ) -> ListCustomVerificationEmailTemplatesFluentBuilder
Constructs a fluent builder for the ListCustomVerificationEmailTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn array the contains the name and creation time stamp for each template in your Amazon SES account.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation returns up to 50 results.
- On success, responds with
ListCustomVerificationEmailTemplatesOutput
with field(s):custom_verification_email_templates(Option<Vec::<CustomVerificationEmailTemplate>>)
:A list of the custom verification email templates that exist in your account.
next_token(Option<String>)
:A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to
ListTemplates
to retrieve the next 50 custom verification email templates.
- On failure, responds with
SdkError<ListCustomVerificationEmailTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_identities(&self) -> ListIdentitiesFluentBuilder
pub fn list_identities(&self) -> ListIdentitiesFluentBuilder
Constructs a fluent builder for the ListIdentities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:
required: falseThe type of the identities to list. Possible values are “EmailAddress” and “Domain”. If this parameter is omitted, then all identities are listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to use for pagination.
max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of identities per page. Possible values are 1-1000 inclusive.
- On success, responds with
ListIdentitiesOutput
with field(s):identities(Vec::<String>)
:A list of identities.
next_token(Option<String>)
:The token used for pagination.
- On failure, responds with
SdkError<ListIdentitiesError>
Source§impl Client
impl Client
Sourcepub fn list_identity_policies(&self) -> ListIdentityPoliciesFluentBuilder
pub fn list_identity_policies(&self) -> ListIdentityPoliciesFluentBuilder
Constructs a fluent builder for the ListIdentityPolicies
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity that is associated with the policy for which the policies are listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com
,example.com
,arn:aws:ses:us-east-1:123456789012:identity/example.com
.To successfully call this operation, you must own the identity.
- On success, responds with
ListIdentityPoliciesOutput
with field(s):policy_names(Vec::<String>)
:A list of names of policies that apply to the specified identity.
- On failure, responds with
SdkError<ListIdentityPoliciesError>
Source§impl Client
impl Client
Sourcepub fn list_receipt_filters(&self) -> ListReceiptFiltersFluentBuilder
pub fn list_receipt_filters(&self) -> ListReceiptFiltersFluentBuilder
Constructs a fluent builder for the ListReceiptFilters
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ListReceiptFiltersOutput
with field(s):filters(Option<Vec::<ReceiptFilter>>)
:A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.
- On failure, responds with
SdkError<ListReceiptFiltersError>
Source§impl Client
impl Client
Sourcepub fn list_receipt_rule_sets(&self) -> ListReceiptRuleSetsFluentBuilder
pub fn list_receipt_rule_sets(&self) -> ListReceiptRuleSetsFluentBuilder
Constructs a fluent builder for the ListReceiptRuleSets
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token returned from a previous call to
ListReceiptRuleSets
to indicate the position in the receipt rule set list.
- On success, responds with
ListReceiptRuleSetsOutput
with field(s):rule_sets(Option<Vec::<ReceiptRuleSetMetadata>>)
:The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.
next_token(Option<String>)
:A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of
ListReceiptRuleSets
to retrieve up to 100 receipt rule sets at a time.
- On failure, responds with
SdkError<ListReceiptRuleSetsError>
Source§impl Client
impl Client
Sourcepub fn list_templates(&self) -> ListTemplatesFluentBuilder
pub fn list_templates(&self) -> ListTemplatesFluentBuilder
Constructs a fluent builder for the ListTemplates
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token returned from a previous call to
ListTemplates
to indicate the position in the list of email templates.max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of templates to return. This value must be at least 1 and less than or equal to 100. If more than 100 items are requested, the page size will automatically set to 100. If you do not specify a value, 10 is the default page size.
- On success, responds with
ListTemplatesOutput
with field(s):templates_metadata(Option<Vec::<TemplateMetadata>>)
:An array the contains the name and creation time stamp for each template in your Amazon SES account.
next_token(Option<String>)
:A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to
ListTemplates
to retrieve the next set of email templates within your page size.
- On failure, responds with
SdkError<ListTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_verified_email_addresses(
&self,
) -> ListVerifiedEmailAddressesFluentBuilder
pub fn list_verified_email_addresses( &self, ) -> ListVerifiedEmailAddressesFluentBuilder
Constructs a fluent builder for the ListVerifiedEmailAddresses
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ListVerifiedEmailAddressesOutput
with field(s):verified_email_addresses(Option<Vec::<String>>)
:A list of email addresses that have been verified.
- On failure, responds with
SdkError<ListVerifiedEmailAddressesError>
Source§impl Client
impl Client
Sourcepub fn put_configuration_set_delivery_options(
&self,
) -> PutConfigurationSetDeliveryOptionsFluentBuilder
pub fn put_configuration_set_delivery_options( &self, ) -> PutConfigurationSetDeliveryOptionsFluentBuilder
Constructs a fluent builder for the PutConfigurationSetDeliveryOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set.
delivery_options(DeliveryOptions)
/set_delivery_options(Option<DeliveryOptions>)
:
required: falseSpecifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
- On success, responds with
PutConfigurationSetDeliveryOptionsOutput
- On failure, responds with
SdkError<PutConfigurationSetDeliveryOptionsError>
Source§impl Client
impl Client
Sourcepub fn put_identity_policy(&self) -> PutIdentityPolicyFluentBuilder
pub fn put_identity_policy(&self) -> PutIdentityPolicyFluentBuilder
Constructs a fluent builder for the PutIdentityPolicy
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity to which that the policy applies. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com
,example.com
,arn:aws:ses:us-east-1:123456789012:identity/example.com
.To successfully call this operation, you must own the identity.
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:
required: trueThe name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueThe text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
- On success, responds with
PutIdentityPolicyOutput
- On failure, responds with
SdkError<PutIdentityPolicyError>
Source§impl Client
impl Client
Sourcepub fn reorder_receipt_rule_set(&self) -> ReorderReceiptRuleSetFluentBuilder
pub fn reorder_receipt_rule_set(&self) -> ReorderReceiptRuleSetFluentBuilder
Constructs a fluent builder for the ReorderReceiptRuleSet
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the receipt rule set to reorder.
rule_names(impl Into<String>)
/set_rule_names(Option<Vec::<String>>)
:
required: trueThe specified receipt rule set’s receipt rules, in order.
- On success, responds with
ReorderReceiptRuleSetOutput
- On failure, responds with
SdkError<ReorderReceiptRuleSetError>
Source§impl Client
impl Client
Sourcepub fn send_bounce(&self) -> SendBounceFluentBuilder
pub fn send_bounce(&self) -> SendBounceFluentBuilder
Constructs a fluent builder for the SendBounce
operation.
- The fluent builder is configurable:
original_message_id(impl Into<String>)
/set_original_message_id(Option<String>)
:
required: trueThe message ID of the message to be bounced.
bounce_sender(impl Into<String>)
/set_bounce_sender(Option<String>)
:
required: trueThe address to use in the “From” header of the bounce message. This must be an identity that you have verified with Amazon SES.
explanation(impl Into<String>)
/set_explanation(Option<String>)
:
required: falseHuman-readable text for the bounce message to explain the failure. If not specified, the text is auto-generated based on the bounced recipient information.
message_dsn(MessageDsn)
/set_message_dsn(Option<MessageDsn>)
:
required: falseMessage-related DSN fields. If not specified, Amazon SES chooses the values.
bounced_recipient_info_list(BouncedRecipientInfo)
/set_bounced_recipient_info_list(Option<Vec::<BouncedRecipientInfo>>)
:
required: trueA list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one
BouncedRecipientInfo
in the list.bounce_sender_arn(impl Into<String>)
/set_bounce_sender_arn(Option<String>)
:
required: falseThis 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 address in the “From” header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
- On success, responds with
SendBounceOutput
with field(s):message_id(Option<String>)
:The message ID of the bounce message.
- On failure, responds with
SdkError<SendBounceError>
Source§impl Client
impl Client
Sourcepub fn send_bulk_templated_email(&self) -> SendBulkTemplatedEmailFluentBuilder
pub fn send_bulk_templated_email(&self) -> SendBulkTemplatedEmailFluentBuilder
Constructs a fluent builder for the SendBulkTemplatedEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:
required: trueThe 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.
source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.For more information about sending authorization, see the Amazon SES Developer Guide.
reply_to_addresses(impl Into<String>)
/set_reply_to_addresses(Option<Vec::<String>>)
:
required: falseThe reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
return_path(impl Into<String>)
/set_return_path(Option<String>)
:
required: falseThe 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. TheReturnPath
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.return_path_arn(impl Into<String>)
/set_return_path_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.For more information about sending authorization, see the Amazon SES Developer Guide.
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: falseThe name of the configuration set to use when you send an email using
SendBulkTemplatedEmail
.default_tags(MessageTag)
/set_default_tags(Option<Vec::<MessageTag>>)
:
required: falseA list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using
SendBulkTemplatedEmail
.template(impl Into<String>)
/set_template(Option<String>)
:
required: trueThe template to use when sending this email.
template_arn(impl Into<String>)
/set_template_arn(Option<String>)
:
required: falseThe ARN of the template to use when sending this email.
default_template_data(impl Into<String>)
/set_default_template_data(Option<String>)
:
required: trueA 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.
destinations(BulkEmailDestination)
/set_destinations(Option<Vec::<BulkEmailDestination>>)
:
required: trueOne or more
Destination
objects. All of the recipients in aDestination
receive the same version of the email. You can specify up to 50Destination
objects within aDestinations
array.
- On success, responds with
SendBulkTemplatedEmailOutput
with field(s):status(Vec::<BulkEmailDestinationStatus>)
:One object per intended recipient. Check each response object and retry any messages with a failure status. (Note that order of responses will be respective to order of destinations in the request.)Receipt rules enable you to specify which actions
- On failure, responds with
SdkError<SendBulkTemplatedEmailError>
Source§impl Client
impl Client
Sourcepub fn send_custom_verification_email(
&self,
) -> SendCustomVerificationEmailFluentBuilder
pub fn send_custom_verification_email( &self, ) -> SendCustomVerificationEmailFluentBuilder
Constructs a fluent builder for the SendCustomVerificationEmail
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:
required: trueThe email address to verify.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the custom verification email template to use when sending the verification email.
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: falseName of a configuration set to use when sending the verification email.
- On success, responds with
SendCustomVerificationEmailOutput
with field(s):message_id(Option<String>)
:The unique message identifier returned from the
SendCustomVerificationEmail
operation.
- On failure, responds with
SdkError<SendCustomVerificationEmailError>
Source§impl Client
impl Client
Sourcepub fn send_email(&self) -> SendEmailFluentBuilder
pub fn send_email(&self) -> SendEmailFluentBuilder
Constructs a fluent builder for the SendEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:
required: trueThe 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.
destination(Destination)
/set_destination(Option<Destination>)
:
required: trueThe destination for this email, composed of To:, CC:, and BCC: fields.
message(Message)
/set_message(Option<Message>)
:
required: trueThe message to be sent.
reply_to_addresses(impl Into<String>)
/set_reply_to_addresses(Option<Vec::<String>>)
:
required: falseThe reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
return_path(impl Into<String>)
/set_return_path(Option<String>)
:
required: falseThe 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. TheReturnPath
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(impl Into<String>)
/set_source_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.For more information about sending authorization, see the Amazon SES Developer Guide.
return_path_arn(impl Into<String>)
/set_return_path_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.For more information about sending authorization, see the Amazon SES Developer Guide.
tags(MessageTag)
/set_tags(Option<Vec::<MessageTag>>)
:
required: falseA list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: falseThe name of the configuration set to use when you send an email using
SendEmail
.
- On success, responds with
SendEmailOutput
with field(s):message_id(String)
:The unique message identifier returned from the
SendEmail
action.
- On failure, responds with
SdkError<SendEmailError>
Source§impl Client
impl Client
Sourcepub fn send_raw_email(&self) -> SendRawEmailFluentBuilder
pub fn send_raw_email(&self) -> SendRawEmailFluentBuilder
Constructs a fluent builder for the SendRawEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:
required: falseThe identity’s email address. If you do not provide a value for this parameter, you must specify a “From” address in the raw text of the message. (You can also specify both.)
Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. 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.
If you specify the
Source
parameter and have feedback forwarding enabled, then bounces and complaints are sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.destinations(impl Into<String>)
/set_destinations(Option<Vec::<String>>)
:
required: falseA list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
raw_message(RawMessage)
/set_raw_message(Option<RawMessage>)
:
required: trueThe raw email message itself. The message has to meet the following criteria:
-
The message has to contain a header and a body, separated by a blank line.
-
All of the required header fields must be present in the message.
-
Each part of a multipart MIME message must be formatted properly.
-
Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.
-
The entire message must be base64-encoded.
-
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.
-
Per RFC 5321, the maximum length of each line of text, including the
, must not exceed 1,000 characters.
-
from_arn(impl Into<String>)
/set_from_arn(Option<String>)
:
required: falseThis 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 specify a particular “From” address in the header of the raw email.
Instead of using this parameter, you can use the X-header
X-SES-FROM-ARN
in the raw message of the email. If you use both theFromArn
parameter and the corresponding X-header, Amazon SES uses the value of theFromArn
parameter.For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the Amazon SES Developer Guide.source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you use both theSourceArn
parameter and the corresponding X-header, Amazon SES uses the value of theSourceArn
parameter.For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the Amazon SES Developer Guide.return_path_arn(impl Into<String>)
/set_return_path_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.Instead of using this parameter, you can use the X-header
X-SES-RETURN-PATH-ARN
in the raw message of the email. If you use both theReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of theReturnPathArn
parameter.For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the Amazon SES Developer Guide.tags(MessageTag)
/set_tags(Option<Vec::<MessageTag>>)
:
required: falseA list of tags, in the form of name/value pairs, to apply to an email that you send using
SendRawEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: falseThe name of the configuration set to use when you send an email using
SendRawEmail
.
- On success, responds with
SendRawEmailOutput
with field(s):message_id(String)
:The unique message identifier returned from the
SendRawEmail
action.
- On failure, responds with
SdkError<SendRawEmailError>
Source§impl Client
impl Client
Sourcepub fn send_templated_email(&self) -> SendTemplatedEmailFluentBuilder
pub fn send_templated_email(&self) -> SendTemplatedEmailFluentBuilder
Constructs a fluent builder for the SendTemplatedEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:
required: trueThe 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.
destination(Destination)
/set_destination(Option<Destination>)
:
required: trueThe 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(impl Into<String>)
/set_reply_to_addresses(Option<Vec::<String>>)
:
required: falseThe reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
return_path(impl Into<String>)
/set_return_path(Option<String>)
:
required: falseThe 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. TheReturnPath
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(impl Into<String>)
/set_source_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.For more information about sending authorization, see the Amazon SES Developer Guide.
return_path_arn(impl Into<String>)
/set_return_path_arn(Option<String>)
:
required: falseThis 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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.For more information about sending authorization, see the Amazon SES Developer Guide.
tags(MessageTag)
/set_tags(Option<Vec::<MessageTag>>)
:
required: falseA 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(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: falseThe name of the configuration set to use when you send an email using
SendTemplatedEmail
.template(impl Into<String>)
/set_template(Option<String>)
:
required: trueThe template to use when sending this email.
template_arn(impl Into<String>)
/set_template_arn(Option<String>)
:
required: falseThe ARN of the template to use when sending this email.
template_data(impl Into<String>)
/set_template_data(Option<String>)
:
required: trueA 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.
- On success, responds with
SendTemplatedEmailOutput
with field(s):message_id(String)
:The unique message identifier returned from the
SendTemplatedEmail
action.
- On failure, responds with
SdkError<SendTemplatedEmailError>
Source§impl Client
impl Client
Sourcepub fn set_active_receipt_rule_set(
&self,
) -> SetActiveReceiptRuleSetFluentBuilder
pub fn set_active_receipt_rule_set( &self, ) -> SetActiveReceiptRuleSetFluentBuilder
Constructs a fluent builder for the SetActiveReceiptRuleSet
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: falseThe name of the receipt rule set to make active. Setting this value to null disables all email receiving.
- On success, responds with
SetActiveReceiptRuleSetOutput
- On failure, responds with
SdkError<SetActiveReceiptRuleSetError>
Source§impl Client
impl Client
Sourcepub fn set_identity_dkim_enabled(&self) -> SetIdentityDkimEnabledFluentBuilder
pub fn set_identity_dkim_enabled(&self) -> SetIdentityDkimEnabledFluentBuilder
Constructs a fluent builder for the SetIdentityDkimEnabled
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity for which DKIM signing should be enabled or disabled.
dkim_enabled(bool)
/set_dkim_enabled(Option<bool>)
:
required: trueSets whether DKIM signing is enabled for an identity. Set to
true
to enable DKIM signing for this identity;false
to disable it.
- On success, responds with
SetIdentityDkimEnabledOutput
- On failure, responds with
SdkError<SetIdentityDkimEnabledError>
Source§impl Client
impl Client
Sourcepub fn set_identity_feedback_forwarding_enabled(
&self,
) -> SetIdentityFeedbackForwardingEnabledFluentBuilder
pub fn set_identity_feedback_forwarding_enabled( &self, ) -> SetIdentityFeedbackForwardingEnabledFluentBuilder
Constructs a fluent builder for the SetIdentityFeedbackForwardingEnabled
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity for which to set bounce and complaint notification forwarding. Examples:
user@example.com
,example.com
.forwarding_enabled(bool)
/set_forwarding_enabled(Option<bool>)
:
required: trueSets whether Amazon SES forwards bounce and complaint notifications as email.
true
specifies that Amazon SES forwards bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified.false
specifies that Amazon SES publishes bounce and complaint notifications only through Amazon SNS. This value can only be set tofalse
when Amazon SNS topics are set for bothBounce
andComplaint
notification types.
- On success, responds with
SetIdentityFeedbackForwardingEnabledOutput
- On failure, responds with
SdkError<SetIdentityFeedbackForwardingEnabledError>
Source§impl Client
impl Client
Sourcepub fn set_identity_headers_in_notifications_enabled(
&self,
) -> SetIdentityHeadersInNotificationsEnabledFluentBuilder
pub fn set_identity_headers_in_notifications_enabled( &self, ) -> SetIdentityHeadersInNotificationsEnabledFluentBuilder
Constructs a fluent builder for the SetIdentityHeadersInNotificationsEnabled
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity for which to enable or disable headers in notifications. Examples:
user@example.com
,example.com
.notification_type(NotificationType)
/set_notification_type(Option<NotificationType>)
:
required: trueThe notification type for which to enable or disable headers in notifications.
enabled(bool)
/set_enabled(Option<bool>)
:
required: trueSets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of
true
specifies that Amazon SES includes headers in notifications, and a value offalse
specifies that Amazon SES does not include headers in notifications.This value can only be set when
NotificationType
is already set to use a particular Amazon SNS topic.
- On success, responds with
SetIdentityHeadersInNotificationsEnabledOutput
- On failure, responds with
SdkError<SetIdentityHeadersInNotificationsEnabledError>
Source§impl Client
impl Client
Sourcepub fn set_identity_mail_from_domain(
&self,
) -> SetIdentityMailFromDomainFluentBuilder
pub fn set_identity_mail_from_domain( &self, ) -> SetIdentityMailFromDomainFluentBuilder
Constructs a fluent builder for the SetIdentityMailFromDomain
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe verified identity.
mail_from_domain(impl Into<String>)
/set_mail_from_domain(Option<String>)
:
required: falseThe custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a “From” address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of
null
disables the custom MAIL FROM setting for the identity.behavior_on_mx_failure(BehaviorOnMxFailure)
/set_behavior_on_mx_failure(Option<BehaviorOnMxFailure>)
:
required: falseThe action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you chooseRejectMessage
, Amazon SES returns aMailFromDomainNotVerified
error and not send the email.The action specified in
BehaviorOnMXFailure
is taken when the custom MAIL FROM domain setup is in thePending
,Failed
, andTemporaryFailure
states.
- On success, responds with
SetIdentityMailFromDomainOutput
- On failure, responds with
SdkError<SetIdentityMailFromDomainError>
Source§impl Client
impl Client
Sourcepub fn set_identity_notification_topic(
&self,
) -> SetIdentityNotificationTopicFluentBuilder
pub fn set_identity_notification_topic( &self, ) -> SetIdentityNotificationTopicFluentBuilder
Constructs a fluent builder for the SetIdentityNotificationTopic
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:
required: trueThe identity (email address or domain) for the Amazon SNS topic.
You can only specify a verified identity for this parameter.
You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities:
sender@example.com
,example.com
,arn:aws:ses:us-east-1:123456789012:identity/example.com
.notification_type(NotificationType)
/set_notification_type(Option<NotificationType>)
:
required: trueThe type of notifications that are published to the specified Amazon SNS topic.
sns_topic(impl Into<String>)
/set_sns_topic(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed,
SnsTopic
is cleared and publishing is disabled.
- On success, responds with
SetIdentityNotificationTopicOutput
- On failure, responds with
SdkError<SetIdentityNotificationTopicError>
Source§impl Client
impl Client
Sourcepub fn set_receipt_rule_position(&self) -> SetReceiptRulePositionFluentBuilder
pub fn set_receipt_rule_position(&self) -> SetReceiptRulePositionFluentBuilder
Constructs a fluent builder for the SetReceiptRulePosition
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the receipt rule set that contains the receipt rule to reposition.
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:
required: trueThe name of the receipt rule to reposition.
after(impl Into<String>)
/set_after(Option<String>)
:
required: falseThe name of the receipt rule after which to place the specified receipt rule.
- On success, responds with
SetReceiptRulePositionOutput
- On failure, responds with
SdkError<SetReceiptRulePositionError>
Source§impl Client
impl Client
Sourcepub fn test_render_template(&self) -> TestRenderTemplateFluentBuilder
pub fn test_render_template(&self) -> TestRenderTemplateFluentBuilder
Constructs a fluent builder for the TestRenderTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the template to render.
template_data(impl Into<String>)
/set_template_data(Option<String>)
:
required: trueA 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.
- On success, responds with
TestRenderTemplateOutput
with field(s):rendered_template(Option<String>)
:The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.
- On failure, responds with
SdkError<TestRenderTemplateError>
Source§impl Client
impl Client
Sourcepub fn update_account_sending_enabled(
&self,
) -> UpdateAccountSendingEnabledFluentBuilder
pub fn update_account_sending_enabled( &self, ) -> UpdateAccountSendingEnabledFluentBuilder
Constructs a fluent builder for the UpdateAccountSendingEnabled
operation.
- The fluent builder is configurable:
enabled(bool)
/set_enabled(Option<bool>)
:
required: falseDescribes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.
- On success, responds with
UpdateAccountSendingEnabledOutput
- On failure, responds with
SdkError<UpdateAccountSendingEnabledError>
Source§impl Client
impl Client
Sourcepub fn update_configuration_set_event_destination(
&self,
) -> UpdateConfigurationSetEventDestinationFluentBuilder
pub fn update_configuration_set_event_destination( &self, ) -> UpdateConfigurationSetEventDestinationFluentBuilder
Constructs a fluent builder for the UpdateConfigurationSetEventDestination
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set that contains the event destination.
event_destination(EventDestination)
/set_event_destination(Option<EventDestination>)
:
required: trueThe event destination object.
- On success, responds with
UpdateConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<UpdateConfigurationSetEventDestinationError>
Source§impl Client
impl Client
Sourcepub fn update_configuration_set_reputation_metrics_enabled(
&self,
) -> UpdateConfigurationSetReputationMetricsEnabledFluentBuilder
pub fn update_configuration_set_reputation_metrics_enabled( &self, ) -> UpdateConfigurationSetReputationMetricsEnabledFluentBuilder
Constructs a fluent builder for the UpdateConfigurationSetReputationMetricsEnabled
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set to update.
enabled(bool)
/set_enabled(Option<bool>)
:
required: trueDescribes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
- On success, responds with
UpdateConfigurationSetReputationMetricsEnabledOutput
- On failure, responds with
SdkError<UpdateConfigurationSetReputationMetricsEnabledError>
Source§impl Client
impl Client
Sourcepub fn update_configuration_set_sending_enabled(
&self,
) -> UpdateConfigurationSetSendingEnabledFluentBuilder
pub fn update_configuration_set_sending_enabled( &self, ) -> UpdateConfigurationSetSendingEnabledFluentBuilder
Constructs a fluent builder for the UpdateConfigurationSetSendingEnabled
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set to update.
enabled(bool)
/set_enabled(Option<bool>)
:
required: trueDescribes whether email sending is enabled or disabled for the configuration set.
- On success, responds with
UpdateConfigurationSetSendingEnabledOutput
- On failure, responds with
SdkError<UpdateConfigurationSetSendingEnabledError>
Source§impl Client
impl Client
Sourcepub fn update_configuration_set_tracking_options(
&self,
) -> UpdateConfigurationSetTrackingOptionsFluentBuilder
pub fn update_configuration_set_tracking_options( &self, ) -> UpdateConfigurationSetTrackingOptionsFluentBuilder
Constructs a fluent builder for the UpdateConfigurationSetTrackingOptions
operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:
required: trueThe name of the configuration set.
tracking_options(TrackingOptions)
/set_tracking_options(Option<TrackingOptions>)
:
required: trueA domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
- On success, responds with
UpdateConfigurationSetTrackingOptionsOutput
- On failure, responds with
SdkError<UpdateConfigurationSetTrackingOptionsError>
Source§impl Client
impl Client
Sourcepub fn update_custom_verification_email_template(
&self,
) -> UpdateCustomVerificationEmailTemplateFluentBuilder
pub fn update_custom_verification_email_template( &self, ) -> UpdateCustomVerificationEmailTemplateFluentBuilder
Constructs a fluent builder for the UpdateCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the custom verification email template to update.
from_email_address(impl Into<String>)
/set_from_email_address(Option<String>)
:
required: falseThe email address that the custom verification email is sent from.
template_subject(impl Into<String>)
/set_template_subject(Option<String>)
:
required: falseThe subject line of the custom verification email.
template_content(impl Into<String>)
/set_template_content(Option<String>)
:
required: falseThe content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
success_redirection_url(impl Into<String>)
/set_success_redirection_url(Option<String>)
:
required: falseThe URL that the recipient of the verification email is sent to if his or her address is successfully verified.
failure_redirection_url(impl Into<String>)
/set_failure_redirection_url(Option<String>)
:
required: falseThe URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
- On success, responds with
UpdateCustomVerificationEmailTemplateOutput
- On failure, responds with
SdkError<UpdateCustomVerificationEmailTemplateError>
Source§impl Client
impl Client
Sourcepub fn update_receipt_rule(&self) -> UpdateReceiptRuleFluentBuilder
pub fn update_receipt_rule(&self) -> UpdateReceiptRuleFluentBuilder
Constructs a fluent builder for the UpdateReceiptRule
operation.
- The fluent builder is configurable:
rule_set_name(impl Into<String>)
/set_rule_set_name(Option<String>)
:
required: trueThe name of the receipt rule set that the receipt rule belongs to.
rule(ReceiptRule)
/set_rule(Option<ReceiptRule>)
:
required: trueA data structure that contains the updated receipt rule information.
- On success, responds with
UpdateReceiptRuleOutput
- On failure, responds with
SdkError<UpdateReceiptRuleError>
Source§impl Client
impl Client
Sourcepub fn update_template(&self) -> UpdateTemplateFluentBuilder
pub fn update_template(&self) -> UpdateTemplateFluentBuilder
Constructs a fluent builder for the UpdateTemplate
operation.
- The fluent builder is configurable:
template(Template)
/set_template(Option<Template>)
:
required: trueThe content of the email, composed of a subject line and either an HTML part or a text-only part.
- On success, responds with
UpdateTemplateOutput
- On failure, responds with
SdkError<UpdateTemplateError>
Source§impl Client
impl Client
Sourcepub fn verify_domain_dkim(&self) -> VerifyDomainDkimFluentBuilder
pub fn verify_domain_dkim(&self) -> VerifyDomainDkimFluentBuilder
Constructs a fluent builder for the VerifyDomainDkim
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain to be verified for Easy DKIM signing.
- On success, responds with
VerifyDomainDkimOutput
with field(s):dkim_tokens(Vec::<String>)
:A set of character strings that represent the domain’s identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you’ve updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
- On failure, responds with
SdkError<VerifyDomainDkimError>
Source§impl Client
impl Client
Sourcepub fn verify_domain_identity(&self) -> VerifyDomainIdentityFluentBuilder
pub fn verify_domain_identity(&self) -> VerifyDomainIdentityFluentBuilder
Constructs a fluent builder for the VerifyDomainIdentity
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe domain to be verified.
- On success, responds with
VerifyDomainIdentityOutput
with field(s):verification_token(String)
:A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.
As Amazon SES searches for the TXT record, the domain’s verification status is “Pending”. When Amazon SES detects the record, the domain’s verification status changes to “Success”. If Amazon SES is unable to detect the record within 72 hours, the domain’s verification status changes to “Failed.” In that case, to verify the domain, you must restart the verification process from the beginning. The domain’s verification status also changes to “Success” when it is DKIM verified.
- On failure, responds with
SdkError<VerifyDomainIdentityError>
Source§impl Client
impl Client
Sourcepub fn verify_email_address(&self) -> VerifyEmailAddressFluentBuilder
pub fn verify_email_address(&self) -> VerifyEmailAddressFluentBuilder
Constructs a fluent builder for the VerifyEmailAddress
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:
required: trueThe email address to be verified.
- On success, responds with
VerifyEmailAddressOutput
- On failure, responds with
SdkError<VerifyEmailAddressError>
Source§impl Client
impl Client
Sourcepub fn verify_email_identity(&self) -> VerifyEmailIdentityFluentBuilder
pub fn verify_email_identity(&self) -> VerifyEmailIdentityFluentBuilder
Constructs a fluent builder for the VerifyEmailIdentity
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:
required: trueThe email address to be verified.
- On success, responds with
VerifyEmailIdentityOutput
- On failure, responds with
SdkError<VerifyEmailIdentityError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_identity_exists(&self) -> IdentityExistsFluentBuilder
fn wait_until_identity_exists(&self) -> IdentityExistsFluentBuilder
identity_exists
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
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);