Class: Aws::SES::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SES::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-ses/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#clone_receipt_rule_set(params = {}) ⇒ Struct
Creates a receipt rule set by cloning an existing one.
-
#create_configuration_set(params = {}) ⇒ Struct
Creates a configuration set.
-
#create_configuration_set_event_destination(params = {}) ⇒ Struct
Creates a configuration set event destination.
-
#create_configuration_set_tracking_options(params = {}) ⇒ Struct
Creates an association between a configuration set and a custom domain for open and click event tracking.
-
#create_custom_verification_email_template(params = {}) ⇒ Struct
Creates a new custom verification email template.
-
#create_receipt_filter(params = {}) ⇒ Struct
Creates a new IP address filter.
-
#create_receipt_rule(params = {}) ⇒ Struct
Creates a receipt rule.
-
#create_receipt_rule_set(params = {}) ⇒ Struct
Creates an empty receipt rule set.
-
#create_template(params = {}) ⇒ Struct
Creates an email template.
-
#delete_configuration_set(params = {}) ⇒ Struct
Deletes a configuration set.
-
#delete_configuration_set_event_destination(params = {}) ⇒ Struct
Deletes a configuration set event destination.
-
#delete_configuration_set_tracking_options(params = {}) ⇒ Struct
Deletes an association between a configuration set and a custom domain for open and click event tracking.
-
#delete_custom_verification_email_template(params = {}) ⇒ Struct
Deletes an existing custom verification email template.
-
#delete_identity(params = {}) ⇒ Struct
Deletes the specified identity (an email address or a domain) from the list of verified identities.
-
#delete_identity_policy(params = {}) ⇒ Struct
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
-
#delete_receipt_filter(params = {}) ⇒ Struct
Deletes the specified IP address filter.
-
#delete_receipt_rule(params = {}) ⇒ Struct
Deletes the specified receipt rule.
-
#delete_receipt_rule_set(params = {}) ⇒ Struct
Deletes the specified receipt rule set and all of the receipt rules it contains.
-
#delete_template(params = {}) ⇒ Struct
Deletes an email template.
-
#delete_verified_email_address(params = {}) ⇒ Struct
Deprecated.
-
#describe_active_receipt_rule_set(params = {}) ⇒ Types::DescribeActiveReceiptRuleSetResponse
Returns the metadata and receipt rules for the receipt rule set that is currently active.
-
#describe_configuration_set(params = {}) ⇒ Types::DescribeConfigurationSetResponse
Returns the details of the specified configuration set.
-
#describe_receipt_rule(params = {}) ⇒ Types::DescribeReceiptRuleResponse
Returns the details of the specified receipt rule.
-
#describe_receipt_rule_set(params = {}) ⇒ Types::DescribeReceiptRuleSetResponse
Returns the details of the specified receipt rule set.
-
#get_account_sending_enabled(params = {}) ⇒ Types::GetAccountSendingEnabledResponse
Returns the email sending status of the Amazon SES account for the current region.
-
#get_custom_verification_email_template(params = {}) ⇒ Types::GetCustomVerificationEmailTemplateResponse
Returns the custom email verification template for the template name you specify.
-
#get_identity_dkim_attributes(params = {}) ⇒ Types::GetIdentityDkimAttributesResponse
Returns the current status of Easy DKIM signing for an entity.
-
#get_identity_mail_from_domain_attributes(params = {}) ⇒ Types::GetIdentityMailFromDomainAttributesResponse
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
-
#get_identity_notification_attributes(params = {}) ⇒ Types::GetIdentityNotificationAttributesResponse
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
-
#get_identity_policies(params = {}) ⇒ Types::GetIdentityPoliciesResponse
Returns the requested sending authorization policies for the given identity (an email address or a domain).
-
#get_identity_verification_attributes(params = {}) ⇒ Types::GetIdentityVerificationAttributesResponse
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
-
#get_send_quota(params = {}) ⇒ Types::GetSendQuotaResponse
Provides the sending limits for the Amazon SES account.
-
#get_send_statistics(params = {}) ⇒ Types::GetSendStatisticsResponse
Provides sending statistics for the current AWS Region.
-
#get_template(params = {}) ⇒ Types::GetTemplateResponse
Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
-
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region.
-
#list_custom_verification_email_templates(params = {}) ⇒ Types::ListCustomVerificationEmailTemplatesResponse
Lists the existing custom verification email templates for your account in the current AWS Region.
-
#list_identities(params = {}) ⇒ Types::ListIdentitiesResponse
Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.
-
#list_identity_policies(params = {}) ⇒ Types::ListIdentityPoliciesResponse
Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain).
-
#list_receipt_filters(params = {}) ⇒ Types::ListReceiptFiltersResponse
Lists the IP address filters associated with your AWS account in the current AWS Region.
-
#list_receipt_rule_sets(params = {}) ⇒ Types::ListReceiptRuleSetsResponse
Lists the receipt rule sets that exist under your AWS account in the current AWS Region.
-
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists the email templates present in your Amazon SES account in the current AWS Region.
-
#list_verified_email_addresses(params = {}) ⇒ Types::ListVerifiedEmailAddressesResponse
Deprecated.
-
#put_identity_policy(params = {}) ⇒ Struct
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
-
#reorder_receipt_rule_set(params = {}) ⇒ Struct
Reorders the receipt rules within a receipt rule set.
-
#send_bounce(params = {}) ⇒ Types::SendBounceResponse
Generates and sends a bounce message to the sender of an email you received through Amazon SES.
-
#send_bulk_templated_email(params = {}) ⇒ Types::SendBulkTemplatedEmailResponse
Composes an email message to multiple destinations.
-
#send_custom_verification_email(params = {}) ⇒ Types::SendCustomVerificationEmailResponse
Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it.
-
#send_email(params = {}) ⇒ Types::SendEmailResponse
Composes an email message and immediately queues it for sending.
-
#send_raw_email(params = {}) ⇒ Types::SendRawEmailResponse
Composes an email message and immediately queues it for sending.
-
#send_templated_email(params = {}) ⇒ Types::SendTemplatedEmailResponse
Composes an email message using an email template and immediately queues it for sending.
-
#set_active_receipt_rule_set(params = {}) ⇒ Struct
Sets the specified receipt rule set as the active receipt rule set.
-
#set_identity_dkim_enabled(params = {}) ⇒ Struct
Enables or disables Easy DKIM signing of email sent from an identity:.
-
#set_identity_feedback_forwarding_enabled(params = {}) ⇒ Struct
Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.
-
#set_identity_headers_in_notifications_enabled(params = {}) ⇒ Struct
Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
-
#set_identity_mail_from_domain(params = {}) ⇒ Struct
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
-
#set_identity_notification_topic(params = {}) ⇒ Struct
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications.
-
#set_receipt_rule_position(params = {}) ⇒ Struct
Sets the position of the specified receipt rule in the receipt rule set.
-
#test_render_template(params = {}) ⇒ Types::TestRenderTemplateResponse
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
-
#update_account_sending_enabled(params = {}) ⇒ Struct
Enables or disables email sending across your entire Amazon SES account in the current AWS Region.
-
#update_configuration_set_event_destination(params = {}) ⇒ Struct
Updates the event destination of a configuration set.
-
#update_configuration_set_reputation_metrics_enabled(params = {}) ⇒ Struct
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region.
-
#update_configuration_set_sending_enabled(params = {}) ⇒ Struct
Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region.
-
#update_configuration_set_tracking_options(params = {}) ⇒ Struct
Modifies an association between a configuration set and a custom domain for open and click event tracking.
-
#update_custom_verification_email_template(params = {}) ⇒ Struct
Updates an existing custom verification email template.
-
#update_receipt_rule(params = {}) ⇒ Struct
Updates a receipt rule.
-
#update_template(params = {}) ⇒ Struct
Updates an email template.
-
#verify_domain_dkim(params = {}) ⇒ Types::VerifyDomainDkimResponse
Returns a set of DKIM tokens for a domain.
-
#verify_domain_identity(params = {}) ⇒ Types::VerifyDomainIdentityResponse
Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it.
-
#verify_email_address(params = {}) ⇒ Struct
Deprecated.
-
#verify_email_identity(params = {}) ⇒ Struct
Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
202 203 204 |
# File 'lib/aws-sdk-ses/client.rb', line 202 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4997 4998 4999 |
# File 'lib/aws-sdk-ses/client.rb', line 4997 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5000 5001 5002 |
# File 'lib/aws-sdk-ses/client.rb', line 5000 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 |
# File 'lib/aws-sdk-ses/client.rb', line 4862 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ses' context[:gem_version] = '1.14.0' Seahorse::Client::Request.new(handlers, context) end |
#clone_receipt_rule_set(params = {}) ⇒ Struct
Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
257 258 259 260 |
# File 'lib/aws-sdk-ses/client.rb', line 257 def clone_receipt_rule_set(params = {}, = {}) req = build_request(:clone_receipt_rule_set, params) req.send_request() end |
#create_configuration_set(params = {}) ⇒ Struct
Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
291 292 293 294 |
# File 'lib/aws-sdk-ses/client.rb', line 291 def create_configuration_set(params = {}, = {}) req = build_request(:create_configuration_set, params) req.send_request() end |
#create_configuration_set_event_destination(params = {}) ⇒ Struct
Creates a configuration set event destination.
<note markdown=“1”> When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
</note>
An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
356 357 358 359 |
# File 'lib/aws-sdk-ses/client.rb', line 356 def create_configuration_set_event_destination(params = {}, = {}) req = build_request(:create_configuration_set_event_destination, params) req.send_request() end |
#create_configuration_set_tracking_options(params = {}) ⇒ Struct
Creates an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
402 403 404 405 |
# File 'lib/aws-sdk-ses/client.rb', line 402 def (params = {}, = {}) req = build_request(:create_configuration_set_tracking_options, params) req.send_request() end |
#create_custom_verification_email_template(params = {}) ⇒ Struct
Creates a new custom verification email template.
For more information about custom verification email templates, see
- Using Custom Verification Email Templates][1
-
in the *Amazon SES
Developer Guide*.
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
463 464 465 466 |
# File 'lib/aws-sdk-ses/client.rb', line 463 def create_custom_verification_email_template(params = {}, = {}) req = build_request(:create_custom_verification_email_template, params) req.send_request() end |
#create_receipt_filter(params = {}) ⇒ Struct
Creates a new IP address filter.
For information about setting up IP address filters, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html
517 518 519 520 |
# File 'lib/aws-sdk-ses/client.rb', line 517 def create_receipt_filter(params = {}, = {}) req = build_request(:create_receipt_filter, params) req.send_request() end |
#create_receipt_rule(params = {}) ⇒ Struct
Creates a receipt rule.
For information about setting up receipt rules, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
627 628 629 630 |
# File 'lib/aws-sdk-ses/client.rb', line 627 def create_receipt_rule(params = {}, = {}) req = build_request(:create_receipt_rule, params) req.send_request() end |
#create_receipt_rule_set(params = {}) ⇒ Struct
Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
674 675 676 677 |
# File 'lib/aws-sdk-ses/client.rb', line 674 def create_receipt_rule_set(params = {}, = {}) req = build_request(:create_receipt_rule_set, params) req.send_request() end |
#create_template(params = {}) ⇒ Struct
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
711 712 713 714 |
# File 'lib/aws-sdk-ses/client.rb', line 711 def create_template(params = {}, = {}) req = build_request(:create_template, params) req.send_request() end |
#delete_configuration_set(params = {}) ⇒ Struct
Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
741 742 743 744 |
# File 'lib/aws-sdk-ses/client.rb', line 741 def delete_configuration_set(params = {}, = {}) req = build_request(:delete_configuration_set, params) req.send_request() end |
#delete_configuration_set_event_destination(params = {}) ⇒ Struct
Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
777 778 779 780 |
# File 'lib/aws-sdk-ses/client.rb', line 777 def delete_configuration_set_event_destination(params = {}, = {}) req = build_request(:delete_configuration_set_event_destination, params) req.send_request() end |
#delete_configuration_set_tracking_options(params = {}) ⇒ Struct
Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the [Amazon SES Developer Guide].
<note markdown=“1”> Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
</note>
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
816 817 818 819 |
# File 'lib/aws-sdk-ses/client.rb', line 816 def (params = {}, = {}) req = build_request(:delete_configuration_set_tracking_options, params) req.send_request() end |
#delete_custom_verification_email_template(params = {}) ⇒ Struct
Deletes an existing custom verification email template.
For more information about custom verification email templates, see
- Using Custom Verification Email Templates][1
-
in the *Amazon SES
Developer Guide*.
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
849 850 851 852 |
# File 'lib/aws-sdk-ses/client.rb', line 849 def delete_custom_verification_email_template(params = {}, = {}) req = build_request(:delete_custom_verification_email_template, params) req.send_request() end |
#delete_identity(params = {}) ⇒ Struct
Deletes the specified identity (an email address or a domain) from the list of verified identities.
You can execute this operation no more than once per second.
885 886 887 888 |
# File 'lib/aws-sdk-ses/client.rb', line 885 def delete_identity(params = {}, = {}) req = build_request(:delete_identity, params) req.send_request() end |
#delete_identity_policy(params = {}) ⇒ Struct
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.
</note>
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
944 945 946 947 |
# File 'lib/aws-sdk-ses/client.rb', line 944 def delete_identity_policy(params = {}, = {}) req = build_request(:delete_identity_policy, params) req.send_request() end |
#delete_receipt_filter(params = {}) ⇒ Struct
Deletes the specified IP address filter.
For information about managing IP address filters, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html
984 985 986 987 |
# File 'lib/aws-sdk-ses/client.rb', line 984 def delete_receipt_filter(params = {}, = {}) req = build_request(:delete_receipt_filter, params) req.send_request() end |
#delete_receipt_rule(params = {}) ⇒ Struct
Deletes the specified receipt rule.
For information about managing receipt rules, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
1030 1031 1032 1033 |
# File 'lib/aws-sdk-ses/client.rb', line 1030 def delete_receipt_rule(params = {}, = {}) req = build_request(:delete_receipt_rule, params) req.send_request() end |
#delete_receipt_rule_set(params = {}) ⇒ Struct
Deletes the specified receipt rule set and all of the receipt rules it contains.
<note markdown=“1”> The currently active rule set cannot be deleted.
</note>
For information about managing receipt rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
1075 1076 1077 1078 |
# File 'lib/aws-sdk-ses/client.rb', line 1075 def delete_receipt_rule_set(params = {}, = {}) req = build_request(:delete_receipt_rule_set, params) req.send_request() end |
#delete_template(params = {}) ⇒ Struct
Deletes an email template.
You can execute this operation no more than once per second.
1099 1100 1101 1102 |
# File 'lib/aws-sdk-ses/client.rb', line 1099 def delete_template(params = {}, = {}) req = build_request(:delete_template, params) req.send_request() end |
#delete_verified_email_address(params = {}) ⇒ Struct
Deprecated. Use the ‘DeleteIdentity` operation to delete email addresses and domains.
1132 1133 1134 1135 |
# File 'lib/aws-sdk-ses/client.rb', line 1132 def delete_verified_email_address(params = {}, = {}) req = build_request(:delete_verified_email_address, params) req.send_request() end |
#describe_active_receipt_rule_set(params = {}) ⇒ Types::DescribeActiveReceiptRuleSetResponse
Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
1223 1224 1225 1226 |
# File 'lib/aws-sdk-ses/client.rb', line 1223 def describe_active_receipt_rule_set(params = {}, = {}) req = build_request(:describe_active_receipt_rule_set, params) req.send_request() end |
#describe_configuration_set(params = {}) ⇒ Types::DescribeConfigurationSetResponse
Returns the details of the specified configuration set. For information about using configuration sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
1282 1283 1284 1285 |
# File 'lib/aws-sdk-ses/client.rb', line 1282 def describe_configuration_set(params = {}, = {}) req = build_request(:describe_configuration_set, params) req.send_request() end |
#describe_receipt_rule(params = {}) ⇒ Types::DescribeReceiptRuleResponse
Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
1377 1378 1379 1380 |
# File 'lib/aws-sdk-ses/client.rb', line 1377 def describe_receipt_rule(params = {}, = {}) req = build_request(:describe_receipt_rule, params) req.send_request() end |
#describe_receipt_rule_set(params = {}) ⇒ Types::DescribeReceiptRuleSetResponse
Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
1477 1478 1479 1480 |
# File 'lib/aws-sdk-ses/client.rb', line 1477 def describe_receipt_rule_set(params = {}, = {}) req = build_request(:describe_receipt_rule_set, params) req.send_request() end |
#get_account_sending_enabled(params = {}) ⇒ Types::GetAccountSendingEnabledResponse
Returns the email sending status of the Amazon SES account for the current region.
You can execute this operation no more than once per second.
1512 1513 1514 1515 |
# File 'lib/aws-sdk-ses/client.rb', line 1512 def get_account_sending_enabled(params = {}, = {}) req = build_request(:get_account_sending_enabled, params) req.send_request() end |
#get_custom_verification_email_template(params = {}) ⇒ Types::GetCustomVerificationEmailTemplateResponse
Returns the custom email verification template for the template name you specify.
For more information about custom verification email templates, see
- Using Custom Verification Email Templates][1
-
in the *Amazon SES
Developer Guide*.
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
1562 1563 1564 1565 |
# File 'lib/aws-sdk-ses/client.rb', line 1562 def get_custom_verification_email_template(params = {}, = {}) req = build_request(:get_custom_verification_email_template, params) req.send_request() end |
#get_identity_dkim_attributes(params = {}) ⇒ Types::GetIdentityDkimAttributesResponse
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
-
Whether Easy DKIM signing is enabled or disabled.
-
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
-
Whether Amazon SES has successfully verified the DKIM tokens published in the domain’s DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html
1651 1652 1653 1654 |
# File 'lib/aws-sdk-ses/client.rb', line 1651 def get_identity_dkim_attributes(params = {}, = {}) req = build_request(:get_identity_dkim_attributes, params) req.send_request() end |
#get_identity_mail_from_domain_attributes(params = {}) ⇒ Types::GetIdentityMailFromDomainAttributesResponse
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
1708 1709 1710 1711 |
# File 'lib/aws-sdk-ses/client.rb', line 1708 def get_identity_mail_from_domain_attributes(params = {}, = {}) req = build_request(:get_identity_mail_from_domain_attributes, params) req.send_request() end |
#get_identity_notification_attributes(params = {}) ⇒ Types::GetIdentityNotificationAttributesResponse
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
1783 1784 1785 1786 |
# File 'lib/aws-sdk-ses/client.rb', line 1783 def get_identity_notification_attributes(params = {}, = {}) req = build_request(:get_identity_notification_attributes, params) req.send_request() end |
#get_identity_policies(params = {}) ⇒ Types::GetIdentityPoliciesResponse
Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.
<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.
</note>
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
1861 1862 1863 1864 |
# File 'lib/aws-sdk-ses/client.rb', line 1861 def get_identity_policies(params = {}, = {}) req = build_request(:get_identity_policies, params) req.send_request() end |
#get_identity_verification_attributes(params = {}) ⇒ Types::GetIdentityVerificationAttributesResponse
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is “Pending” until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to “Success”. If the link is not clicked within 24 hours, the verification status changes to “Failed.” In that case, if you still want to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain’s verification status is “Pending” as Amazon SES searches for the required TXT record in the DNS settings of the domain. 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.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
1935 1936 1937 1938 |
# File 'lib/aws-sdk-ses/client.rb', line 1935 def get_identity_verification_attributes(params = {}, = {}) req = build_request(:get_identity_verification_attributes, params) req.send_request() end |
#get_send_quota(params = {}) ⇒ Types::GetSendQuotaResponse
Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
1975 1976 1977 1978 |
# File 'lib/aws-sdk-ses/client.rb', line 1975 def get_send_quota(params = {}, = {}) req = build_request(:get_send_quota, params) req.send_request() end |
#get_send_statistics(params = {}) ⇒ Types::GetSendStatisticsResponse
Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
2039 2040 2041 2042 |
# File 'lib/aws-sdk-ses/client.rb', line 2039 def get_send_statistics(params = {}, = {}) req = build_request(:get_send_statistics, params) req.send_request() end |
#get_template(params = {}) ⇒ Types::GetTemplateResponse
Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
You can execute this operation no more than once per second.
2073 2074 2075 2076 |
# File 'lib/aws-sdk-ses/client.rb', line 2073 def get_template(params = {}, = {}) req = build_request(:get_template, params) req.send_request() end |
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see [Monitoring Your Amazon SES Sending Activity] in the *Amazon SES Developer Guide.*
You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ‘ListConfigurationSets` operation again, passing the `NextToken` parameter and the value of the NextToken element to retrieve additional results.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
2125 2126 2127 2128 |
# File 'lib/aws-sdk-ses/client.rb', line 2125 def list_configuration_sets(params = {}, = {}) req = build_request(:list_configuration_sets, params) req.send_request() end |
#list_custom_verification_email_templates(params = {}) ⇒ Types::ListCustomVerificationEmailTemplatesResponse
Lists the existing custom verification email templates for your account in the current AWS Region.
For more information about custom verification email templates, see
- Using Custom Verification Email Templates][1
-
in the *Amazon SES
Developer Guide*.
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
2179 2180 2181 2182 |
# File 'lib/aws-sdk-ses/client.rb', line 2179 def list_custom_verification_email_templates(params = {}, = {}) req = build_request(:list_custom_verification_email_templates, params) req.send_request() end |
#list_identities(params = {}) ⇒ Types::ListIdentitiesResponse
Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.
You can execute this operation no more than once per second.
2244 2245 2246 2247 |
# File 'lib/aws-sdk-ses/client.rb', line 2244 def list_identities(params = {}, = {}) req = build_request(:list_identities, params) req.send_request() end |
#list_identity_policies(params = {}) ⇒ Types::ListIdentityPoliciesResponse
Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use ‘GetIdentityPolicies`.
<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.
</note>
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
2313 2314 2315 2316 |
# File 'lib/aws-sdk-ses/client.rb', line 2313 def list_identity_policies(params = {}, = {}) req = build_request(:list_identity_policies, params) req.send_request() end |
#list_receipt_filters(params = {}) ⇒ Types::ListReceiptFiltersResponse
Lists the IP address filters associated with your AWS account in the current AWS Region.
For information about managing IP address filters, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html
2366 2367 2368 2369 |
# File 'lib/aws-sdk-ses/client.rb', line 2366 def list_receipt_filters(params = {}, = {}) req = build_request(:list_receipt_filters, params) req.send_request() end |
#list_receipt_rule_sets(params = {}) ⇒ Types::ListReceiptRuleSetsResponse
Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a ‘NextToken` that you can provide to the next call to `ListReceiptRuleSets` to retrieve the additional entries.
For information about managing receipt rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
2431 2432 2433 2434 |
# File 'lib/aws-sdk-ses/client.rb', line 2431 def list_receipt_rule_sets(params = {}, = {}) req = build_request(:list_receipt_rule_sets, params) req.send_request() end |
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists the email templates present in your Amazon SES account in the current AWS Region.
You can execute this operation no more than once per second.
2474 2475 2476 2477 |
# File 'lib/aws-sdk-ses/client.rb', line 2474 def list_templates(params = {}, = {}) req = build_request(:list_templates, params) req.send_request() end |
#list_verified_email_addresses(params = {}) ⇒ Types::ListVerifiedEmailAddressesResponse
Deprecated. Use the ‘ListIdentities` operation to list the email addresses and domains associated with your account.
2511 2512 2513 2514 |
# File 'lib/aws-sdk-ses/client.rb', line 2511 def list_verified_email_addresses(params = {}, = {}) req = build_request(:list_verified_email_addresses, params) req.send_request() end |
#put_identity_policy(params = {}) ⇒ Struct
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.
</note>
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
2583 2584 2585 2586 |
# File 'lib/aws-sdk-ses/client.rb', line 2583 def put_identity_policy(params = {}, = {}) req = build_request(:put_identity_policy, params) req.send_request() end |
#reorder_receipt_rule_set(params = {}) ⇒ Struct
Reorders the receipt rules within a receipt rule set.
<note markdown=“1”> All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn’t explicitly position all of the rules.
</note>
For information about managing receipt rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
2638 2639 2640 2641 |
# File 'lib/aws-sdk-ses/client.rb', line 2638 def reorder_receipt_rule_set(params = {}, = {}) req = build_request(:reorder_receipt_rule_set, params) req.send_request() end |
#send_bounce(params = {}) ⇒ Types::SendBounceResponse
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
<note markdown=“1”> You cannot use this API to send generic bounces for mail that was not received by Amazon SES.
</note>
For information about receiving email through Amazon SES, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html
2746 2747 2748 2749 |
# File 'lib/aws-sdk-ses/client.rb', line 2746 def send_bounce(params = {}, = {}) req = build_request(:send_bounce, params) req.send_request() end |
#send_bulk_templated_email(params = {}) ⇒ Types::SendBulkTemplatedEmailResponse
Composes an email message to multiple destinations. The message body is created using an email template.
In order to send email using the ‘SendBulkTemplatedEmail` operation, your call to the API must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
-
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see [Verifying Email Addresses and Domains] in the *Amazon SES Developer Guide.*
-
The maximum message size is 10 MB.
-
Each ‘Destination` parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format *UserName@Domain.TopLevelDomain*), the entire message will be rejected, even if the message contains other recipients that are valid.
-
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the ‘SendBulkTemplatedEmail` operation several times to send the message to each group.
-
The number of destinations you can contact in a single call to the API may be limited by your account’s maximum sending rate.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
2957 2958 2959 2960 |
# File 'lib/aws-sdk-ses/client.rb', line 2957 def send_bulk_templated_email(params = {}, = {}) req = build_request(:send_bulk_templated_email, params) req.send_request() end |
#send_custom_verification_email(params = {}) ⇒ Types::SendCustomVerificationEmailResponse
Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see [Using Custom Verification Email Templates] in the *Amazon SES Developer Guide*.
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
3009 3010 3011 3012 |
# File 'lib/aws-sdk-ses/client.rb', line 3009 def send_custom_verification_email(params = {}, = {}) req = build_request(:send_custom_verification_email, params) req.send_request() end |
#send_email(params = {}) ⇒ Types::SendEmailResponse
Composes an email message and immediately queues it for sending. In order to send email using the ‘SendEmail` operation, your message must meet the following requirements:
-
The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an “Email address not verified” error.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see [Verifying Email Addresses and Domains] in the *Amazon SES Developer Guide.*
-
The maximum message size is 10 MB.
-
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format *UserName@Domain.TopLevelDomain*), the entire message will be rejected, even if the message contains other recipients that are valid.
-
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the ‘SendEmail` operation several times to send the message to each group.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your *sending quota*). For more information about sending quotas in Amazon SES, see [Managing Your Amazon SES Sending Limits] in the *Amazon SES Developer Guide.*
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html
3255 3256 3257 3258 |
# File 'lib/aws-sdk-ses/client.rb', line 3255 def send_email(params = {}, = {}) req = build_request(:send_email, params) req.send_request() end |
#send_raw_email(params = {}) ⇒ Types::SendRawEmailResponse
Composes an email message and immediately queues it for sending.
This operation is more flexible than the ‘SendEmail` API operation. When you use the `SendRawEmail` operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.
The ‘SendRawEmail` operation has the following requirements:
-
You can only send email from [verified email addresses or domains]. If you try to send email from an address that isn’t verified, the operation results in an “Email address not verified” error.
-
If your account is still in the [Amazon SES sandbox], you can only send email to other verified addresses in your account, or to addresses that are associated with the [Amazon SES mailbox simulator].
-
The maximum message size, including attachments, is 10 MB.
-
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
-
If you send a single message to more than one recipient address, and one of the recipient addresses isn’t in a valid format (that is, it’s not in the format *UserName@Domain.TopLevelDomain*), Amazon SES rejects the entire message, even if the other addresses are valid.
-
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
-
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn’t preserved. For this reason, we highly recommend that you encode all content that isn’t 7-bit ASCII. For more information, see [MIME Encoding] in the *Amazon SES Developer Guide*.
Additionally, keep the following considerations in mind when using the ‘SendRawEmail` operation:
-
Although you can customize the message headers when using the ‘SendRawEmail` operation, Amazon SES will automatically apply its own `Message-ID` and `Date` headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.
-
If you are using sending authorization to send on behalf of another user, ‘SendRawEmail` enables you to specify the cross-account identity for the email’s Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters ‘SourceArn`, `FromArn`, and/or `ReturnPathArn` to the API, or you can include the following X-headers in the header of your raw email:
-
‘X-SES-SOURCE-ARN`
-
‘X-SES-FROM-ARN`
-
‘X-SES-RETURN-PATH-ARN`
Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.
For most common sending authorization scenarios, we recommend that you specify the ‘SourceIdentityArn` parameter and not the `FromIdentityArn` or `ReturnPathIdentityArn` parameters. If you only specify the `SourceIdentityArn` parameter, Amazon SES will set the From and Return Path addresses to the identity specified in `SourceIdentityArn`. For more information about sending authorization, see the [Using Sending Authorization with Amazon SES] in the *Amazon SES Developer Guide.*
-
-
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your *sending quota*). For more information about sending quotas in Amazon SES, see [Managing Your Amazon SES Sending Limits] in the *Amazon SES Developer Guide.*
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html [3]: docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html [4]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html#send-email-mime-encoding [5]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html [6]: docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html
3563 3564 3565 3566 |
# File 'lib/aws-sdk-ses/client.rb', line 3563 def send_raw_email(params = {}, = {}) req = build_request(:send_raw_email, params) req.send_request() end |
#send_templated_email(params = {}) ⇒ Types::SendTemplatedEmailResponse
Composes an email message using an email template and immediately queues it for sending.
In order to send email using the ‘SendTemplatedEmail` operation, your call to the API must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
-
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see [Verifying Email Addresses and Domains] in the *Amazon SES Developer Guide.*
-
The maximum message size is 10 MB.
-
Calls to the ‘SendTemplatedEmail` operation may only include one `Destination` parameter. A destination is a set of recipients who will receive the same version of the email. The `Destination` parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
-
The ‘Destination` parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format *UserName@Domain.TopLevelDomain*), the entire message will be rejected, even if the message contains other recipients that are valid.
If your call to the ‘SendTemplatedEmail` operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can’t render the email because the template contains errors, it doesn’t send the email. Additionally, because it already accepted the message, Amazon SES doesn’t return a message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to
send you notifications when Rendering Failure events occur. For more information, see [Sending Personalized Email Using the Amazon SES API] in the *Amazon Simple Email Service Developer Guide*.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
3768 3769 3770 3771 |
# File 'lib/aws-sdk-ses/client.rb', line 3768 def send_templated_email(params = {}, = {}) req = build_request(:send_templated_email, params) req.send_request() end |
#set_active_receipt_rule_set(params = {}) ⇒ Struct
Sets the specified receipt rule set as the active receipt rule set.
<note markdown=“1”> To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.
</note>
For information about managing receipt rule sets, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
3814 3815 3816 3817 |
# File 'lib/aws-sdk-ses/client.rb', line 3814 def set_active_receipt_rule_set(params = {}, = {}) req = build_request(:set_active_receipt_rule_set, params) req.send_request() end |
#set_identity_dkim_enabled(params = {}) ⇒ Struct
Enables or disables Easy DKIM signing of email sent from an identity:
-
If Easy DKIM signing is enabled for a domain name identity (such as ‘example.com`), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (for example, `[email protected]`).
-
If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.
For email addresses (for example, ‘[email protected]`), you can only enable Easy DKIM signing if the corresponding domain (in this case, `example.com`) has been set up for Easy DKIM using the AWS Console or the `VerifyDomainDkim` operation.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
3872 3873 3874 3875 |
# File 'lib/aws-sdk-ses/client.rb', line 3872 def set_identity_dkim_enabled(params = {}, = {}) req = build_request(:set_identity_dkim_enabled, params) req.send_request() end |
#set_identity_feedback_forwarding_enabled(params = {}) ⇒ Struct
Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
<note markdown=“1”> Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
</note>
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
3934 3935 3936 3937 |
# File 'lib/aws-sdk-ses/client.rb', line 3934 def set_identity_feedback_forwarding_enabled(params = {}, = {}) req = build_request(:set_identity_feedback_forwarding_enabled, params) req.send_request() end |
#set_identity_headers_in_notifications_enabled(params = {}) ⇒ Struct
Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
3996 3997 3998 3999 |
# File 'lib/aws-sdk-ses/client.rb', line 3996 def set_identity_headers_in_notifications_enabled(params = {}, = {}) req = build_request(:set_identity_headers_in_notifications_enabled, params) req.send_request() end |
#set_identity_mail_from_domain(params = {}) ⇒ Struct
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain’s DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html
4070 4071 4072 4073 |
# File 'lib/aws-sdk-ses/client.rb', line 4070 def set_identity_mail_from_domain(params = {}, = {}) req = build_request(:set_identity_mail_from_domain, params) req.send_request() end |
#set_identity_notification_topic(params = {}) ⇒ Struct
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
4138 4139 4140 4141 |
# File 'lib/aws-sdk-ses/client.rb', line 4138 def set_identity_notification_topic(params = {}, = {}) req = build_request(:set_identity_notification_topic, params) req.send_request() end |
#set_receipt_rule_position(params = {}) ⇒ Struct
Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
4191 4192 4193 4194 |
# File 'lib/aws-sdk-ses/client.rb', line 4191 def set_receipt_rule_position(params = {}, = {}) req = build_request(:set_receipt_rule_position, params) req.send_request() end |
#test_render_template(params = {}) ⇒ Types::TestRenderTemplateResponse
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
You can execute this operation no more than once per second.
4228 4229 4230 4231 |
# File 'lib/aws-sdk-ses/client.rb', line 4228 def test_render_template(params = {}, = {}) req = build_request(:test_render_template, params) req.send_request() end |
#update_account_sending_enabled(params = {}) ⇒ Struct
Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
4267 4268 4269 4270 |
# File 'lib/aws-sdk-ses/client.rb', line 4267 def update_account_sending_enabled(params = {}, = {}) req = build_request(:update_account_sending_enabled, params) req.send_request() end |
#update_configuration_set_event_destination(params = {}) ⇒ Struct
Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see [Monitoring Your Amazon SES Sending Activity] in the *Amazon SES Developer Guide.*
<note markdown=“1”> When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
</note>
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
4333 4334 4335 4336 |
# File 'lib/aws-sdk-ses/client.rb', line 4333 def update_configuration_set_event_destination(params = {}, = {}) req = build_request(:update_configuration_set_event_destination, params) req.send_request() end |
#update_configuration_set_reputation_metrics_enabled(params = {}) ⇒ Struct
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
4378 4379 4380 4381 |
# File 'lib/aws-sdk-ses/client.rb', line 4378 def update_configuration_set_reputation_metrics_enabled(params = {}, = {}) req = build_request(:update_configuration_set_reputation_metrics_enabled, params) req.send_request() end |
#update_configuration_set_sending_enabled(params = {}) ⇒ Struct
Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
4422 4423 4424 4425 |
# File 'lib/aws-sdk-ses/client.rb', line 4422 def update_configuration_set_sending_enabled(params = {}, = {}) req = build_request(:update_configuration_set_sending_enabled, params) req.send_request() end |
#update_configuration_set_tracking_options(params = {}) ⇒ Struct
Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
4468 4469 4470 4471 |
# File 'lib/aws-sdk-ses/client.rb', line 4468 def (params = {}, = {}) req = build_request(:update_configuration_set_tracking_options, params) req.send_request() end |
#update_custom_verification_email_template(params = {}) ⇒ Struct
Updates an existing custom verification email template.
For more information about custom verification email templates, see
- Using Custom Verification Email Templates][1
-
in the *Amazon SES
Developer Guide*.
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
4530 4531 4532 4533 |
# File 'lib/aws-sdk-ses/client.rb', line 4530 def update_custom_verification_email_template(params = {}, = {}) req = build_request(:update_custom_verification_email_template, params) req.send_request() end |
#update_receipt_rule(params = {}) ⇒ Struct
Updates a receipt rule.
For information about managing receipt rules, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
4632 4633 4634 4635 |
# File 'lib/aws-sdk-ses/client.rb', line 4632 def update_receipt_rule(params = {}, = {}) req = build_request(:update_receipt_rule, params) req.send_request() end |
#update_template(params = {}) ⇒ Struct
Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the [Amazon SES Developer Guide].
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
4669 4670 4671 4672 |
# File 'lib/aws-sdk-ses/client.rb', line 4669 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |
#verify_domain_dkim(params = {}) ⇒ Types::VerifyDomainDkimResponse
Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain’s identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.
You can execute this operation no more than once per second.
To enable or disable Easy DKIM signing for a domain, use the ‘SetIdentityDkimEnabled` operation.
For more information about creating DNS records using DKIM tokens, go to the [Amazon SES Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html
4734 4735 4736 4737 |
# File 'lib/aws-sdk-ses/client.rb', line 4734 def verify_domain_dkim(params = {}, = {}) req = build_request(:verify_domain_dkim, params) req.send_request() end |
#verify_domain_identity(params = {}) ⇒ Types::VerifyDomainIdentityResponse
Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see [Verifying Email Addresses and Domains] in the *Amazon SES Developer Guide.*
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
4785 4786 4787 4788 |
# File 'lib/aws-sdk-ses/client.rb', line 4785 def verify_domain_identity(params = {}, = {}) req = build_request(:verify_domain_identity, params) req.send_request() end |
#verify_email_address(params = {}) ⇒ Struct
Deprecated. Use the ‘VerifyEmailIdentity` operation to verify a new email address.
4817 4818 4819 4820 |
# File 'lib/aws-sdk-ses/client.rb', line 4817 def verify_email_address(params = {}, = {}) req = build_request(:verify_email_address, params) req.send_request() end |
#verify_email_identity(params = {}) ⇒ Struct
Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.
You can execute this operation no more than once per second.
4853 4854 4855 4856 |
# File 'lib/aws-sdk-ses/client.rb', line 4853 def verify_email_identity(params = {}, = {}) req = build_request(:verify_email_identity, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.waiter_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ————— | ————————————— | ——– | ————- | | identity_exists | #get_identity_verification_attributes | 3 | 20 |
4963 4964 4965 4966 4967 |
# File 'lib/aws-sdk-ses/client.rb', line 4963 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4971 4972 4973 |
# File 'lib/aws-sdk-ses/client.rb', line 4971 def waiter_names waiters.keys end |