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
Overview
An API client for SES. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::SES::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
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 Amazon Web Services 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 Amazon Web Services Region.
-
#list_custom_verification_email_templates(params = {}) ⇒ Types::ListCustomVerificationEmailTemplatesResponse
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
-
#list_identities(params = {}) ⇒ Types::ListIdentitiesResponse
Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services 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 Amazon Web Services account in the current Amazon Web Services Region.
-
#list_receipt_rule_sets(params = {}) ⇒ Types::ListReceiptRuleSetsResponse
Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region.
-
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
-
#list_verified_email_addresses(params = {}) ⇒ Types::ListVerifiedEmailAddressesResponse
Deprecated.
-
#put_configuration_set_delivery_options(params = {}) ⇒ Struct
Adds or updates the delivery options for a configuration set.
-
#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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region.
-
#update_configuration_set_sending_enabled(params = {}) ⇒ Struct
Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services 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 identity.
-
#verify_domain_identity(params = {}) ⇒ Types::VerifyDomainIdentityResponse
Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services 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 Amazon Web Services 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.
444 445 446 |
# File 'lib/aws-sdk-ses/client.rb', line 444 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.
5312 5313 5314 |
# File 'lib/aws-sdk-ses/client.rb', line 5312 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.
5315 5316 5317 |
# File 'lib/aws-sdk-ses/client.rb', line 5315 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.
5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 |
# File 'lib/aws-sdk-ses/client.rb', line 5172 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::SES') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-ses' context[:gem_version] = '1.75.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/dg/receiving-email-concepts.html#receiving-email-concepts-rules
500 501 502 503 |
# File 'lib/aws-sdk-ses/client.rb', line 500 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/dg/monitor-sending-activity.html
534 535 536 537 |
# File 'lib/aws-sdk-ses/client.rb', line 534 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 Amazon Web Services 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/dg/monitor-sending-activity.html
599 600 601 602 |
# File 'lib/aws-sdk-ses/client.rb', line 599 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/dg/configure-custom-open-click-domains.html
647 648 649 650 |
# File 'lib/aws-sdk-ses/client.rb', line 647 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/dg/creating-identities.html#send-email-verify-address-custom
708 709 710 711 |
# File 'lib/aws-sdk-ses/client.rb', line 708 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/dg/receiving-email-ip-filtering-console-walkthrough.html
762 763 764 765 |
# File 'lib/aws-sdk-ses/client.rb', line 762 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/dg/receiving-email-receipt-rules-console-walkthrough.html
873 874 875 876 |
# File 'lib/aws-sdk-ses/client.rb', line 873 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/dg/receiving-email-concepts.html#receiving-email-concepts-rules
921 922 923 924 |
# File 'lib/aws-sdk-ses/client.rb', line 921 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 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/dg/send-personalized-email-api.html
957 958 959 960 |
# File 'lib/aws-sdk-ses/client.rb', line 957 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/dg/monitor-sending-activity.html
987 988 989 990 |
# File 'lib/aws-sdk-ses/client.rb', line 987 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/dg/monitor-sending-activity.html
1023 1024 1025 1026 |
# File 'lib/aws-sdk-ses/client.rb', line 1023 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 results 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/dg/configure-custom-open-click-domains.html
1061 1062 1063 1064 |
# File 'lib/aws-sdk-ses/client.rb', line 1061 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/dg/creating-identities.html#send-email-verify-address-custom
1093 1094 1095 1096 |
# File 'lib/aws-sdk-ses/client.rb', line 1093 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.
1129 1130 1131 1132 |
# File 'lib/aws-sdk-ses/client.rb', line 1129 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 operation returns successfully even if a policy with the specified name does not exist.
<note markdown=“1”> This operation is for the identity owner only. If you have not verified the identity, it returns 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/dg/sending-authorization.html
1187 1188 1189 1190 |
# File 'lib/aws-sdk-ses/client.rb', line 1187 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/dg/receiving-email-ip-filtering-console-walkthrough.html
1227 1228 1229 1230 |
# File 'lib/aws-sdk-ses/client.rb', line 1227 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/dg/receiving-email-receipt-rules-console-walkthrough.html
1273 1274 1275 1276 |
# File 'lib/aws-sdk-ses/client.rb', line 1273 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/dg/receiving-email-receipt-rules-console-walkthrough.html
1318 1319 1320 1321 |
# File 'lib/aws-sdk-ses/client.rb', line 1318 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.
1342 1343 1344 1345 |
# File 'lib/aws-sdk-ses/client.rb', line 1342 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.
1375 1376 1377 1378 |
# File 'lib/aws-sdk-ses/client.rb', line 1375 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/dg/receiving-email-concepts.html#receiving-email-concepts-rules
1467 1468 1469 1470 |
# File 'lib/aws-sdk-ses/client.rb', line 1467 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/dg/monitor-sending-activity.html
1528 1529 1530 1531 |
# File 'lib/aws-sdk-ses/client.rb', line 1528 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/dg/receiving-email-receipt-rules-console-walkthrough.html
1624 1625 1626 1627 |
# File 'lib/aws-sdk-ses/client.rb', line 1624 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/dg/receiving-email-receipt-rules-console-walkthrough.html
1725 1726 1727 1728 |
# File 'lib/aws-sdk-ses/client.rb', line 1725 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.
1760 1761 1762 1763 |
# File 'lib/aws-sdk-ses/client.rb', line 1760 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/dg/creating-identities.html#send-email-verify-address-custom
1809 1810 1811 1812 |
# File 'lib/aws-sdk-ses/client.rb', line 1809 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/dg/send-email-authentication-dkim-easy-managing.html
1898 1899 1900 1901 |
# File 'lib/aws-sdk-ses/client.rb', line 1898 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.
1955 1956 1957 1958 |
# File 'lib/aws-sdk-ses/client.rb', line 1955 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/dg/monitor-sending-activity-using-notifications.html
2030 2031 2032 2033 |
# File 'lib/aws-sdk-ses/client.rb', line 2030 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 operation is for the identity owner only. If you have not verified the identity, it returns 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/dg/sending-authorization.html
2108 2109 2110 2111 |
# File 'lib/aws-sdk-ses/client.rb', line 2108 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, 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, 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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
* identity_exists
2186 2187 2188 2189 |
# File 'lib/aws-sdk-ses/client.rb', line 2186 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.
2226 2227 2228 2229 |
# File 'lib/aws-sdk-ses/client.rb', line 2226 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 Amazon Web Services 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.
2290 2291 2292 2293 |
# File 'lib/aws-sdk-ses/client.rb', line 2290 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.
2324 2325 2326 2327 |
# File 'lib/aws-sdk-ses/client.rb', line 2324 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 Amazon Web Services 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 returns 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 also returns ‘NextToken`. 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/dg/monitor-sending-activity.html
2376 2377 2378 2379 |
# File 'lib/aws-sdk-ses/client.rb', line 2376 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 Amazon Web Services 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/dg/creating-identities.html#send-email-verify-address-custom
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2432 2433 2434 2435 |
# File 'lib/aws-sdk-ses/client.rb', line 2432 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 Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
<note markdown=“1”> It’s recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used ‘IdentityType=Domain` in the the original call and received a `NextToken` in the response, you should continue providing the `IdentityType=Domain` parameter for further `NextToken` calls; however, if you didn’t provide the ‘IdentityType` parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2511 2512 2513 2514 |
# File 'lib/aws-sdk-ses/client.rb', line 2511 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 operation returns only a list. To get the actual policy content, use ‘GetIdentityPolicies`.
<note markdown=“1”> This operation is for the identity owner only. If you have not verified the identity, it returns 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/dg/sending-authorization.html
2580 2581 2582 2583 |
# File 'lib/aws-sdk-ses/client.rb', line 2580 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 Amazon Web Services account in the current Amazon Web Services 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/dg/receiving-email-ip-filtering-console-walkthrough.html
2633 2634 2635 2636 |
# File 'lib/aws-sdk-ses/client.rb', line 2633 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 Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you 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/dg/receiving-email-receipt-rules-console-walkthrough.html
2699 2700 2701 2702 |
# File 'lib/aws-sdk-ses/client.rb', line 2699 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 Amazon Web Services Region.
You can execute this operation no more than once per second.
2742 2743 2744 2745 |
# File 'lib/aws-sdk-ses/client.rb', line 2742 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.
2779 2780 2781 2782 |
# File 'lib/aws-sdk-ses/client.rb', line 2779 def list_verified_email_addresses(params = {}, = {}) req = build_request(:list_verified_email_addresses, params) req.send_request() end |
#put_configuration_set_delivery_options(params = {}) ⇒ Struct
Adds or updates the delivery options for a configuration set.
2808 2809 2810 2811 |
# File 'lib/aws-sdk-ses/client.rb', line 2808 def (params = {}, = {}) req = build_request(:put_configuration_set_delivery_options, 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 operation is for the identity owner only. If you have not verified the identity, it returns 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/dg/sending-authorization.html
2880 2881 2882 2883 |
# File 'lib/aws-sdk-ses/client.rb', line 2880 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, it is 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/dg/receiving-email-receipt-rules-console-walkthrough.html
2934 2935 2936 2937 |
# File 'lib/aws-sdk-ses/client.rb', line 2934 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 operation on an email up to 24 hours after you receive it.
<note markdown=“1”> You cannot use this operation 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.
3042 3043 3044 3045 |
# File 'lib/aws-sdk-ses/client.rb', line 3042 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.
To send email using this operation, your call must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using CreateTemplate.
-
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may send only 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 is 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 can be limited by your account’s maximum sending rate.
[1]: docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html
3253 3254 3255 3256 |
# File 'lib/aws-sdk-ses/client.rb', line 3253 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 Amazon Web Services 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/dg/creating-identities.html#send-email-verify-address-custom
3305 3306 3307 3308 |
# File 'lib/aws-sdk-ses/client.rb', line 3305 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. To send email using this 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 results 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 is 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/dg/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html
3550 3551 3552 3553 |
# File 'lib/aws-sdk-ses/client.rb', line 3550 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` 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 need 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 automatically applies its own `Message-ID` and `Date` headers; if you passed these headers when creating the message, they are 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`, 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`
Don’t include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the ‘SourceIdentityArn` parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.
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/dg/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/dg/request-production-access.html [3]: docs.aws.amazon.com/ses/latest/dg/send-an-email-from-console.html [4]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html#send-email-mime-encoding [5]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html [6]: docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html
3857 3858 3859 3860 |
# File 'lib/aws-sdk-ses/client.rb', line 3857 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.
To send email using this operation, your call 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 that receives 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 is 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/dg/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html
4062 4063 4064 4065 |
# File 'lib/aws-sdk-ses/client.rb', line 4062 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 operation 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/dg/receiving-email-receipt-rules-console-walkthrough.html
4108 4109 4110 4111 |
# File 'lib/aws-sdk-ses/client.rb', line 4108 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, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.
<note markdown=“1”> For email addresses (for example, ‘user@example.com`), you can only enable DKIM signing if the corresponding domain (in this case, `example.com`) has been set up to use Easy DKIM.
</note>
You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn’t complete.
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/dg/send-email-authentication-dkim-easy.html
4168 4169 4170 4171 |
# File 'lib/aws-sdk-ses/client.rb', line 4168 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/dg/monitor-sending-activity-using-notifications.html
4229 4230 4231 4232 |
# File 'lib/aws-sdk-ses/client.rb', line 4229 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/dg/monitor-sending-activity-using-notifications.html
4291 4292 4293 4294 |
# File 'lib/aws-sdk-ses/client.rb', line 4291 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. To ensure that your emails 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.
4364 4365 4366 4367 |
# File 'lib/aws-sdk-ses/client.rb', line 4364 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/dg/monitor-sending-activity-using-notifications.html
4431 4432 4433 4434 |
# File 'lib/aws-sdk-ses/client.rb', line 4431 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/dg/receiving-email-receipt-rules-console-walkthrough.html
4484 4485 4486 4487 |
# File 'lib/aws-sdk-ses/client.rb', line 4484 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.
4521 4522 4523 4524 |
# File 'lib/aws-sdk-ses/client.rb', line 4521 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 Amazon Web Services 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 Amazon Web Services 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.
4560 4561 4562 4563 |
# File 'lib/aws-sdk-ses/client.rb', line 4560 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/dg/monitor-sending-activity.html
4624 4625 4626 4627 |
# File 'lib/aws-sdk-ses/client.rb', line 4624 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 Amazon Web Services 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.
4669 4670 4671 4672 |
# File 'lib/aws-sdk-ses/client.rb', line 4669 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 Amazon Web Services 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.
4713 4714 4715 4716 |
# File 'lib/aws-sdk-ses/client.rb', line 4713 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/dg/configure-custom-open-click-domains.html
4760 4761 4762 4763 |
# File 'lib/aws-sdk-ses/client.rb', line 4760 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/dg/creating-identities.html#send-email-verify-address-custom
4821 4822 4823 4824 |
# File 'lib/aws-sdk-ses/client.rb', line 4821 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/dg/receiving-email-receipt-rules-console-walkthrough.html
4924 4925 4926 4927 |
# File 'lib/aws-sdk-ses/client.rb', line 4924 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 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/dg/send-personalized-email-api.html
4960 4961 4962 4963 |
# File 'lib/aws-sdk-ses/client.rb', line 4960 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 identity.
When you execute the ‘VerifyDomainDkim` operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven’t already associated the domain with your account by using the ‘VerifyDomainIdentity` operation. However, you can’t send email from the domain until you either successfully [verify it] or you successfully [set up DKIM for it].
You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you’ve added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven’t added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
-
Name: token._domainkey.example.com
-
Type: CNAME
-
Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that’s generated by this operation.
You can execute this operation no more than once per second.
[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure [2]: docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html
5044 5045 5046 5047 |
# File 'lib/aws-sdk-ses/client.rb', line 5044 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 Amazon Web Services 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/dg/verify-addresses-and-domains.html
5095 5096 5097 5098 |
# File 'lib/aws-sdk-ses/client.rb', line 5095 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.
5127 5128 5129 5130 |
# File 'lib/aws-sdk-ses/client.rb', line 5127 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 Amazon Web Services 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.
5163 5164 5165 5166 |
# File 'lib/aws-sdk-ses/client.rb', line 5163 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.wait_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 |
5278 5279 5280 5281 5282 |
# File 'lib/aws-sdk-ses/client.rb', line 5278 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.
5286 5287 5288 |
# File 'lib/aws-sdk-ses/client.rb', line 5286 def waiter_names waiters.keys end |