Struct aws_sdk_ses::Client
source · [−]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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_ses::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_ses::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_ses::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn clone_receipt_rule_set(&self) -> CloneReceiptRuleSet
pub fn clone_receipt_rule_set(&self) -> CloneReceiptRuleSet
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>)
:The name of the rule set to create. The name must:
-
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
-
Start and end with a letter or number.
-
Contain less than 64 characters.
-
original_rule_set_name(impl Into<String>)
/set_original_rule_set_name(Option<String>)
:The name of the rule set to clone.
- On success, responds with
CloneReceiptRuleSetOutput
- On failure, responds with
SdkError<CloneReceiptRuleSetError>
sourcepub fn create_configuration_set(&self) -> CreateConfigurationSet
pub fn create_configuration_set(&self) -> CreateConfigurationSet
Constructs a fluent builder for the CreateConfigurationSet
operation.
- The fluent builder is configurable:
configuration_set(ConfigurationSet)
/set_configuration_set(Option<ConfigurationSet>)
:A data structure that contains the name of the configuration set.
- On success, responds with
CreateConfigurationSetOutput
- On failure, responds with
SdkError<CreateConfigurationSetError>
sourcepub fn create_configuration_set_event_destination(
&self
) -> CreateConfigurationSetEventDestination
pub fn create_configuration_set_event_destination(
&self
) -> CreateConfigurationSetEventDestination
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>)
:The name of the configuration set that the event destination should be associated with.
event_destination(EventDestination)
/set_event_destination(Option<EventDestination>)
:An object that describes the AWS service that email sending event information will be published to.
- On success, responds with
CreateConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<CreateConfigurationSetEventDestinationError>
sourcepub fn create_configuration_set_tracking_options(
&self
) -> CreateConfigurationSetTrackingOptions
pub fn create_configuration_set_tracking_options(
&self
) -> CreateConfigurationSetTrackingOptions
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>)
:The name of the configuration set that the tracking options should be associated with.
tracking_options(TrackingOptions)
/set_tracking_options(Option<TrackingOptions>)
:A 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>
sourcepub fn create_custom_verification_email_template(
&self
) -> CreateCustomVerificationEmailTemplate
pub fn create_custom_verification_email_template(
&self
) -> CreateCustomVerificationEmailTemplate
Constructs a fluent builder for the CreateCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the custom verification email template.
from_email_address(impl Into<String>)
/set_from_email_address(Option<String>)
:The email address that the custom verification email is sent from.
template_subject(impl Into<String>)
/set_template_subject(Option<String>)
:The subject line of the custom verification email.
template_content(impl Into<String>)
/set_template_content(Option<String>)
:The 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>)
:The 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>)
:The 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>
sourcepub fn create_receipt_filter(&self) -> CreateReceiptFilter
pub fn create_receipt_filter(&self) -> CreateReceiptFilter
Constructs a fluent builder for the CreateReceiptFilter
operation.
- The fluent builder is configurable:
filter(ReceiptFilter)
/set_filter(Option<ReceiptFilter>)
:A 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>
sourcepub fn create_receipt_rule(&self) -> CreateReceiptRule
pub fn create_receipt_rule(&self) -> CreateReceiptRule
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>)
:The name of the rule set that the receipt rule will be added to.
after(impl Into<String>)
/set_after(Option<String>)
:The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.
rule(ReceiptRule)
/set_rule(Option<ReceiptRule>)
:A 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>
sourcepub fn create_receipt_rule_set(&self) -> CreateReceiptRuleSet
pub fn create_receipt_rule_set(&self) -> CreateReceiptRuleSet
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>)
:The name of the rule set to create. The name must:
-
This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
-
Start and end with a letter or number.
-
Contain less than 64 characters.
-
- On success, responds with
CreateReceiptRuleSetOutput
- On failure, responds with
SdkError<CreateReceiptRuleSetError>
sourcepub fn create_template(&self) -> CreateTemplate
pub fn create_template(&self) -> CreateTemplate
Constructs a fluent builder for the CreateTemplate
operation.
- The fluent builder is configurable:
template(Template)
/set_template(Option<Template>)
:The content of the email, composed of a subject line, an HTML part, and a text-only part.
- On success, responds with
CreateTemplateOutput
- On failure, responds with
SdkError<CreateTemplateError>
sourcepub fn delete_configuration_set(&self) -> DeleteConfigurationSet
pub fn delete_configuration_set(&self) -> DeleteConfigurationSet
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>)
:The name of the configuration set to delete.
- On success, responds with
DeleteConfigurationSetOutput
- On failure, responds with
SdkError<DeleteConfigurationSetError>
sourcepub fn delete_configuration_set_event_destination(
&self
) -> DeleteConfigurationSetEventDestination
pub fn delete_configuration_set_event_destination(
&self
) -> DeleteConfigurationSetEventDestination
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>)
:The name of the configuration set from which to delete the event destination.
event_destination_name(impl Into<String>)
/set_event_destination_name(Option<String>)
:The name of the event destination to delete.
- On success, responds with
DeleteConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<DeleteConfigurationSetEventDestinationError>
sourcepub fn delete_configuration_set_tracking_options(
&self
) -> DeleteConfigurationSetTrackingOptions
pub fn delete_configuration_set_tracking_options(
&self
) -> DeleteConfigurationSetTrackingOptions
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>)
:The name of the configuration set from which you want to delete the tracking options.
- On success, responds with
DeleteConfigurationSetTrackingOptionsOutput
- On failure, responds with
SdkError<DeleteConfigurationSetTrackingOptionsError>
sourcepub fn delete_custom_verification_email_template(
&self
) -> DeleteCustomVerificationEmailTemplate
pub fn delete_custom_verification_email_template(
&self
) -> DeleteCustomVerificationEmailTemplate
Constructs a fluent builder for the DeleteCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the custom verification email template that you want to delete.
- On success, responds with
DeleteCustomVerificationEmailTemplateOutput
- On failure, responds with
SdkError<DeleteCustomVerificationEmailTemplateError>
sourcepub fn delete_identity(&self) -> DeleteIdentity
pub fn delete_identity(&self) -> DeleteIdentity
Constructs a fluent builder for the DeleteIdentity
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity to be removed from the list of identities for the AWS Account.
- On success, responds with
DeleteIdentityOutput
- On failure, responds with
SdkError<DeleteIdentityError>
sourcepub fn delete_identity_policy(&self) -> DeleteIdentityPolicy
pub fn delete_identity_policy(&self) -> DeleteIdentityPolicy
Constructs a fluent builder for the DeleteIdentityPolicy
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity that is associated with the policy that you want 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 API, you must own the identity.
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The name of the policy to be deleted.
- On success, responds with
DeleteIdentityPolicyOutput
- On failure, responds with
SdkError<DeleteIdentityPolicyError>
sourcepub fn delete_receipt_filter(&self) -> DeleteReceiptFilter
pub fn delete_receipt_filter(&self) -> DeleteReceiptFilter
Constructs a fluent builder for the DeleteReceiptFilter
operation.
- The fluent builder is configurable:
filter_name(impl Into<String>)
/set_filter_name(Option<String>)
:The name of the IP address filter to delete.
- On success, responds with
DeleteReceiptFilterOutput
- On failure, responds with
SdkError<DeleteReceiptFilterError>
sourcepub fn delete_receipt_rule(&self) -> DeleteReceiptRule
pub fn delete_receipt_rule(&self) -> DeleteReceiptRule
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>)
:The name of the receipt rule set that contains the receipt rule to delete.
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the receipt rule to delete.
- On success, responds with
DeleteReceiptRuleOutput
- On failure, responds with
SdkError<DeleteReceiptRuleError>
sourcepub fn delete_receipt_rule_set(&self) -> DeleteReceiptRuleSet
pub fn delete_receipt_rule_set(&self) -> DeleteReceiptRuleSet
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>)
:The name of the receipt rule set to delete.
- On success, responds with
DeleteReceiptRuleSetOutput
- On failure, responds with
SdkError<DeleteReceiptRuleSetError>
sourcepub fn delete_template(&self) -> DeleteTemplate
pub fn delete_template(&self) -> DeleteTemplate
Constructs a fluent builder for the DeleteTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the template to be deleted.
- On success, responds with
DeleteTemplateOutput
- On failure, responds with
SdkError<DeleteTemplateError>
sourcepub fn delete_verified_email_address(&self) -> DeleteVerifiedEmailAddress
pub fn delete_verified_email_address(&self) -> DeleteVerifiedEmailAddress
Constructs a fluent builder for the DeleteVerifiedEmailAddress
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:An email address to be removed from the list of verified addresses.
- On success, responds with
DeleteVerifiedEmailAddressOutput
- On failure, responds with
SdkError<DeleteVerifiedEmailAddressError>
sourcepub fn describe_active_receipt_rule_set(&self) -> DescribeActiveReceiptRuleSet
pub fn describe_active_receipt_rule_set(&self) -> DescribeActiveReceiptRuleSet
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>
sourcepub fn describe_configuration_set(&self) -> DescribeConfigurationSet
pub fn describe_configuration_set(&self) -> DescribeConfigurationSet
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>)
:The name of the configuration set to describe.
configuration_set_attribute_names(Vec<ConfigurationSetAttribute>)
/set_configuration_set_attribute_names(Option<Vec<ConfigurationSetAttribute>>)
:A 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>
sourcepub fn describe_receipt_rule(&self) -> DescribeReceiptRule
pub fn describe_receipt_rule(&self) -> DescribeReceiptRule
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>)
:The name of the receipt rule set that the receipt rule belongs to.
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The 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>
sourcepub fn describe_receipt_rule_set(&self) -> DescribeReceiptRuleSet
pub fn describe_receipt_rule_set(&self) -> DescribeReceiptRuleSet
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>)
:The 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>
sourcepub fn get_account_sending_enabled(&self) -> GetAccountSendingEnabled
pub fn get_account_sending_enabled(&self) -> GetAccountSendingEnabled
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 AWS Region.
- On failure, responds with
SdkError<GetAccountSendingEnabledError>
sourcepub fn get_custom_verification_email_template(
&self
) -> GetCustomVerificationEmailTemplate
pub fn get_custom_verification_email_template(
&self
) -> GetCustomVerificationEmailTemplate
Constructs a fluent builder for the GetCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the custom verification email template that you want 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>
sourcepub fn get_identity_dkim_attributes(&self) -> GetIdentityDkimAttributes
pub fn get_identity_dkim_attributes(&self) -> GetIdentityDkimAttributes
Constructs a fluent builder for the GetIdentityDkimAttributes
operation.
- The fluent builder is configurable:
identities(Vec<String>)
/set_identities(Option<Vec<String>>)
:A list of one or more verified identities - email addresses, domains, or both.
- On success, responds with
GetIdentityDkimAttributesOutput
with field(s):dkim_attributes(Option<HashMap<String, IdentityDkimAttributes>>)
:The DKIM attributes for an email address or a domain.
- On failure, responds with
SdkError<GetIdentityDkimAttributesError>
sourcepub fn get_identity_mail_from_domain_attributes(
&self
) -> GetIdentityMailFromDomainAttributes
pub fn get_identity_mail_from_domain_attributes(
&self
) -> GetIdentityMailFromDomainAttributes
Constructs a fluent builder for the GetIdentityMailFromDomainAttributes
operation.
- The fluent builder is configurable:
identities(Vec<String>)
/set_identities(Option<Vec<String>>)
:A list of one or more identities.
- On success, responds with
GetIdentityMailFromDomainAttributesOutput
with field(s):mail_from_domain_attributes(Option<HashMap<String, IdentityMailFromDomainAttributes>>)
:A map of identities to custom MAIL FROM attributes.
- On failure, responds with
SdkError<GetIdentityMailFromDomainAttributesError>
sourcepub fn get_identity_notification_attributes(
&self
) -> GetIdentityNotificationAttributes
pub fn get_identity_notification_attributes(
&self
) -> GetIdentityNotificationAttributes
Constructs a fluent builder for the GetIdentityNotificationAttributes
operation.
- The fluent builder is configurable:
identities(Vec<String>)
/set_identities(Option<Vec<String>>)
:A 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(Option<HashMap<String, IdentityNotificationAttributes>>)
:A map of Identity to IdentityNotificationAttributes.
- On failure, responds with
SdkError<GetIdentityNotificationAttributesError>
sourcepub fn get_identity_policies(&self) -> GetIdentityPolicies
pub fn get_identity_policies(&self) -> GetIdentityPolicies
Constructs a fluent builder for the GetIdentityPolicies
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity for which the policies will be 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 API, you must own the identity.
policy_names(Vec<String>)
/set_policy_names(Option<Vec<String>>)
:A 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(Option<HashMap<String, String>>)
:A map of policy names to policies.
- On failure, responds with
SdkError<GetIdentityPoliciesError>
sourcepub fn get_identity_verification_attributes(
&self
) -> GetIdentityVerificationAttributes
pub fn get_identity_verification_attributes(
&self
) -> GetIdentityVerificationAttributes
Constructs a fluent builder for the GetIdentityVerificationAttributes
operation.
- The fluent builder is configurable:
identities(Vec<String>)
/set_identities(Option<Vec<String>>)
:A list of identities.
- On success, responds with
GetIdentityVerificationAttributesOutput
with field(s):verification_attributes(Option<HashMap<String, IdentityVerificationAttributes>>)
:A map of Identities to IdentityVerificationAttributes objects.
- On failure, responds with
SdkError<GetIdentityVerificationAttributesError>
sourcepub fn get_send_quota(&self) -> GetSendQuota
pub fn get_send_quota(&self) -> GetSendQuota
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>
sourcepub fn get_send_statistics(&self) -> GetSendStatistics
pub fn get_send_statistics(&self) -> GetSendStatistics
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>
sourcepub fn get_template(&self) -> GetTemplate
pub fn get_template(&self) -> GetTemplate
Constructs a fluent builder for the GetTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the template you want to retrieve.
- On success, responds with
GetTemplateOutput
with field(s):template(Option<Template>)
:The content of the email, composed of a subject line, an HTML part, and a text-only part.
- On failure, responds with
SdkError<GetTemplateError>
sourcepub fn list_configuration_sets(&self) -> ListConfigurationSets
pub fn list_configuration_sets(&self) -> ListConfigurationSets
Constructs a fluent builder for the ListConfigurationSets
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A 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>)
:The 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>
sourcepub fn list_custom_verification_email_templates(
&self
) -> ListCustomVerificationEmailTemplates
pub fn list_custom_verification_email_templates(
&self
) -> ListCustomVerificationEmailTemplates
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>)
:An 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>)
:The 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 will return 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>
sourcepub fn list_identities(&self) -> ListIdentities
pub fn list_identities(&self) -> ListIdentities
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>)
:The type of the identities to list. Possible values are “EmailAddress” and “Domain”. If this parameter is omitted, then all identities will be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use for pagination.
max_items(i32)
/set_max_items(Option<i32>)
:The maximum number of identities per page. Possible values are 1-1000 inclusive.
- On success, responds with
ListIdentitiesOutput
with field(s):identities(Option<Vec<String>>)
:A list of identities.
next_token(Option<String>)
:The token used for pagination.
- On failure, responds with
SdkError<ListIdentitiesError>
sourcepub fn list_identity_policies(&self) -> ListIdentityPolicies
pub fn list_identity_policies(&self) -> ListIdentityPolicies
Constructs a fluent builder for the ListIdentityPolicies
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity that is associated with the policy for which the policies will be 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 API, you must own the identity.
- On success, responds with
ListIdentityPoliciesOutput
with field(s):policy_names(Option<Vec<String>>)
:A list of names of policies that apply to the specified identity.
- On failure, responds with
SdkError<ListIdentityPoliciesError>
sourcepub fn list_receipt_filters(&self) -> ListReceiptFilters
pub fn list_receipt_filters(&self) -> ListReceiptFilters
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>
sourcepub fn list_receipt_rule_sets(&self) -> ListReceiptRuleSets
pub fn list_receipt_rule_sets(&self) -> ListReceiptRuleSets
Constructs a fluent builder for the ListReceiptRuleSets
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A 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>
sourcepub fn list_templates(&self) -> ListTemplates
pub fn list_templates(&self) -> ListTemplates
Constructs a fluent builder for the ListTemplates
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A 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>)
:The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.
- 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 50 email templates.
- On failure, responds with
SdkError<ListTemplatesError>
sourcepub fn list_verified_email_addresses(&self) -> ListVerifiedEmailAddresses
pub fn list_verified_email_addresses(&self) -> ListVerifiedEmailAddresses
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>
sourcepub fn put_configuration_set_delivery_options(
&self
) -> PutConfigurationSetDeliveryOptions
pub fn put_configuration_set_delivery_options(
&self
) -> PutConfigurationSetDeliveryOptions
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>)
:The name of the configuration set that you want to specify the delivery options for.
delivery_options(DeliveryOptions)
/set_delivery_options(Option<DeliveryOptions>)
:Specifies 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>
sourcepub fn put_identity_policy(&self) -> PutIdentityPolicy
pub fn put_identity_policy(&self) -> PutIdentityPolicy
Constructs a fluent builder for the PutIdentityPolicy
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity that the policy will apply to. 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 API, you must own the identity.
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The 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>)
:The 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>
sourcepub fn reorder_receipt_rule_set(&self) -> ReorderReceiptRuleSet
pub fn reorder_receipt_rule_set(&self) -> ReorderReceiptRuleSet
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>)
:The name of the receipt rule set to reorder.
rule_names(Vec<String>)
/set_rule_names(Option<Vec<String>>)
:A list of the specified receipt rule set’s receipt rules in the order that you want to put them.
- On success, responds with
ReorderReceiptRuleSetOutput
- On failure, responds with
SdkError<ReorderReceiptRuleSetError>
sourcepub fn send_bounce(&self) -> SendBounce
pub fn send_bounce(&self) -> SendBounce
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>)
:The message ID of the message to be bounced.
bounce_sender(impl Into<String>)
/set_bounce_sender(Option<String>)
:The 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>)
:Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.
message_dsn(MessageDsn)
/set_message_dsn(Option<MessageDsn>)
:Message-related DSN fields. If not specified, Amazon SES will choose the values.
bounced_recipient_info_list(Vec<BouncedRecipientInfo>)
/set_bounced_recipient_info_list(Option<Vec<BouncedRecipientInfo>>)
:A 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the 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>
sourcepub fn send_bulk_templated_email(&self) -> SendBulkTemplatedEmail
pub fn send_bulk_templated_email(&self) -> SendBulkTemplatedEmail
Constructs a fluent builder for the SendBulkTemplatedEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the
SourceArn
parameter. For more information about sending authorization, see the Amazon SES Developer Guide.Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the
Source
parameter.For example, if the owner of
example.com
(which has 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(Vec<String>)
/set_reply_to_addresses(Option<Vec<String>>)
:The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
return_path(impl Into<String>)
/set_return_path(Option<String>)
:The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient’s ISP; this message will then be forwarded to the email address specified by the
ReturnPath
parameter. 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the
ReturnPath
parameter.For example, if the owner of
example.com
(which has 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>)
:The name of the configuration set to use when you send an email using
SendBulkTemplatedEmail
.default_tags(Vec<MessageTag>)
/set_default_tags(Option<Vec<MessageTag>>)
:A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using
SendBulkTemplatedEmail
.template(impl Into<String>)
/set_template(Option<String>)
:The template to use when sending this email.
template_arn(impl Into<String>)
/set_template_arn(Option<String>)
:The ARN of the template to use when sending this email.
default_template_data(impl Into<String>)
/set_default_template_data(Option<String>)
:A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.
The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
destinations(Vec<BulkEmailDestination>)
/set_destinations(Option<Vec<BulkEmailDestination>>)
:One or more
Destination
objects. All of the recipients in aDestination
will 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(Option<Vec<BulkEmailDestinationStatus>>)
:The unique message identifier returned from the
SendBulkTemplatedEmail
action.
- On failure, responds with
SdkError<SendBulkTemplatedEmailError>
sourcepub fn send_custom_verification_email(&self) -> SendCustomVerificationEmail
pub fn send_custom_verification_email(&self) -> SendCustomVerificationEmail
Constructs a fluent builder for the SendCustomVerificationEmail
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:The email address to verify.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The 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>)
:Name 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>
sourcepub fn send_email(&self) -> SendEmail
pub fn send_email(&self) -> SendEmail
Constructs a fluent builder for the SendEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the
SourceArn
parameter. For more information about sending authorization, see the Amazon SES Developer Guide.Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.destination(Destination)
/set_destination(Option<Destination>)
:The destination for this email, composed of To:, CC:, and BCC: fields.
message(Message)
/set_message(Option<Message>)
:The message to be sent.
reply_to_addresses(Vec<String>)
/set_reply_to_addresses(Option<Vec<String>>)
:The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
return_path(impl Into<String>)
/set_return_path(Option<String>)
:The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient’s ISP; this message will then be forwarded to the email address specified by the
ReturnPath
parameter. 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the
Source
parameter.For example, if the owner of
example.com
(which has 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the
ReturnPath
parameter.For example, if the owner of
example.com
(which has 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(Vec<MessageTag>)
/set_tags(Option<Vec<MessageTag>>)
:A 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>)
:The name of the configuration set to use when you send an email using
SendEmail
.
- On success, responds with
SendEmailOutput
with field(s):message_id(Option<String>)
:The unique message identifier returned from the
SendEmail
action.
- On failure, responds with
SdkError<SendEmailError>
sourcepub fn send_raw_email(&self) -> SendRawEmail
pub fn send_raw_email(&self) -> SendRawEmail
Constructs a fluent builder for the SendRawEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:The 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 local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.If you specify the
Source
parameter and have feedback forwarding enabled, then bounces and complaints will be 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(Vec<String>)
/set_destinations(Option<Vec<String>>)
:A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
raw_message(RawMessage)
/set_raw_message(Option<RawMessage>)
:The 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the
Source
parameter.For example, if the owner of
example.com
(which has 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the
ReturnPath
parameter.For example, if the owner of
example.com
(which has 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(Vec<MessageTag>)
/set_tags(Option<Vec<MessageTag>>)
:A 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>)
:The name of the configuration set to use when you send an email using
SendRawEmail
.
- On success, responds with
SendRawEmailOutput
with field(s):message_id(Option<String>)
:The unique message identifier returned from the
SendRawEmail
action.
- On failure, responds with
SdkError<SendRawEmailError>
sourcepub fn send_templated_email(&self) -> SendTemplatedEmail
pub fn send_templated_email(&self) -> SendTemplatedEmail
Constructs a fluent builder for the SendTemplatedEmail
operation.
- The fluent builder is configurable:
source(impl Into<String>)
/set_source(Option<String>)
:The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the
SourceArn
parameter. For more information about sending authorization, see the Amazon SES Developer Guide.Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
.destination(Destination)
/set_destination(Option<Destination>)
:The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
reply_to_addresses(Vec<String>)
/set_reply_to_addresses(Option<Vec<String>>)
:The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
return_path(impl Into<String>)
/set_return_path(Option<String>)
:The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient’s ISP; this message will then be forwarded to the email address specified by the
ReturnPath
parameter. 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the
Source
parameter.For example, if the owner of
example.com
(which has 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>)
:This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the
ReturnPath
parameter.For example, if the owner of
example.com
(which has 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(Vec<MessageTag>)
/set_tags(Option<Vec<MessageTag>>)
:A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendTemplatedEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.configuration_set_name(impl Into<String>)
/set_configuration_set_name(Option<String>)
:The name of the configuration set to use when you send an email using
SendTemplatedEmail
.template(impl Into<String>)
/set_template(Option<String>)
:The template to use when sending this email.
template_arn(impl Into<String>)
/set_template_arn(Option<String>)
:The ARN of the template to use when sending this email.
template_data(impl Into<String>)
/set_template_data(Option<String>)
:A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
- On success, responds with
SendTemplatedEmailOutput
with field(s):message_id(Option<String>)
:The unique message identifier returned from the
SendTemplatedEmail
action.
- On failure, responds with
SdkError<SendTemplatedEmailError>
sourcepub fn set_active_receipt_rule_set(&self) -> SetActiveReceiptRuleSet
pub fn set_active_receipt_rule_set(&self) -> SetActiveReceiptRuleSet
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>)
:The 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>
sourcepub fn set_identity_dkim_enabled(&self) -> SetIdentityDkimEnabled
pub fn set_identity_dkim_enabled(&self) -> SetIdentityDkimEnabled
Constructs a fluent builder for the SetIdentityDkimEnabled
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity for which DKIM signing should be enabled or disabled.
dkim_enabled(bool)
/set_dkim_enabled(bool)
:Sets 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>
sourcepub fn set_identity_feedback_forwarding_enabled(
&self
) -> SetIdentityFeedbackForwardingEnabled
pub fn set_identity_feedback_forwarding_enabled(
&self
) -> SetIdentityFeedbackForwardingEnabled
Constructs a fluent builder for the SetIdentityFeedbackForwardingEnabled
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity for which to set bounce and complaint notification forwarding. Examples:
user@example.com
,example.com
.forwarding_enabled(bool)
/set_forwarding_enabled(bool)
:Sets whether Amazon SES will forward bounce and complaint notifications as email.
true
specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified.false
specifies that Amazon SES will publish 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>
sourcepub fn set_identity_headers_in_notifications_enabled(
&self
) -> SetIdentityHeadersInNotificationsEnabled
pub fn set_identity_headers_in_notifications_enabled(
&self
) -> SetIdentityHeadersInNotificationsEnabled
Constructs a fluent builder for the SetIdentityHeadersInNotificationsEnabled
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity for which to enable or disable headers in notifications. Examples:
user@example.com
,example.com
.notification_type(NotificationType)
/set_notification_type(Option<NotificationType>)
:The notification type for which to enable or disable headers in notifications.
enabled(bool)
/set_enabled(bool)
:Sets 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 will include headers in notifications, and a value offalse
specifies that Amazon SES will 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>
sourcepub fn set_identity_mail_from_domain(&self) -> SetIdentityMailFromDomain
pub fn set_identity_mail_from_domain(&self) -> SetIdentityMailFromDomain
Constructs a fluent builder for the SetIdentityMailFromDomain
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
mail_from_domain(impl Into<String>)
/set_mail_from_domain(Option<String>)
:The custom MAIL FROM domain that you want 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>)
:The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you chooseRejectMessage
, Amazon SES will return 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>
sourcepub fn set_identity_notification_topic(&self) -> SetIdentityNotificationTopic
pub fn set_identity_notification_topic(&self) -> SetIdentityNotificationTopic
Constructs a fluent builder for the SetIdentityNotificationTopic
operation.
- The fluent builder is configurable:
identity(impl Into<String>)
/set_identity(Option<String>)
:The identity (email address or domain) that you want to set the Amazon SNS topic for.
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>)
:The type of notifications that will be published to the specified Amazon SNS topic.
sns_topic(impl Into<String>)
/set_sns_topic(Option<String>)
:The 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>
sourcepub fn set_receipt_rule_position(&self) -> SetReceiptRulePosition
pub fn set_receipt_rule_position(&self) -> SetReceiptRulePosition
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>)
:The name of the receipt rule set that contains the receipt rule to reposition.
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the receipt rule to reposition.
after(impl Into<String>)
/set_after(Option<String>)
:The name of the receipt rule after which to place the specified receipt rule.
- On success, responds with
SetReceiptRulePositionOutput
- On failure, responds with
SdkError<SetReceiptRulePositionError>
sourcepub fn test_render_template(&self) -> TestRenderTemplate
pub fn test_render_template(&self) -> TestRenderTemplate
Constructs a fluent builder for the TestRenderTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the template that you want to render.
template_data(impl Into<String>)
/set_template_data(Option<String>)
:A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
- 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>
sourcepub fn update_account_sending_enabled(&self) -> UpdateAccountSendingEnabled
pub fn update_account_sending_enabled(&self) -> UpdateAccountSendingEnabled
Constructs a fluent builder for the UpdateAccountSendingEnabled
operation.
- The fluent builder is configurable:
enabled(bool)
/set_enabled(bool)
:Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.
- On success, responds with
UpdateAccountSendingEnabledOutput
- On failure, responds with
SdkError<UpdateAccountSendingEnabledError>
sourcepub fn update_configuration_set_event_destination(
&self
) -> UpdateConfigurationSetEventDestination
pub fn update_configuration_set_event_destination(
&self
) -> UpdateConfigurationSetEventDestination
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>)
:The name of the configuration set that contains the event destination that you want to update.
event_destination(EventDestination)
/set_event_destination(Option<EventDestination>)
:The event destination object that you want to apply to the specified configuration set.
- On success, responds with
UpdateConfigurationSetEventDestinationOutput
- On failure, responds with
SdkError<UpdateConfigurationSetEventDestinationError>
sourcepub fn update_configuration_set_reputation_metrics_enabled(
&self
) -> UpdateConfigurationSetReputationMetricsEnabled
pub fn update_configuration_set_reputation_metrics_enabled(
&self
) -> UpdateConfigurationSetReputationMetricsEnabled
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>)
:The name of the configuration set that you want to update.
enabled(bool)
/set_enabled(bool)
:Describes whether or not Amazon SES will publish 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>
sourcepub fn update_configuration_set_sending_enabled(
&self
) -> UpdateConfigurationSetSendingEnabled
pub fn update_configuration_set_sending_enabled(
&self
) -> UpdateConfigurationSetSendingEnabled
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>)
:The name of the configuration set that you want to update.
enabled(bool)
/set_enabled(bool)
:Describes whether email sending is enabled or disabled for the configuration set.
- On success, responds with
UpdateConfigurationSetSendingEnabledOutput
- On failure, responds with
SdkError<UpdateConfigurationSetSendingEnabledError>
sourcepub fn update_configuration_set_tracking_options(
&self
) -> UpdateConfigurationSetTrackingOptions
pub fn update_configuration_set_tracking_options(
&self
) -> UpdateConfigurationSetTrackingOptions
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>)
:The name of the configuration set for which you want to update the custom tracking domain.
tracking_options(TrackingOptions)
/set_tracking_options(Option<TrackingOptions>)
:A 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>
sourcepub fn update_custom_verification_email_template(
&self
) -> UpdateCustomVerificationEmailTemplate
pub fn update_custom_verification_email_template(
&self
) -> UpdateCustomVerificationEmailTemplate
Constructs a fluent builder for the UpdateCustomVerificationEmailTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the custom verification email template that you want to update.
from_email_address(impl Into<String>)
/set_from_email_address(Option<String>)
:The email address that the custom verification email is sent from.
template_subject(impl Into<String>)
/set_template_subject(Option<String>)
:The subject line of the custom verification email.
template_content(impl Into<String>)
/set_template_content(Option<String>)
:The 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>)
:The 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>)
:The 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>
sourcepub fn update_receipt_rule(&self) -> UpdateReceiptRule
pub fn update_receipt_rule(&self) -> UpdateReceiptRule
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>)
:The name of the receipt rule set that the receipt rule belongs to.
rule(ReceiptRule)
/set_rule(Option<ReceiptRule>)
:A data structure that contains the updated receipt rule information.
- On success, responds with
UpdateReceiptRuleOutput
- On failure, responds with
SdkError<UpdateReceiptRuleError>
sourcepub fn update_template(&self) -> UpdateTemplate
pub fn update_template(&self) -> UpdateTemplate
Constructs a fluent builder for the UpdateTemplate
operation.
- The fluent builder is configurable:
template(Template)
/set_template(Option<Template>)
:The content of the email, composed of a subject line, an HTML part, and a text-only part.
- On success, responds with
UpdateTemplateOutput
- On failure, responds with
SdkError<UpdateTemplateError>
sourcepub fn verify_domain_dkim(&self) -> VerifyDomainDkim
pub fn verify_domain_dkim(&self) -> VerifyDomainDkim
Constructs a fluent builder for the VerifyDomainDkim
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:The name of the domain to be verified for Easy DKIM signing.
- On success, responds with
VerifyDomainDkimOutput
with field(s):dkim_tokens(Option<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>
sourcepub fn verify_domain_identity(&self) -> VerifyDomainIdentity
pub fn verify_domain_identity(&self) -> VerifyDomainIdentity
Constructs a fluent builder for the VerifyDomainIdentity
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:The domain to be verified.
- On success, responds with
VerifyDomainIdentityOutput
with field(s):verification_token(Option<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, if you still want to verify the domain, you must restart the verification process from the beginning.
- On failure, responds with
SdkError<VerifyDomainIdentityError>
sourcepub fn verify_email_address(&self) -> VerifyEmailAddress
pub fn verify_email_address(&self) -> VerifyEmailAddress
Constructs a fluent builder for the VerifyEmailAddress
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:The email address to be verified.
- On success, responds with
VerifyEmailAddressOutput
- On failure, responds with
SdkError<VerifyEmailAddressError>
sourcepub fn verify_email_identity(&self) -> VerifyEmailIdentity
pub fn verify_email_identity(&self) -> VerifyEmailIdentity
Constructs a fluent builder for the VerifyEmailIdentity
operation.
- The fluent builder is configurable:
email_address(impl Into<String>)
/set_email_address(Option<String>)
:The email address to be verified.
- On success, responds with
VerifyEmailIdentityOutput
- On failure, responds with
SdkError<VerifyEmailIdentityError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more