Class: Aws::SES::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
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

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::SES::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SES::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



434
435
436
 
# File 'lib/aws-sdk-ses/client.rb', line 434

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. 



5302
5303
5304
 
# File 'lib/aws-sdk-ses/client.rb', line 5302

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. 



5305
5306
5307
 
# File 'lib/aws-sdk-ses/client.rb', line 5305

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.

Parameters:

  • params ({}) (defaults to: {}) 


5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
 
# File 'lib/aws-sdk-ses/client.rb', line 5162

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.70.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

Examples:

Example: CloneReceiptRuleSet


# The following example creates a receipt rule set by cloning an existing one:

resp = client.clone_receipt_rule_set({
  original_rule_set_name: "RuleSetToClone", 
  rule_set_name: "RuleSetToCreate", 
})

Request syntax with placeholder values


resp = client.clone_receipt_rule_set({
  rule_set_name: "ReceiptRuleSetName", # required
  original_rule_set_name: "ReceiptRuleSetName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the rule set to create. The name must meet the following requirements:

    • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Start and end with a letter or number.

    • Contain 64 characters or fewer.

  • :original_rule_set_name (required, String) —

    The name of the rule set to clone.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



490
491
492
493
 
# File 'lib/aws-sdk-ses/client.rb', line 490

def clone_receipt_rule_set(params = {}, options = {})
  req = build_request(:clone_receipt_rule_set, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_configuration_set({
  configuration_set: { # required
    name: "ConfigurationSetName", # required
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set (required, Types::ConfigurationSet) —

    A data structure that contains the name of the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



524
525
526
527
 
# File 'lib/aws-sdk-ses/client.rb', line 524

def create_configuration_set(params = {}, options = {})
  req = build_request(:create_configuration_set, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_configuration_set_event_destination({
  configuration_set_name: "ConfigurationSetName", # required
  event_destination: { # required
    name: "EventDestinationName", # required
    enabled: false,
    matching_event_types: ["send"], # required, accepts send, reject, bounce, complaint, delivery, open, click, renderingFailure
    kinesis_firehose_destination: {
      iam_role_arn: "AmazonResourceName", # required
      delivery_stream_arn: "AmazonResourceName", # required
    },
    cloud_watch_destination: {
      dimension_configurations: [ # required
        {
          dimension_name: "DimensionName", # required
          dimension_value_source: "messageTag", # required, accepts messageTag, emailHeader, linkTag
          default_dimension_value: "DefaultDimensionValue", # required
        },
      ],
    },
    sns_destination: {
      topic_arn: "AmazonResourceName", # required
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set that the event destination should be associated with.

  • :event_destination (required, Types::EventDestination) —

    An object that describes the Amazon Web Services service that email sending event where information is published.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



589
590
591
592
 
# File 'lib/aws-sdk-ses/client.rb', line 589

def create_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:create_configuration_set_event_destination, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_configuration_set_tracking_options({
  configuration_set_name: "ConfigurationSetName", # required
  tracking_options: { # required
    custom_redirect_domain: "CustomRedirectDomain",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set that the tracking options should be associated with.

  • :tracking_options (required, Types::TrackingOptions) —

    A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

    For more information, see [Configuring Custom Domains to Handle Open and Click Tracking] in the *Amazon SES Developer Guide*.

    [1]: docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



637
638
639
640
 
# File 'lib/aws-sdk-ses/client.rb', line 637

def create_configuration_set_tracking_options(params = {}, options = {})
  req = build_request(:create_configuration_set_tracking_options, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_custom_verification_email_template({
  template_name: "TemplateName", # required
  from_email_address: "FromAddress", # required
  template_subject: "Subject", # required
  template_content: "TemplateContent", # required
  success_redirection_url: "SuccessRedirectionURL", # required
  failure_redirection_url: "FailureRedirectionURL", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template.

  • :from_email_address (required, String) —

    The email address that the custom verification email is sent from.

  • :template_subject (required, String) —

    The subject line of the custom verification email.

  • :template_content (required, String) —

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see [Custom Verification Email Frequently Asked Questions] in the *Amazon SES Developer Guide*.

    [1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

  • :success_redirection_url (required, String) —

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

  • :failure_redirection_url (required, String) —

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



698
699
700
701
 
# File 'lib/aws-sdk-ses/client.rb', line 698

def create_custom_verification_email_template(params = {}, options = {})
  req = build_request(:create_custom_verification_email_template, params)
  req.send_request(options)
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

Examples:

Example: CreateReceiptFilter


# The following example creates a new IP address filter:

resp = client.create_receipt_filter({
  filter: {
    ip_filter: {
      cidr: "1.2.3.4/24", 
      policy: "Allow", 
    }, 
    name: "MyFilter", 
  }, 
})

Request syntax with placeholder values


resp = client.create_receipt_filter({
  filter: { # required
    name: "ReceiptFilterName", # required
    ip_filter: { # required
      policy: "Block", # required, accepts Block, Allow
      cidr: "Cidr", # required
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (required, Types::ReceiptFilter) —

    A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



752
753
754
755
 
# File 'lib/aws-sdk-ses/client.rb', line 752

def create_receipt_filter(params = {}, options = {})
  req = build_request(:create_receipt_filter, params)
  req.send_request(options)
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

Examples:

Example: CreateReceiptRule


# The following example creates a new receipt rule:

resp = client.create_receipt_rule({
  after: "", 
  rule: {
    actions: [
      {
        s3_action: {
          bucket_name: "MyBucket", 
          object_key_prefix: "email", 
        }, 
      }, 
    ], 
    enabled: true, 
    name: "MyRule", 
    scan_enabled: true, 
    tls_policy: "Optional", 
  }, 
  rule_set_name: "MyRuleSet", 
})

Request syntax with placeholder values


resp = client.create_receipt_rule({
  rule_set_name: "ReceiptRuleSetName", # required
  after: "ReceiptRuleName",
  rule: { # required
    name: "ReceiptRuleName", # required
    enabled: false,
    tls_policy: "Require", # accepts Require, Optional
    recipients: ["Recipient"],
    actions: [
      {
        s3_action: {
          topic_arn: "AmazonResourceName",
          bucket_name: "S3BucketName", # required
          object_key_prefix: "S3KeyPrefix",
          kms_key_arn: "AmazonResourceName",
          iam_role_arn: "IAMRoleARN",
        },
        bounce_action: {
          topic_arn: "AmazonResourceName",
          smtp_reply_code: "BounceSmtpReplyCode", # required
          status_code: "BounceStatusCode",
          message: "BounceMessage", # required
          sender: "Address", # required
        },
        workmail_action: {
          topic_arn: "AmazonResourceName",
          organization_arn: "AmazonResourceName", # required
        },
        lambda_action: {
          topic_arn: "AmazonResourceName",
          function_arn: "AmazonResourceName", # required
          invocation_type: "Event", # accepts Event, RequestResponse
        },
        stop_action: {
          scope: "RuleSet", # required, accepts RuleSet
          topic_arn: "AmazonResourceName",
        },
        add_header_action: {
          header_name: "HeaderName", # required
          header_value: "HeaderValue", # required
        },
        sns_action: {
          topic_arn: "AmazonResourceName", # required
          encoding: "UTF-8", # accepts UTF-8, Base64
        },
      },
    ],
    scan_enabled: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the rule set where the receipt rule is added.

  • :after (String) —

    The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.

  • :rule (required, Types::ReceiptRule) —

    A data structure that contains the specified rule’s name, actions, recipients, domains, enabled status, scan status, and TLS policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



863
864
865
866
 
# File 'lib/aws-sdk-ses/client.rb', line 863

def create_receipt_rule(params = {}, options = {})
  req = build_request(:create_receipt_rule, params)
  req.send_request(options)
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

Examples:

Example: CreateReceiptRuleSet


# The following example creates an empty receipt rule set:

resp = client.create_receipt_rule_set({
  rule_set_name: "MyRuleSet", 
})

Request syntax with placeholder values


resp = client.create_receipt_rule_set({
  rule_set_name: "ReceiptRuleSetName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the rule set to create. The name must meet the following requirements:

    • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Start and end with a letter or number.

    • Contain 64 characters or fewer.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



911
912
913
914
 
# File 'lib/aws-sdk-ses/client.rb', line 911

def create_receipt_rule_set(params = {}, options = {})
  req = build_request(:create_receipt_rule_set, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_template({
  template: { # required
    template_name: "TemplateName", # required
    subject_part: "SubjectPart",
    text_part: "TextPart",
    html_part: "HtmlPart",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template (required, Types::Template) —

    The content of the email, composed of a subject line and either an HTML part or a text-only part.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



947
948
949
950
 
# File 'lib/aws-sdk-ses/client.rb', line 947

def create_template(params = {}, options = {})
  req = build_request(:create_template, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.delete_configuration_set({
  configuration_set_name: "ConfigurationSetName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



977
978
979
980
 
# File 'lib/aws-sdk-ses/client.rb', line 977

def delete_configuration_set(params = {}, options = {})
  req = build_request(:delete_configuration_set, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.delete_configuration_set_event_destination({
  configuration_set_name: "ConfigurationSetName", # required
  event_destination_name: "EventDestinationName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set from which to delete the event destination.

  • :event_destination_name (required, String) —

    The name of the event destination to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1013
1014
1015
1016
 
# File 'lib/aws-sdk-ses/client.rb', line 1013

def delete_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:delete_configuration_set_event_destination, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.delete_configuration_set_tracking_options({
  configuration_set_name: "ConfigurationSetName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1051
1052
1053
1054
 
# File 'lib/aws-sdk-ses/client.rb', line 1051

def delete_configuration_set_tracking_options(params = {}, options = {})
  req = build_request(:delete_configuration_set_tracking_options, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.delete_custom_verification_email_template({
  template_name: "TemplateName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1083
1084
1085
1086
 
# File 'lib/aws-sdk-ses/client.rb', line 1083

def delete_custom_verification_email_template(params = {}, options = {})
  req = build_request(:delete_custom_verification_email_template, params)
  req.send_request(options)
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.

Examples:

Example: DeleteIdentity


# The following example deletes an identity from the list of identities that have been submitted for verification with
# Amazon SES:

resp = client.delete_identity({
  identity: "user@example.com", 
})

Request syntax with placeholder values


resp = client.delete_identity({
  identity: "Identity", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity to be removed from the list of identities for the Amazon Web Services account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1119
1120
1121
1122
 
# File 'lib/aws-sdk-ses/client.rb', line 1119

def delete_identity(params = {}, options = {})
  req = build_request(:delete_identity, params)
  req.send_request(options)
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

Examples:

Example: DeleteIdentityPolicy


# The following example deletes a sending authorization policy for an identity:

resp = client.delete_identity_policy({
  identity: "user@example.com", 
  policy_name: "MyPolicy", 
})

Request syntax with placeholder values


resp = client.delete_identity_policy({
  identity: "Identity", # required
  policy_name: "PolicyName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity that is associated with the policy to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: ‘user@example.com`, `example.com`, `arn:aws:ses:us-east-1:123456789012:identity/example.com`.

    To successfully call this operation, you must own the identity.

  • :policy_name (required, String) —

    The name of the policy to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1177
1178
1179
1180
 
# File 'lib/aws-sdk-ses/client.rb', line 1177

def delete_identity_policy(params = {}, options = {})
  req = build_request(:delete_identity_policy, params)
  req.send_request(options)
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

Examples:

Example: DeleteReceiptFilter


# The following example deletes an IP address filter:

resp = client.delete_receipt_filter({
  filter_name: "MyFilter", 
})

Request syntax with placeholder values


resp = client.delete_receipt_filter({
  filter_name: "ReceiptFilterName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter_name (required, String) —

    The name of the IP address filter to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1217
1218
1219
1220
 
# File 'lib/aws-sdk-ses/client.rb', line 1217

def delete_receipt_filter(params = {}, options = {})
  req = build_request(:delete_receipt_filter, params)
  req.send_request(options)
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

Examples:

Example: DeleteReceiptRule


# The following example deletes a receipt rule:

resp = client.delete_receipt_rule({
  rule_name: "MyRule", 
  rule_set_name: "MyRuleSet", 
})

Request syntax with placeholder values


resp = client.delete_receipt_rule({
  rule_set_name: "ReceiptRuleSetName", # required
  rule_name: "ReceiptRuleName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the receipt rule set that contains the receipt rule to delete.

  • :rule_name (required, String) —

    The name of the receipt rule to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1263
1264
1265
1266
 
# File 'lib/aws-sdk-ses/client.rb', line 1263

def delete_receipt_rule(params = {}, options = {})
  req = build_request(:delete_receipt_rule, params)
  req.send_request(options)
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

Examples:

Example: DeleteReceiptRuleSet


# The following example deletes a receipt rule set:

resp = client.delete_receipt_rule_set({
  rule_set_name: "MyRuleSet", 
})

Request syntax with placeholder values


resp = client.delete_receipt_rule_set({
  rule_set_name: "ReceiptRuleSetName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the receipt rule set to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1308
1309
1310
1311
 
# File 'lib/aws-sdk-ses/client.rb', line 1308

def delete_receipt_rule_set(params = {}, options = {})
  req = build_request(:delete_receipt_rule_set, params)
  req.send_request(options)
end

#delete_template(params = {}) ⇒ Struct

Deletes an email template.

You can execute this operation no more than once per second.

Examples:

Request syntax with placeholder values


resp = client.delete_template({
  template_name: "TemplateName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1332
1333
1334
1335
 
# File 'lib/aws-sdk-ses/client.rb', line 1332

def delete_template(params = {}, options = {})
  req = build_request(:delete_template, params)
  req.send_request(options)
end

#delete_verified_email_address(params = {}) ⇒ Struct

Deprecated. Use the ‘DeleteIdentity` operation to delete email addresses and domains.

Examples:

Example: DeleteVerifiedEmailAddress


# The following example deletes an email address from the list of identities that have been submitted for verification
# with Amazon SES:

resp = client.delete_verified_email_address({
  email_address: "user@example.com", 
})

Request syntax with placeholder values


resp = client.delete_verified_email_address({
  email_address: "Address", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    An email address to be removed from the list of verified addresses.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1365
1366
1367
1368
 
# File 'lib/aws-sdk-ses/client.rb', line 1365

def delete_verified_email_address(params = {}, options = {})
  req = build_request(:delete_verified_email_address, params)
  req.send_request(options)
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

Examples:

Example: DescribeActiveReceiptRuleSet


# The following example returns the metadata and receipt rules for the receipt rule set that is currently active:

resp = client.describe_active_receipt_rule_set({
})

resp.to_h outputs the following:
{
  metadata: {
    created_timestamp: Time.parse("2016-07-15T16:25:59.607Z"), 
    name: "default-rule-set", 
  }, 
  rules: [
    {
      actions: [
        {
          s3_action: {
            bucket_name: "MyBucket", 
            object_key_prefix: "email", 
          }, 
        }, 
      ], 
      enabled: true, 
      name: "MyRule", 
      scan_enabled: true, 
      tls_policy: "Optional", 
    }, 
  ], 
}

Response structure


resp.metadata.name #=> String
resp.metadata.created_timestamp #=> Time
resp.rules #=> Array
resp.rules[0].name #=> String
resp.rules[0].enabled #=> Boolean
resp.rules[0].tls_policy #=> String, one of "Require", "Optional"
resp.rules[0].recipients #=> Array
resp.rules[0].recipients[0] #=> String
resp.rules[0].actions #=> Array
resp.rules[0].actions[0].s3_action.topic_arn #=> String
resp.rules[0].actions[0].s3_action.bucket_name #=> String
resp.rules[0].actions[0].s3_action.object_key_prefix #=> String
resp.rules[0].actions[0].s3_action.kms_key_arn #=> String
resp.rules[0].actions[0].s3_action.iam_role_arn #=> String
resp.rules[0].actions[0].bounce_action.topic_arn #=> String
resp.rules[0].actions[0].bounce_action.smtp_reply_code #=> String
resp.rules[0].actions[0].bounce_action.status_code #=> String
resp.rules[0].actions[0].bounce_action.message #=> String
resp.rules[0].actions[0].bounce_action.sender #=> String
resp.rules[0].actions[0].workmail_action.topic_arn #=> String
resp.rules[0].actions[0].workmail_action.organization_arn #=> String
resp.rules[0].actions[0].lambda_action.topic_arn #=> String
resp.rules[0].actions[0].lambda_action.function_arn #=> String
resp.rules[0].actions[0].lambda_action.invocation_type #=> String, one of "Event", "RequestResponse"
resp.rules[0].actions[0].stop_action.scope #=> String, one of "RuleSet"
resp.rules[0].actions[0].stop_action.topic_arn #=> String
resp.rules[0].actions[0].add_header_action.header_name #=> String
resp.rules[0].actions[0].add_header_action.header_value #=> String
resp.rules[0].actions[0].sns_action.topic_arn #=> String
resp.rules[0].actions[0].sns_action.encoding #=> String, one of "UTF-8", "Base64"
resp.rules[0].scan_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1457
1458
1459
1460
 
# File 'lib/aws-sdk-ses/client.rb', line 1457

def describe_active_receipt_rule_set(params = {}, options = {})
  req = build_request(:describe_active_receipt_rule_set, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.describe_configuration_set({
  configuration_set_name: "ConfigurationSetName", # required
  configuration_set_attribute_names: ["eventDestinations"], # accepts eventDestinations, trackingOptions, deliveryOptions, reputationOptions
})

Response structure


resp.configuration_set.name #=> String
resp.event_destinations #=> Array
resp.event_destinations[0].name #=> String
resp.event_destinations[0].enabled #=> Boolean
resp.event_destinations[0].matching_event_types #=> Array
resp.event_destinations[0].matching_event_types[0] #=> String, one of "send", "reject", "bounce", "complaint", "delivery", "open", "click", "renderingFailure"
resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
resp.event_destinations[0].cloud_watch_destination.dimension_configurations #=> Array
resp.event_destinations[0].cloud_watch_destination.dimension_configurations[0].dimension_name #=> String
resp.event_destinations[0].cloud_watch_destination.dimension_configurations[0].dimension_value_source #=> String, one of "messageTag", "emailHeader", "linkTag"
resp.event_destinations[0].cloud_watch_destination.dimension_configurations[0].default_dimension_value #=> String
resp.event_destinations[0].sns_destination.topic_arn #=> String
resp.tracking_options.custom_redirect_domain #=> String
resp.delivery_options.tls_policy #=> String, one of "Require", "Optional"
resp.reputation_options.sending_enabled #=> Boolean
resp.reputation_options.reputation_metrics_enabled #=> Boolean
resp.reputation_options.last_fresh_start #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set to describe.

  • :configuration_set_attribute_names (Array<String>) —

    A list of configuration set attributes to return.

Returns:

See Also:



1518
1519
1520
1521
 
# File 'lib/aws-sdk-ses/client.rb', line 1518

def describe_configuration_set(params = {}, options = {})
  req = build_request(:describe_configuration_set, params)
  req.send_request(options)
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

Examples:

Example: DescribeReceiptRule


# The following example returns the details of a receipt rule:

resp = client.describe_receipt_rule({
  rule_name: "MyRule", 
  rule_set_name: "MyRuleSet", 
})

resp.to_h outputs the following:
{
  rule: {
    actions: [
      {
        s3_action: {
          bucket_name: "MyBucket", 
          object_key_prefix: "email", 
        }, 
      }, 
    ], 
    enabled: true, 
    name: "MyRule", 
    scan_enabled: true, 
    tls_policy: "Optional", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_receipt_rule({
  rule_set_name: "ReceiptRuleSetName", # required
  rule_name: "ReceiptRuleName", # required
})

Response structure


resp.rule.name #=> String
resp.rule.enabled #=> Boolean
resp.rule.tls_policy #=> String, one of "Require", "Optional"
resp.rule.recipients #=> Array
resp.rule.recipients[0] #=> String
resp.rule.actions #=> Array
resp.rule.actions[0].s3_action.topic_arn #=> String
resp.rule.actions[0].s3_action.bucket_name #=> String
resp.rule.actions[0].s3_action.object_key_prefix #=> String
resp.rule.actions[0].s3_action.kms_key_arn #=> String
resp.rule.actions[0].s3_action.iam_role_arn #=> String
resp.rule.actions[0].bounce_action.topic_arn #=> String
resp.rule.actions[0].bounce_action.smtp_reply_code #=> String
resp.rule.actions[0].bounce_action.status_code #=> String
resp.rule.actions[0].bounce_action.message #=> String
resp.rule.actions[0].bounce_action.sender #=> String
resp.rule.actions[0].workmail_action.topic_arn #=> String
resp.rule.actions[0].workmail_action.organization_arn #=> String
resp.rule.actions[0].lambda_action.topic_arn #=> String
resp.rule.actions[0].lambda_action.function_arn #=> String
resp.rule.actions[0].lambda_action.invocation_type #=> String, one of "Event", "RequestResponse"
resp.rule.actions[0].stop_action.scope #=> String, one of "RuleSet"
resp.rule.actions[0].stop_action.topic_arn #=> String
resp.rule.actions[0].add_header_action.header_name #=> String
resp.rule.actions[0].add_header_action.header_value #=> String
resp.rule.actions[0].sns_action.topic_arn #=> String
resp.rule.actions[0].sns_action.encoding #=> String, one of "UTF-8", "Base64"
resp.rule.scan_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the receipt rule set that the receipt rule belongs to.

  • :rule_name (required, String) —

    The name of the receipt rule.

Returns:

See Also:



1614
1615
1616
1617
 
# File 'lib/aws-sdk-ses/client.rb', line 1614

def describe_receipt_rule(params = {}, options = {})
  req = build_request(:describe_receipt_rule, params)
  req.send_request(options)
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

Examples:

Example: DescribeReceiptRuleSet


# The following example returns the metadata and receipt rules of a receipt rule set:

resp = client.describe_receipt_rule_set({
  rule_set_name: "MyRuleSet", 
})

resp.to_h outputs the following:
{
  metadata: {
    created_timestamp: Time.parse("2016-07-15T16:25:59.607Z"), 
    name: "MyRuleSet", 
  }, 
  rules: [
    {
      actions: [
        {
          s3_action: {
            bucket_name: "MyBucket", 
            object_key_prefix: "email", 
          }, 
        }, 
      ], 
      enabled: true, 
      name: "MyRule", 
      scan_enabled: true, 
      tls_policy: "Optional", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_receipt_rule_set({
  rule_set_name: "ReceiptRuleSetName", # required
})

Response structure


resp.metadata.name #=> String
resp.metadata.created_timestamp #=> Time
resp.rules #=> Array
resp.rules[0].name #=> String
resp.rules[0].enabled #=> Boolean
resp.rules[0].tls_policy #=> String, one of "Require", "Optional"
resp.rules[0].recipients #=> Array
resp.rules[0].recipients[0] #=> String
resp.rules[0].actions #=> Array
resp.rules[0].actions[0].s3_action.topic_arn #=> String
resp.rules[0].actions[0].s3_action.bucket_name #=> String
resp.rules[0].actions[0].s3_action.object_key_prefix #=> String
resp.rules[0].actions[0].s3_action.kms_key_arn #=> String
resp.rules[0].actions[0].s3_action.iam_role_arn #=> String
resp.rules[0].actions[0].bounce_action.topic_arn #=> String
resp.rules[0].actions[0].bounce_action.smtp_reply_code #=> String
resp.rules[0].actions[0].bounce_action.status_code #=> String
resp.rules[0].actions[0].bounce_action.message #=> String
resp.rules[0].actions[0].bounce_action.sender #=> String
resp.rules[0].actions[0].workmail_action.topic_arn #=> String
resp.rules[0].actions[0].workmail_action.organization_arn #=> String
resp.rules[0].actions[0].lambda_action.topic_arn #=> String
resp.rules[0].actions[0].lambda_action.function_arn #=> String
resp.rules[0].actions[0].lambda_action.invocation_type #=> String, one of "Event", "RequestResponse"
resp.rules[0].actions[0].stop_action.scope #=> String, one of "RuleSet"
resp.rules[0].actions[0].stop_action.topic_arn #=> String
resp.rules[0].actions[0].add_header_action.header_name #=> String
resp.rules[0].actions[0].add_header_action.header_value #=> String
resp.rules[0].actions[0].sns_action.topic_arn #=> String
resp.rules[0].actions[0].sns_action.encoding #=> String, one of "UTF-8", "Base64"
resp.rules[0].scan_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the receipt rule set to describe.

Returns:

See Also:



1715
1716
1717
1718
 
# File 'lib/aws-sdk-ses/client.rb', line 1715

def describe_receipt_rule_set(params = {}, options = {})
  req = build_request(:describe_receipt_rule_set, params)
  req.send_request(options)
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.

Examples:

Example: GetAccountSendingEnabled


# The following example returns if sending status for an account is enabled. (true / false):

resp = client.({
})

resp.to_h outputs the following:
{
  enabled: true, 
}

Response structure


resp.enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1750
1751
1752
1753
 
# File 'lib/aws-sdk-ses/client.rb', line 1750

def (params = {}, options = {})
  req = build_request(:get_account_sending_enabled, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.get_custom_verification_email_template({
  template_name: "TemplateName", # required
})

Response structure


resp.template_name #=> String
resp.from_email_address #=> String
resp.template_subject #=> String
resp.template_content #=> String
resp.success_redirection_url #=> String
resp.failure_redirection_url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template to retrieve.

Returns:

See Also:



1799
1800
1801
1802
 
# File 'lib/aws-sdk-ses/client.rb', line 1799

def get_custom_verification_email_template(params = {}, options = {})
  req = build_request(:get_custom_verification_email_template, params)
  req.send_request(options)
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

Examples:

Example: GetIdentityDkimAttributes


# The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:

resp = client.get_identity_dkim_attributes({
  identities: [
    "example.com", 
    "user@example.com", 
  ], 
})

resp.to_h outputs the following:
{
  dkim_attributes: {
    "example.com" => {
      dkim_enabled: true, 
      dkim_tokens: [
        "EXAMPLEjcs5xoyqytjsotsijas7236gr", 
        "EXAMPLEjr76cvoc6mysspnioorxsn6ep", 
        "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k", 
      ], 
      dkim_verification_status: "Success", 
    }, 
    "user@example.com" => {
      dkim_enabled: false, 
      dkim_verification_status: "NotStarted", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_identity_dkim_attributes({
  identities: ["Identity"], # required
})

Response structure


resp.dkim_attributes #=> Hash
resp.dkim_attributes["Identity"].dkim_enabled #=> Boolean
resp.dkim_attributes["Identity"].dkim_verification_status #=> String, one of "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted"
resp.dkim_attributes["Identity"].dkim_tokens #=> Array
resp.dkim_attributes["Identity"].dkim_tokens[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identities (required, Array<String>) —

    A list of one or more verified identities - email addresses, domains, or both.

Returns:

See Also:



1888
1889
1890
1891
 
# File 'lib/aws-sdk-ses/client.rb', line 1888

def get_identity_dkim_attributes(params = {}, options = {})
  req = build_request(:get_identity_dkim_attributes, params)
  req.send_request(options)
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.

Examples:

Example: GetIdentityMailFromDomainAttributes


# The following example returns the custom MAIL FROM attributes for an identity:

resp = client.get_identity_mail_from_domain_attributes({
  identities: [
    "example.com", 
  ], 
})

resp.to_h outputs the following:
{
  mail_from_domain_attributes: {
    "example.com" => {
      behavior_on_mx_failure: "UseDefaultValue", 
      mail_from_domain: "bounces.example.com", 
      mail_from_domain_status: "Success", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_identity_mail_from_domain_attributes({
  identities: ["Identity"], # required
})

Response structure


resp.mail_from_domain_attributes #=> Hash
resp.mail_from_domain_attributes["Identity"].mail_from_domain #=> String
resp.mail_from_domain_attributes["Identity"].mail_from_domain_status #=> String, one of "Pending", "Success", "Failed", "TemporaryFailure"
resp.mail_from_domain_attributes["Identity"].behavior_on_mx_failure #=> String, one of "UseDefaultValue", "RejectMessage"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identities (required, Array<String>) —

    A list of one or more identities.

Returns:

See Also:



1945
1946
1947
1948
 
# File 'lib/aws-sdk-ses/client.rb', line 1945

def get_identity_mail_from_domain_attributes(params = {}, options = {})
  req = build_request(:get_identity_mail_from_domain_attributes, params)
  req.send_request(options)
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

Examples:

Example: GetIdentityNotificationAttributes


# The following example returns the notification attributes for an identity:

resp = client.get_identity_notification_attributes({
  identities: [
    "example.com", 
  ], 
})

resp.to_h outputs the following:
{
  notification_attributes: {
    "example.com" => {
      bounce_topic: "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", 
      complaint_topic: "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", 
      delivery_topic: "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", 
      forwarding_enabled: true, 
      headers_in_bounce_notifications_enabled: false, 
      headers_in_complaint_notifications_enabled: false, 
      headers_in_delivery_notifications_enabled: false, 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_identity_notification_attributes({
  identities: ["Identity"], # required
})

Response structure


resp.notification_attributes #=> Hash
resp.notification_attributes["Identity"].bounce_topic #=> String
resp.notification_attributes["Identity"].complaint_topic #=> String
resp.notification_attributes["Identity"].delivery_topic #=> String
resp.notification_attributes["Identity"].forwarding_enabled #=> Boolean
resp.notification_attributes["Identity"].headers_in_bounce_notifications_enabled #=> Boolean
resp.notification_attributes["Identity"].headers_in_complaint_notifications_enabled #=> Boolean
resp.notification_attributes["Identity"].headers_in_delivery_notifications_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identities (required, Array<String>) —

    A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: ‘user@example.com`, `example.com`, `arn:aws:ses:us-east-1:123456789012:identity/example.com`.

Returns:

See Also:



2020
2021
2022
2023
 
# File 'lib/aws-sdk-ses/client.rb', line 2020

def get_identity_notification_attributes(params = {}, options = {})
  req = build_request(:get_identity_notification_attributes, params)
  req.send_request(options)
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

Examples:

Example: GetIdentityPolicies


# The following example returns a sending authorization policy for an identity:

resp = client.get_identity_policies({
  identity: "example.com", 
  policy_names: [
    "MyPolicy", 
  ], 
})

resp.to_h outputs the following:
{
  policies: {
    "MyPolicy" => "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}", 
  }, 
}

Request syntax with placeholder values


resp = client.get_identity_policies({
  identity: "Identity", # required
  policy_names: ["PolicyName"], # required
})

Response structure


resp.policies #=> Hash
resp.policies["PolicyName"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity for which the policies are retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: ‘user@example.com`, `example.com`, `arn:aws:ses:us-east-1:123456789012:identity/example.com`.

    To successfully call this operation, you must own the identity.

  • :policy_names (required, Array<String>) —

    A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ‘ListIdentityPolicies`.

Returns:

See Also:



2098
2099
2100
2101
 
# File 'lib/aws-sdk-ses/client.rb', line 2098

def get_identity_policies(params = {}, options = {})
  req = build_request(:get_identity_policies, params)
  req.send_request(options)
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

Examples:

Example: GetIdentityVerificationAttributes


# The following example returns the verification status and the verification token for a domain identity:

resp = client.get_identity_verification_attributes({
  identities: [
    "example.com", 
  ], 
})

resp.to_h outputs the following:
{
  verification_attributes: {
    "example.com" => {
      verification_status: "Success", 
      verification_token: "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY=", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_identity_verification_attributes({
  identities: ["Identity"], # required
})

Response structure


resp.verification_attributes #=> Hash
resp.verification_attributes["Identity"].verification_status #=> String, one of "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted"
resp.verification_attributes["Identity"].verification_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identities (required, Array<String>) —

    A list of identities.

Returns:

See Also:



2176
2177
2178
2179
 
# File 'lib/aws-sdk-ses/client.rb', line 2176

def get_identity_verification_attributes(params = {}, options = {})
  req = build_request(:get_identity_verification_attributes, params)
  req.send_request(options)
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.

Examples:

Example: GetSendQuota


# The following example returns the Amazon SES sending limits for an AWS account:

resp = client.get_send_quota({
})

resp.to_h outputs the following:
{
  max_24_hour_send: 200, 
  max_send_rate: 1, 
  sent_last_24_hours: 1, 
}

Response structure


resp.max_24_hour_send #=> Float
resp.max_send_rate #=> Float
resp.sent_last_24_hours #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2216
2217
2218
2219
 
# File 'lib/aws-sdk-ses/client.rb', line 2216

def get_send_quota(params = {}, options = {})
  req = build_request(:get_send_quota, params)
  req.send_request(options)
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.

Examples:

Example: GetSendStatistics


# The following example returns Amazon SES sending statistics:

resp = client.get_send_statistics({
})

resp.to_h outputs the following:
{
  send_data_points: [
    {
      bounces: 0, 
      complaints: 0, 
      delivery_attempts: 5, 
      rejects: 0, 
      timestamp: Time.parse("2016-07-13T22:43:00Z"), 
    }, 
    {
      bounces: 0, 
      complaints: 0, 
      delivery_attempts: 3, 
      rejects: 0, 
      timestamp: Time.parse("2016-07-13T23:13:00Z"), 
    }, 
    {
      bounces: 0, 
      complaints: 0, 
      delivery_attempts: 1, 
      rejects: 0, 
      timestamp: Time.parse("2016-07-13T21:13:00Z"), 
    }, 
  ], 
}

Response structure


resp.send_data_points #=> Array
resp.send_data_points[0].timestamp #=> Time
resp.send_data_points[0].delivery_attempts #=> Integer
resp.send_data_points[0].bounces #=> Integer
resp.send_data_points[0].complaints #=> Integer
resp.send_data_points[0].rejects #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2280
2281
2282
2283
 
# File 'lib/aws-sdk-ses/client.rb', line 2280

def get_send_statistics(params = {}, options = {})
  req = build_request(:get_send_statistics, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_template({
  template_name: "TemplateName", # required
})

Response structure


resp.template.template_name #=> String
resp.template.subject_part #=> String
resp.template.text_part #=> String
resp.template.html_part #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template to retrieve.

Returns:

See Also:



2314
2315
2316
2317
 
# File 'lib/aws-sdk-ses/client.rb', line 2314

def get_template(params = {}, options = {})
  req = build_request(:get_template, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.list_configuration_sets({
  next_token: "NextToken",
  max_items: 1,
})

Response structure


resp.configuration_sets #=> Array
resp.configuration_sets[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListConfigurationSets` to indicate the position of the configuration set in the configuration set list.

  • :max_items (Integer) —

    The number of configuration sets to return.

Returns:

See Also:



2366
2367
2368
2369
 
# File 'lib/aws-sdk-ses/client.rb', line 2366

def list_configuration_sets(params = {}, options = {})
  req = build_request(:list_configuration_sets, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_custom_verification_email_templates({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.custom_verification_email_templates #=> Array
resp.custom_verification_email_templates[0].template_name #=> String
resp.custom_verification_email_templates[0].from_email_address #=> String
resp.custom_verification_email_templates[0].template_subject #=> String
resp.custom_verification_email_templates[0].success_redirection_url #=> String
resp.custom_verification_email_templates[0].failure_redirection_url #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    An array the contains the name and creation time stamp for each template in your Amazon SES account.

  • :max_results (Integer) —

    The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation returns up to 50 results.

Returns:

See Also:



2422
2423
2424
2425
 
# File 'lib/aws-sdk-ses/client.rb', line 2422

def list_custom_verification_email_templates(params = {}, options = {})
  req = build_request(:list_custom_verification_email_templates, params)
  req.send_request(options)
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.

Examples:

Example: ListIdentities


# The following example lists the email address identities that have been submitted for verification with Amazon SES:

resp = client.list_identities({
  identity_type: "EmailAddress", 
  max_items: 123, 
  next_token: "", 
})

resp.to_h outputs the following:
{
  identities: [
    "user@example.com", 
  ], 
  next_token: "", 
}

Request syntax with placeholder values


resp = client.list_identities({
  identity_type: "EmailAddress", # accepts EmailAddress, Domain
  next_token: "NextToken",
  max_items: 1,
})

Response structure


resp.identities #=> Array
resp.identities[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity_type (String) —

    The type of the identities to list. Possible values are “EmailAddress” and “Domain”. If this parameter is omitted, then all identities are listed.

  • :next_token (String) —

    The token to use for pagination.

  • :max_items (Integer) —

    The maximum number of identities per page. Possible values are 1-1000 inclusive.

Returns:

See Also:



2501
2502
2503
2504
 
# File 'lib/aws-sdk-ses/client.rb', line 2501

def list_identities(params = {}, options = {})
  req = build_request(:list_identities, params)
  req.send_request(options)
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

Examples:

Example: ListIdentityPolicies


# The following example returns a list of sending authorization policies that are attached to an identity:

resp = client.list_identity_policies({
  identity: "example.com", 
})

resp.to_h outputs the following:
{
  policy_names: [
    "MyPolicy", 
  ], 
}

Request syntax with placeholder values


resp = client.list_identity_policies({
  identity: "Identity", # required
})

Response structure


resp.policy_names #=> Array
resp.policy_names[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity that is associated with the policy for which the policies are listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: ‘user@example.com`, `example.com`, `arn:aws:ses:us-east-1:123456789012:identity/example.com`.

    To successfully call this operation, you must own the identity.

Returns:

See Also:



2570
2571
2572
2573
 
# File 'lib/aws-sdk-ses/client.rb', line 2570

def list_identity_policies(params = {}, options = {})
  req = build_request(:list_identity_policies, params)
  req.send_request(options)
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

Examples:

Example: ListReceiptFilters


# The following example lists the IP address filters that are associated with an AWS account:

resp = client.list_receipt_filters({
})

resp.to_h outputs the following:
{
  filters: [
    {
      ip_filter: {
        cidr: "1.2.3.4/24", 
        policy: "Block", 
      }, 
      name: "MyFilter", 
    }, 
  ], 
}

Response structure


resp.filters #=> Array
resp.filters[0].name #=> String
resp.filters[0].ip_filter.policy #=> String, one of "Block", "Allow"
resp.filters[0].ip_filter.cidr #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2623
2624
2625
2626
 
# File 'lib/aws-sdk-ses/client.rb', line 2623

def list_receipt_filters(params = {}, options = {})
  req = build_request(:list_receipt_filters, params)
  req.send_request(options)
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

Examples:

Example: ListReceiptRuleSets


# The following example lists the receipt rule sets that exist under an AWS account:

resp = client.list_receipt_rule_sets({
  next_token: "", 
})

resp.to_h outputs the following:
{
  next_token: "", 
  rule_sets: [
    {
      created_timestamp: Time.parse("2016-07-15T16:25:59.607Z"), 
      name: "MyRuleSet", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_receipt_rule_sets({
  next_token: "NextToken",
})

Response structure


resp.rule_sets #=> Array
resp.rule_sets[0].name #=> String
resp.rule_sets[0].created_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListReceiptRuleSets` to indicate the position in the receipt rule set list.

Returns:

See Also:



2689
2690
2691
2692
 
# File 'lib/aws-sdk-ses/client.rb', line 2689

def list_receipt_rule_sets(params = {}, options = {})
  req = build_request(:list_receipt_rule_sets, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_templates({
  next_token: "NextToken",
  max_items: 1,
})

Response structure


resp.templates_metadata #=> Array
resp.templates_metadata[0].name #=> String
resp.templates_metadata[0].created_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListTemplates` to indicate the position in the list of email templates.

  • :max_items (Integer) —

    The maximum number of templates to return. This value must be at least 1 and less than or equal to 100. If more than 100 items are requested, the page size will automatically set to 100. If you do not specify a value, 10 is the default page size.

Returns:

See Also:



2732
2733
2734
2735
 
# File 'lib/aws-sdk-ses/client.rb', line 2732

def list_templates(params = {}, options = {})
  req = build_request(:list_templates, params)
  req.send_request(options)
end

#list_verified_email_addresses(params = {}) ⇒ Types::ListVerifiedEmailAddressesResponse

Deprecated. Use the ‘ListIdentities` operation to list the email addresses and domains associated with your account.

Examples:

Example: ListVerifiedEmailAddresses


# The following example lists all email addresses that have been submitted for verification with Amazon SES:

resp = client.list_verified_email_addresses({
})

resp.to_h outputs the following:
{
  verified_email_addresses: [
    "user1@example.com", 
    "user2@example.com", 
  ], 
}

Response structure


resp.verified_email_addresses #=> Array
resp.verified_email_addresses[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2769
2770
2771
2772
 
# File 'lib/aws-sdk-ses/client.rb', line 2769

def list_verified_email_addresses(params = {}, options = {})
  req = build_request(:list_verified_email_addresses, params)
  req.send_request(options)
end

#put_configuration_set_delivery_options(params = {}) ⇒ Struct

Adds or updates the delivery options for a configuration set.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_set_delivery_options({
  configuration_set_name: "ConfigurationSetName", # required
  delivery_options: {
    tls_policy: "Require", # accepts Require, Optional
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set.

  • :delivery_options (Types::DeliveryOptions) —

    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2798
2799
2800
2801
 
# File 'lib/aws-sdk-ses/client.rb', line 2798

def put_configuration_set_delivery_options(params = {}, options = {})
  req = build_request(:put_configuration_set_delivery_options, params)
  req.send_request(options)
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

Examples:

Example: PutIdentityPolicy


# The following example adds a sending authorization policy to an identity:

resp = client.put_identity_policy({
  identity: "example.com", 
  policy: "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}", 
  policy_name: "MyPolicy", 
})

Request syntax with placeholder values


resp = client.put_identity_policy({
  identity: "Identity", # required
  policy_name: "PolicyName", # required
  policy: "Policy", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity to which that the policy applies. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: ‘user@example.com`, `example.com`, `arn:aws:ses:us-east-1:123456789012:identity/example.com`.

    To successfully call this operation, you must own the identity.

  • :policy_name (required, String) —

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

  • :policy (required, String) —

    The text of the policy in JSON format. The policy cannot exceed 4 KB.

    For information about the syntax of sending authorization policies, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-policies.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2870
2871
2872
2873
 
# File 'lib/aws-sdk-ses/client.rb', line 2870

def put_identity_policy(params = {}, options = {})
  req = build_request(:put_identity_policy, params)
  req.send_request(options)
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

Examples:

Example: ReorderReceiptRuleSet


# The following example reorders the receipt rules within a receipt rule set:

resp = client.reorder_receipt_rule_set({
  rule_names: [
    "MyRule", 
    "MyOtherRule", 
  ], 
  rule_set_name: "MyRuleSet", 
})

Request syntax with placeholder values


resp = client.reorder_receipt_rule_set({
  rule_set_name: "ReceiptRuleSetName", # required
  rule_names: ["ReceiptRuleName"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the receipt rule set to reorder.

  • :rule_names (required, Array<String>) —

    The specified receipt rule set’s receipt rules, in order.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2924
2925
2926
2927
 
# File 'lib/aws-sdk-ses/client.rb', line 2924

def reorder_receipt_rule_set(params = {}, options = {})
  req = build_request(:reorder_receipt_rule_set, params)
  req.send_request(options)
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.

[1]: docs.aws.amazon.com/ses/latest/dg/receiving-email.html

Examples:

Request syntax with placeholder values


resp = client.send_bounce({
  original_message_id: "MessageId", # required
  bounce_sender: "Address", # required
  explanation: "Explanation",
  message_dsn: {
    reporting_mta: "ReportingMta", # required
    arrival_date: Time.now,
    extension_fields: [
      {
        name: "ExtensionFieldName", # required
        value: "ExtensionFieldValue", # required
      },
    ],
  },
  bounced_recipient_info_list: [ # required
    {
      recipient: "Address", # required
      recipient_arn: "AmazonResourceName",
      bounce_type: "DoesNotExist", # accepts DoesNotExist, MessageTooLarge, ExceededQuota, ContentRejected, Undefined, TemporaryFailure
      recipient_dsn_fields: {
        final_recipient: "Address",
        action: "failed", # required, accepts failed, delayed, delivered, relayed, expanded
        remote_mta: "RemoteMta",
        status: "DsnStatus", # required
        diagnostic_code: "DiagnosticCode",
        last_attempt_date: Time.now,
        extension_fields: [
          {
            name: "ExtensionFieldName", # required
            value: "ExtensionFieldValue", # required
          },
        ],
      },
    },
  ],
  bounce_sender_arn: "AmazonResourceName",
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :original_message_id (required, String) —

    The message ID of the message to be bounced.

  • :bounce_sender (required, String) —

    The address to use in the “From” header of the bounce message. This must be an identity that you have verified with Amazon SES.

  • :explanation (String) —

    Human-readable text for the bounce message to explain the failure. If not specified, the text is auto-generated based on the bounced recipient information.

  • :message_dsn (Types::MessageDsn) —

    Message-related DSN fields. If not specified, Amazon SES chooses the values.

  • :bounced_recipient_info_list (required, Array<Types::BouncedRecipientInfo>) —

    A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one ‘BouncedRecipientInfo` in the list.

  • :bounce_sender_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the “From” header of the bounce. For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

Returns:

See Also:



3032
3033
3034
3035
 
# File 'lib/aws-sdk-ses/client.rb', line 3032

def send_bounce(params = {}, options = {})
  req = build_request(:send_bounce, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.send_bulk_templated_email({
  source: "Address", # required
  source_arn: "AmazonResourceName",
  reply_to_addresses: ["Address"],
  return_path: "Address",
  return_path_arn: "AmazonResourceName",
  configuration_set_name: "ConfigurationSetName",
  default_tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  template: "TemplateName", # required
  template_arn: "AmazonResourceName",
  default_template_data: "TemplateData", # required
  destinations: [ # required
    {
      destination: { # required
        to_addresses: ["Address"],
        cc_addresses: ["Address"],
        bcc_addresses: ["Address"],
      },
      replacement_tags: [
        {
          name: "MessageTagName", # required
          value: "MessageTagValue", # required
        },
      ],
      replacement_template_data: "TemplateData",
    },
  ],
})

Response structure


resp.status #=> Array
resp.status[0].status #=> String, one of "Success", "MessageRejected", "MailFromDomainNotVerified", "ConfigurationSetDoesNotExist", "TemplateDoesNotExist", "AccountSuspended", "AccountThrottled", "AccountDailyQuotaExceeded", "InvalidSendingPoolName", "AccountSendingPaused", "ConfigurationSetSendingPaused", "InvalidParameterValue", "TransientFailure", "Failed"
resp.status[0].error #=> String
resp.status[0].message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source (required, String) —

    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the [Amazon SES Developer Guide].

    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the ‘SourceArn` parameter. For more information about sending authorization, see the [Amazon SES Developer Guide].

    <note markdown=“1”> Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the “friendly from” name. If you want to use Unicode characters in the “friendly from” name, you must encode the “friendly from” name using MIME encoded-word syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492].

    </note>

    [1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html [2]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html [3]: tools.ietf.org/html/rfc6531 [4]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [5]: tools.ietf.org/html/rfc3492

  • :source_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the ‘Source` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to send from `user@example.com`, then you would specify the `SourceArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `Source` to be `user@example.com`.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

  • :reply_to_addresses (Array<String>) —

    The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

  • :return_path (String) —

    The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient’s ISP; this message is forwarded to the email address specified by the ‘ReturnPath` parameter. The `ReturnPath` parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

  • :return_path_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘ReturnPath` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to use `feedback@example.com`, then you would specify the `ReturnPathArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `ReturnPath` to be `feedback@example.com`.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

  • :configuration_set_name (String) —

    The name of the configuration set to use when you send an email using ‘SendBulkTemplatedEmail`.

  • :default_tags (Array<Types::MessageTag>) —

    A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using ‘SendBulkTemplatedEmail`.

  • :template (required, String) —

    The template to use when sending this email.

  • :template_arn (String) —

    The ARN of the template to use when sending this email.

  • :default_template_data (required, String) —

    A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

    The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

  • :destinations (required, Array<Types::BulkEmailDestination>) —

    One or more ‘Destination` objects. All of the recipients in a `Destination` receive the same version of the email. You can specify up to 50 `Destination` objects within a `Destinations` array.

Returns:

See Also:



3243
3244
3245
3246
 
# File 'lib/aws-sdk-ses/client.rb', line 3243

def send_bulk_templated_email(params = {}, options = {})
  req = build_request(:send_bulk_templated_email, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.send_custom_verification_email({
  email_address: "Address", # required
  template_name: "TemplateName", # required
  configuration_set_name: "ConfigurationSetName",
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    The email address to verify.

  • :template_name (required, String) —

    The name of the custom verification email template to use when sending the verification email.

  • :configuration_set_name (String) —

    Name of a configuration set to use when sending the verification email.

Returns:

See Also:



3295
3296
3297
3298
 
# File 'lib/aws-sdk-ses/client.rb', line 3295

def send_custom_verification_email(params = {}, options = {})
  req = build_request(:send_custom_verification_email, params)
  req.send_request(options)
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

Examples:

Example: SendEmail


# The following example sends a formatted email:

resp = client.send_email({
  destination: {
    bcc_addresses: [
    ], 
    cc_addresses: [
      "recipient3@example.com", 
    ], 
    to_addresses: [
      "recipient1@example.com", 
      "recipient2@example.com", 
    ], 
  }, 
  message: {
    body: {
      html: {
        charset: "UTF-8", 
        data: "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>.", 
      }, 
      text: {
        charset: "UTF-8", 
        data: "This is the message body in text format.", 
      }, 
    }, 
    subject: {
      charset: "UTF-8", 
      data: "Test email", 
    }, 
  }, 
  reply_to_addresses: [
  ], 
  return_path: "", 
  return_path_arn: "", 
  source: "sender@example.com", 
  source_arn: "", 
})

resp.to_h outputs the following:
{
  message_id: "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000", 
}

Request syntax with placeholder values


resp = client.send_email({
  source: "Address", # required
  destination: { # required
    to_addresses: ["Address"],
    cc_addresses: ["Address"],
    bcc_addresses: ["Address"],
  },
  message: { # required
    subject: { # required
      data: "MessageData", # required
      charset: "Charset",
    },
    body: { # required
      text: {
        data: "MessageData", # required
        charset: "Charset",
      },
      html: {
        data: "MessageData", # required
        charset: "Charset",
      },
    },
  },
  reply_to_addresses: ["Address"],
  return_path: "Address",
  source_arn: "AmazonResourceName",
  return_path_arn: "AmazonResourceName",
  tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  configuration_set_name: "ConfigurationSetName",
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source (required, String) —

    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the [Amazon SES Developer Guide].

    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the ‘SourceArn` parameter. For more information about sending authorization, see the [Amazon SES Developer Guide].

    <note markdown=“1”> Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the “friendly from” name. If you want to use Unicode characters in the “friendly from” name, you must encode the “friendly from” name using MIME encoded-word syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492].

    </note>

    [1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html [2]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html [3]: tools.ietf.org/html/rfc6531 [4]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [5]: tools.ietf.org/html/rfc3492

  • :destination (required, Types::Destination) —

    The destination for this email, composed of To:, CC:, and BCC: fields.

  • :message (required, Types::Message) —

    The message to be sent.

  • :reply_to_addresses (Array<String>) —

    The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

  • :return_path (String) —

    The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient’s ISP; this message is forwarded to the email address specified by the ‘ReturnPath` parameter. The `ReturnPath` parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

  • :source_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the ‘Source` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to send from `user@example.com`, then you would specify the `SourceArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `Source` to be `user@example.com`.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

  • :return_path_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘ReturnPath` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to use `feedback@example.com`, then you would specify the `ReturnPathArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `ReturnPath` to be `feedback@example.com`.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

  • :tags (Array<Types::MessageTag>) —

    A list of tags, in the form of name/value pairs, to apply to an email that you send using ‘SendEmail`. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • :configuration_set_name (String) —

    The name of the configuration set to use when you send an email using ‘SendEmail`.

Returns:

See Also:



3540
3541
3542
3543
 
# File 'lib/aws-sdk-ses/client.rb', line 3540

def send_email(params = {}, options = {})
  req = build_request(:send_email, params)
  req.send_request(options)
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

Examples:

Example: SendRawEmail


# The following example sends an email with an attachment:

resp = client.send_raw_email({
  destinations: [
  ], 
  from_arn: "", 
  raw_message: {
    data: "From: sender@example.com\\nTo: recipient@example.com\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--", 
  }, 
  return_path_arn: "", 
  source: "", 
  source_arn: "", 
})

resp.to_h outputs the following:
{
  message_id: "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000", 
}

Request syntax with placeholder values


resp = client.send_raw_email({
  source: "Address",
  destinations: ["Address"],
  raw_message: { # required
    data: "data", # required
  },
  from_arn: "AmazonResourceName",
  source_arn: "AmazonResourceName",
  return_path_arn: "AmazonResourceName",
  tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  configuration_set_name: "ConfigurationSetName",
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source (String) —

    The identity’s email address. If you do not provide a value for this parameter, you must specify a “From” address in the raw text of the message. (You can also specify both.)

    <note markdown=“1”> Amazon SES does not support the SMTPUTF8 extension, as described in[1]. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the “friendly from” name. If you want to use Unicode characters in the “friendly from” name, you must encode the “friendly from” name using MIME encoded-word syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492].

    </note>

    If you specify the ‘Source` parameter and have feedback forwarding enabled, then bounces and complaints are sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

    [1]: tools.ietf.org/html/rfc6531 [2]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [3]: tools.ietf.org/html/rfc3492

  • :destinations (Array<String>) —

    A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

  • :raw_message (required, Types::RawMessage) —

    The raw email message itself. The message has to meet the following criteria:

    • The message has to contain a header and a body, separated by a blank line.

    • All of the required header fields must be present in the message.

    • Each part of a multipart MIME message must be formatted properly.

    • Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see [Unsupported Attachment Types] in the *Amazon SES Developer Guide*.

    • The entire message must be base64-encoded.

    • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see [Sending Raw Email] in the *Amazon SES Developer Guide*.

    • Per [RFC 5321], the maximum length of each line of text, including the &lt;CRLF&gt;, must not exceed 1,000 characters.

    [1]: docs.aws.amazon.com/ses/latest/dg/mime-types.html [2]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [3]: tools.ietf.org/html/rfc5321#section-4.5.3.1.6

  • :from_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular “From” address in the header of the raw email.

    Instead of using this parameter, you can use the X-header ‘X-SES-FROM-ARN` in the raw message of the email. If you use both the `FromArn` parameter and the corresponding X-header, Amazon SES uses the value of the `FromArn` parameter.

    <note markdown=“1”> For information about when to use this parameter, see the description of ‘SendRawEmail` in this guide, or see the [Amazon SES Developer Guide].

    </note>

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html

  • :source_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the ‘Source` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to send from `user@example.com`, then you would specify the `SourceArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `Source` to be `user@example.com`.

    Instead of using this parameter, you can use the X-header ‘X-SES-SOURCE-ARN` in the raw message of the email. If you use both the `SourceArn` parameter and the corresponding X-header, Amazon SES uses the value of the `SourceArn` parameter.

    <note markdown=“1”> For information about when to use this parameter, see the description of ‘SendRawEmail` in this guide, or see the [Amazon SES Developer Guide].

    </note>

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html

  • :return_path_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘ReturnPath` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to use `feedback@example.com`, then you would specify the `ReturnPathArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `ReturnPath` to be `feedback@example.com`.

    Instead of using this parameter, you can use the X-header ‘X-SES-RETURN-PATH-ARN` in the raw message of the email. If you use both the `ReturnPathArn` parameter and the corresponding X-header, Amazon SES uses the value of the `ReturnPathArn` parameter.

    <note markdown=“1”> For information about when to use this parameter, see the description of ‘SendRawEmail` in this guide, or see the [Amazon SES Developer Guide].

    </note>

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html

  • :tags (Array<Types::MessageTag>) —

    A list of tags, in the form of name/value pairs, to apply to an email that you send using ‘SendRawEmail`. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • :configuration_set_name (String) —

    The name of the configuration set to use when you send an email using ‘SendRawEmail`.

Returns:

See Also:



3847
3848
3849
3850
 
# File 'lib/aws-sdk-ses/client.rb', line 3847

def send_raw_email(params = {}, options = {})
  req = build_request(:send_raw_email, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.send_templated_email({
  source: "Address", # required
  destination: { # required
    to_addresses: ["Address"],
    cc_addresses: ["Address"],
    bcc_addresses: ["Address"],
  },
  reply_to_addresses: ["Address"],
  return_path: "Address",
  source_arn: "AmazonResourceName",
  return_path_arn: "AmazonResourceName",
  tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  configuration_set_name: "ConfigurationSetName",
  template: "TemplateName", # required
  template_arn: "AmazonResourceName",
  template_data: "TemplateData", # required
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source (required, String) —

    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the [Amazon SES Developer Guide].

    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the ‘SourceArn` parameter. For more information about sending authorization, see the [Amazon SES Developer Guide].

    <note markdown=“1”> Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. for this reason, The email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the “friendly from” name. If you want to use Unicode characters in the “friendly from” name, you must encode the “friendly from” name using MIME encoded-word syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492].

    </note>

    [1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html [2]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html [3]: tools.ietf.org/html/rfc6531 [4]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [5]: tools.ietf.org/html/rfc3492

  • :destination (required, Types::Destination) —

    The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

  • :reply_to_addresses (Array<String>) —

    The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

  • :return_path (String) —

    The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient’s ISP; this message is forwarded to the email address specified by the ‘ReturnPath` parameter. The `ReturnPath` parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

  • :source_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the ‘Source` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to send from `user@example.com`, then you would specify the `SourceArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `Source` to be `user@example.com`.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

  • :return_path_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘ReturnPath` parameter.

    For example, if the owner of ‘example.com` (which has ARN `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a policy to it that authorizes you to use `feedback@example.com`, then you would specify the `ReturnPathArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `ReturnPath` to be `feedback@example.com`.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

  • :tags (Array<Types::MessageTag>) —

    A list of tags, in the form of name/value pairs, to apply to an email that you send using ‘SendTemplatedEmail`. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • :configuration_set_name (String) —

    The name of the configuration set to use when you send an email using ‘SendTemplatedEmail`.

  • :template (required, String) —

    The template to use when sending this email.

  • :template_arn (String) —

    The ARN of the template to use when sending this email.

  • :template_data (required, String) —

    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns:

See Also:



4052
4053
4054
4055
 
# File 'lib/aws-sdk-ses/client.rb', line 4052

def send_templated_email(params = {}, options = {})
  req = build_request(:send_templated_email, params)
  req.send_request(options)
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

Examples:

Example: SetActiveReceiptRuleSet


# The following example sets the active receipt rule set:

resp = client.set_active_receipt_rule_set({
  rule_set_name: "RuleSetToActivate", 
})

Request syntax with placeholder values


resp = client.set_active_receipt_rule_set({
  rule_set_name: "ReceiptRuleSetName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (String) —

    The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4098
4099
4100
4101
 
# File 'lib/aws-sdk-ses/client.rb', line 4098

def set_active_receipt_rule_set(params = {}, options = {})
  req = build_request(:set_active_receipt_rule_set, params)
  req.send_request(options)
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

Examples:

Example: SetIdentityDkimEnabled


# The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:

resp = client.set_identity_dkim_enabled({
  dkim_enabled: true, 
  identity: "user@example.com", 
})

Request syntax with placeholder values


resp = client.set_identity_dkim_enabled({
  identity: "Identity", # required
  dkim_enabled: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity for which DKIM signing should be enabled or disabled.

  • :dkim_enabled (required, Boolean) —

    Sets whether DKIM signing is enabled for an identity. Set to ‘true` to enable DKIM signing for this identity; `false` to disable it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4158
4159
4160
4161
 
# File 'lib/aws-sdk-ses/client.rb', line 4158

def set_identity_dkim_enabled(params = {}, options = {})
  req = build_request(:set_identity_dkim_enabled, params)
  req.send_request(options)
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

Examples:

Example: SetIdentityFeedbackForwardingEnabled


# The following example configures Amazon SES to forward an identity's bounces and complaints via email:

resp = client.set_identity_feedback_forwarding_enabled({
  forwarding_enabled: true, 
  identity: "user@example.com", 
})

Request syntax with placeholder values


resp = client.set_identity_feedback_forwarding_enabled({
  identity: "Identity", # required
  forwarding_enabled: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity for which to set bounce and complaint notification forwarding. Examples: ‘user@example.com`, `example.com`.

  • :forwarding_enabled (required, Boolean) —

    Sets whether Amazon SES forwards bounce and complaint notifications as email. ‘true` specifies that Amazon SES forwards bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. `false` specifies that Amazon SES publishes bounce and complaint notifications only through Amazon SNS. This value can only be set to `false` when Amazon SNS topics are set for both `Bounce` and `Complaint` notification types.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4219
4220
4221
4222
 
# File 'lib/aws-sdk-ses/client.rb', line 4219

def set_identity_feedback_forwarding_enabled(params = {}, options = {})
  req = build_request(:set_identity_feedback_forwarding_enabled, params)
  req.send_request(options)
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

Examples:

Example: SetIdentityHeadersInNotificationsEnabled


# The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications
# for an identity:

resp = client.set_identity_headers_in_notifications_enabled({
  enabled: true, 
  identity: "user@example.com", 
  notification_type: "Bounce", 
})

Request syntax with placeholder values


resp = client.set_identity_headers_in_notifications_enabled({
  identity: "Identity", # required
  notification_type: "Bounce", # required, accepts Bounce, Complaint, Delivery
  enabled: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity for which to enable or disable headers in notifications. Examples: ‘user@example.com`, `example.com`.

  • :notification_type (required, String) —

    The notification type for which to enable or disable headers in notifications.

  • :enabled (required, Boolean) —

    Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of ‘true` specifies that Amazon SES includes headers in notifications, and a value of `false` specifies that Amazon SES does not include headers in notifications.

    This value can only be set when ‘NotificationType` is already set to use a particular Amazon SNS topic.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4281
4282
4283
4284
 
# File 'lib/aws-sdk-ses/client.rb', line 4281

def set_identity_headers_in_notifications_enabled(params = {}, options = {})
  req = build_request(:set_identity_headers_in_notifications_enabled, params)
  req.send_request(options)
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.

[1]: docs.aws.amazon.com/ses/latest/dg/mail-from.html

Examples:

Example: SetIdentityMailFromDomain


# The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:

resp = client.set_identity_mail_from_domain({
  behavior_on_mx_failure: "UseDefaultValue", 
  identity: "user@example.com", 
  mail_from_domain: "bounces.example.com", 
})

Request syntax with placeholder values


resp = client.set_identity_mail_from_domain({
  identity: "Identity", # required
  mail_from_domain: "MailFromDomainName",
  behavior_on_mx_failure: "UseDefaultValue", # accepts UseDefaultValue, RejectMessage
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The verified identity.

  • :mail_from_domain (String) —

    The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a “From” address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the [Amazon SES Developer Guide]), and 3) not be used to receive emails. A value of ‘null` disables the custom MAIL FROM setting for the identity.

    [1]: docs.aws.amazon.com/ses/latest/dg/mail-from.html

  • :behavior_on_mx_failure (String) —

    The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose ‘UseDefaultValue`, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose `RejectMessage`, Amazon SES returns a `MailFromDomainNotVerified` error and not send the email.

    The action specified in ‘BehaviorOnMXFailure` is taken when the custom MAIL FROM domain setup is in the `Pending`, `Failed`, and `TemporaryFailure` states.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4354
4355
4356
4357
 
# File 'lib/aws-sdk-ses/client.rb', line 4354

def set_identity_mail_from_domain(params = {}, options = {})
  req = build_request(:set_identity_mail_from_domain, params)
  req.send_request(options)
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

Examples:

Example: SetIdentityNotificationTopic


# The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery
# notifications for emails sent with the specified identity as the Source:

resp = client.set_identity_notification_topic({
  identity: "user@example.com", 
  notification_type: "Bounce", 
  sns_topic: "arn:aws:sns:us-west-2:111122223333:MyTopic", 
})

Request syntax with placeholder values


resp = client.set_identity_notification_topic({
  identity: "Identity", # required
  notification_type: "Bounce", # required, accepts Bounce, Complaint, Delivery
  sns_topic: "NotificationTopic",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity (required, String) —

    The identity (email address or domain) for the Amazon SNS topic.

    You can only specify a verified identity for this parameter.

    You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: ‘sender@example.com`, `example.com`, `arn:aws:ses:us-east-1:123456789012:identity/example.com`.

  • :notification_type (required, String) —

    The type of notifications that are published to the specified Amazon SNS topic.

  • :sns_topic (String) —

    The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, ‘SnsTopic` is cleared and publishing is disabled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4421
4422
4423
4424
 
# File 'lib/aws-sdk-ses/client.rb', line 4421

def set_identity_notification_topic(params = {}, options = {})
  req = build_request(:set_identity_notification_topic, params)
  req.send_request(options)
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

Examples:

Example: SetReceiptRulePosition


# The following example sets the position of a receipt rule in a receipt rule set:

resp = client.set_receipt_rule_position({
  after: "PutRuleAfterThisRule", 
  rule_name: "RuleToReposition", 
  rule_set_name: "MyRuleSet", 
})

Request syntax with placeholder values


resp = client.set_receipt_rule_position({
  rule_set_name: "ReceiptRuleSetName", # required
  rule_name: "ReceiptRuleName", # required
  after: "ReceiptRuleName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the receipt rule set that contains the receipt rule to reposition.

  • :rule_name (required, String) —

    The name of the receipt rule to reposition.

  • :after (String) —

    The name of the receipt rule after which to place the specified receipt rule.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4474
4475
4476
4477
 
# File 'lib/aws-sdk-ses/client.rb', line 4474

def set_receipt_rule_position(params = {}, options = {})
  req = build_request(:set_receipt_rule_position, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.test_render_template({
  template_name: "TemplateName", # required
  template_data: "TemplateData", # required
})

Response structure


resp.rendered_template #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template to render.

  • :template_data (required, String) —

    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns:

See Also:



4511
4512
4513
4514
 
# File 'lib/aws-sdk-ses/client.rb', line 4511

def test_render_template(params = {}, options = {})
  req = build_request(:test_render_template, params)
  req.send_request(options)
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.

Examples:

Example: UpdateAccountSendingEnabled


# The following example updated the sending status for this account.

resp = client.({
  enabled: true, 
})

Request syntax with placeholder values


resp = client.({
  enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enabled (Boolean) —

    Describes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4550
4551
4552
4553
 
# File 'lib/aws-sdk-ses/client.rb', line 4550

def (params = {}, options = {})
  req = build_request(:update_account_sending_enabled, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.update_configuration_set_event_destination({
  configuration_set_name: "ConfigurationSetName", # required
  event_destination: { # required
    name: "EventDestinationName", # required
    enabled: false,
    matching_event_types: ["send"], # required, accepts send, reject, bounce, complaint, delivery, open, click, renderingFailure
    kinesis_firehose_destination: {
      iam_role_arn: "AmazonResourceName", # required
      delivery_stream_arn: "AmazonResourceName", # required
    },
    cloud_watch_destination: {
      dimension_configurations: [ # required
        {
          dimension_name: "DimensionName", # required
          dimension_value_source: "messageTag", # required, accepts messageTag, emailHeader, linkTag
          default_dimension_value: "DefaultDimensionValue", # required
        },
      ],
    },
    sns_destination: {
      topic_arn: "AmazonResourceName", # required
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set that contains the event destination.

  • :event_destination (required, Types::EventDestination) —

    The event destination object.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4614
4615
4616
4617
 
# File 'lib/aws-sdk-ses/client.rb', line 4614

def update_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:update_configuration_set_event_destination, params)
  req.send_request(options)
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.

Examples:

Example: UpdateConfigurationSetReputationMetricsEnabled


# Set the reputationMetricsEnabled flag for a specific configuration set.

resp = client.update_configuration_set_reputation_metrics_enabled({
  configuration_set_name: "foo", 
  enabled: true, 
})

Request syntax with placeholder values


resp = client.update_configuration_set_reputation_metrics_enabled({
  configuration_set_name: "ConfigurationSetName", # required
  enabled: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set to update.

  • :enabled (required, Boolean) —

    Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4659
4660
4661
4662
 
# File 'lib/aws-sdk-ses/client.rb', line 4659

def update_configuration_set_reputation_metrics_enabled(params = {}, options = {})
  req = build_request(:update_configuration_set_reputation_metrics_enabled, params)
  req.send_request(options)
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.

Examples:

Example: UpdateConfigurationSetReputationMetricsEnabled


# Set the sending enabled flag for a specific configuration set.

resp = client.update_configuration_set_sending_enabled({
  configuration_set_name: "foo", 
  enabled: true, 
})

Request syntax with placeholder values


resp = client.update_configuration_set_sending_enabled({
  configuration_set_name: "ConfigurationSetName", # required
  enabled: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set to update.

  • :enabled (required, Boolean) —

    Describes whether email sending is enabled or disabled for the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4703
4704
4705
4706
 
# File 'lib/aws-sdk-ses/client.rb', line 4703

def update_configuration_set_sending_enabled(params = {}, options = {})
  req = build_request(:update_configuration_set_sending_enabled, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.update_configuration_set_tracking_options({
  configuration_set_name: "ConfigurationSetName", # required
  tracking_options: { # required
    custom_redirect_domain: "CustomRedirectDomain",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4750
4751
4752
4753
 
# File 'lib/aws-sdk-ses/client.rb', line 4750

def update_configuration_set_tracking_options(params = {}, options = {})
  req = build_request(:update_configuration_set_tracking_options, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.update_custom_verification_email_template({
  template_name: "TemplateName", # required
  from_email_address: "FromAddress",
  template_subject: "Subject",
  template_content: "TemplateContent",
  success_redirection_url: "SuccessRedirectionURL",
  failure_redirection_url: "FailureRedirectionURL",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template to update.

  • :from_email_address (String) —

    The email address that the custom verification email is sent from.

  • :template_subject (String) —

    The subject line of the custom verification email.

  • :template_content (String) —

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see [Custom Verification Email Frequently Asked Questions] in the *Amazon SES Developer Guide*.

    [1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

  • :success_redirection_url (String) —

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

  • :failure_redirection_url (String) —

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4811
4812
4813
4814
 
# File 'lib/aws-sdk-ses/client.rb', line 4811

def update_custom_verification_email_template(params = {}, options = {})
  req = build_request(:update_custom_verification_email_template, params)
  req.send_request(options)
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

Examples:

Example: UpdateReceiptRule


# The following example updates a receipt rule to use an Amazon S3 action:

resp = client.update_receipt_rule({
  rule: {
    actions: [
      {
        s3_action: {
          bucket_name: "MyBucket", 
          object_key_prefix: "email", 
        }, 
      }, 
    ], 
    enabled: true, 
    name: "MyRule", 
    scan_enabled: true, 
    tls_policy: "Optional", 
  }, 
  rule_set_name: "MyRuleSet", 
})

Request syntax with placeholder values


resp = client.update_receipt_rule({
  rule_set_name: "ReceiptRuleSetName", # required
  rule: { # required
    name: "ReceiptRuleName", # required
    enabled: false,
    tls_policy: "Require", # accepts Require, Optional
    recipients: ["Recipient"],
    actions: [
      {
        s3_action: {
          topic_arn: "AmazonResourceName",
          bucket_name: "S3BucketName", # required
          object_key_prefix: "S3KeyPrefix",
          kms_key_arn: "AmazonResourceName",
          iam_role_arn: "IAMRoleARN",
        },
        bounce_action: {
          topic_arn: "AmazonResourceName",
          smtp_reply_code: "BounceSmtpReplyCode", # required
          status_code: "BounceStatusCode",
          message: "BounceMessage", # required
          sender: "Address", # required
        },
        workmail_action: {
          topic_arn: "AmazonResourceName",
          organization_arn: "AmazonResourceName", # required
        },
        lambda_action: {
          topic_arn: "AmazonResourceName",
          function_arn: "AmazonResourceName", # required
          invocation_type: "Event", # accepts Event, RequestResponse
        },
        stop_action: {
          scope: "RuleSet", # required, accepts RuleSet
          topic_arn: "AmazonResourceName",
        },
        add_header_action: {
          header_name: "HeaderName", # required
          header_value: "HeaderValue", # required
        },
        sns_action: {
          topic_arn: "AmazonResourceName", # required
          encoding: "UTF-8", # accepts UTF-8, Base64
        },
      },
    ],
    scan_enabled: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_set_name (required, String) —

    The name of the receipt rule set that the receipt rule belongs to.

  • :rule (required, Types::ReceiptRule) —

    A data structure that contains the updated receipt rule information.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4914
4915
4916
4917
 
# File 'lib/aws-sdk-ses/client.rb', line 4914

def update_receipt_rule(params = {}, options = {})
  req = build_request(:update_receipt_rule, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.update_template({
  template: { # required
    template_name: "TemplateName", # required
    subject_part: "SubjectPart",
    text_part: "TextPart",
    html_part: "HtmlPart",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template (required, Types::Template) —

    The content of the email, composed of a subject line and either an HTML part or a text-only part.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4950
4951
4952
4953
 
# File 'lib/aws-sdk-ses/client.rb', line 4950

def update_template(params = {}, options = {})
  req = build_request(:update_template, params)
  req.send_request(options)
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

Examples:

Example: VerifyDomainDkim


# The following example generates DKIM tokens for a domain that has been verified with Amazon SES:

resp = client.verify_domain_dkim({
  domain: "example.com", 
})

resp.to_h outputs the following:
{
  dkim_tokens: [
    "EXAMPLEq76owjnks3lnluwg65scbemvw", 
    "EXAMPLEi3dnsj67hstzaj673klariwx2", 
    "EXAMPLEwfbtcukvimehexktmdtaz6naj", 
  ], 
}

Request syntax with placeholder values


resp = client.verify_domain_dkim({
  domain: "Domain", # required
})

Response structure


resp.dkim_tokens #=> Array
resp.dkim_tokens[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain (required, String) —

    The name of the domain to be verified for Easy DKIM signing.

Returns:

See Also:



5034
5035
5036
5037
 
# File 'lib/aws-sdk-ses/client.rb', line 5034

def verify_domain_dkim(params = {}, options = {})
  req = build_request(:verify_domain_dkim, params)
  req.send_request(options)
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

Examples:

Example: VerifyDomainIdentity


# The following example starts the domain verification process with Amazon SES:

resp = client.verify_domain_identity({
  domain: "example.com", 
})

resp.to_h outputs the following:
{
  verification_token: "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE", 
}

Request syntax with placeholder values


resp = client.verify_domain_identity({
  domain: "Domain", # required
})

Response structure


resp.verification_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain (required, String) —

    The domain to be verified.

Returns:

See Also:



5085
5086
5087
5088
 
# File 'lib/aws-sdk-ses/client.rb', line 5085

def verify_domain_identity(params = {}, options = {})
  req = build_request(:verify_domain_identity, params)
  req.send_request(options)
end

#verify_email_address(params = {}) ⇒ Struct

Deprecated. Use the ‘VerifyEmailIdentity` operation to verify a new email address.

Examples:

Example: VerifyEmailAddress


# The following example starts the email address verification process with Amazon SES:

resp = client.verify_email_address({
  email_address: "user@example.com", 
})

Request syntax with placeholder values


resp = client.verify_email_address({
  email_address: "Address", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    The email address to be verified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5117
5118
5119
5120
 
# File 'lib/aws-sdk-ses/client.rb', line 5117

def verify_email_address(params = {}, options = {})
  req = build_request(:verify_email_address, params)
  req.send_request(options)
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.

Examples:

Example: VerifyEmailIdentity


# The following example starts the email address verification process with Amazon SES:

resp = client.verify_email_identity({
  email_address: "user@example.com", 
})

Request syntax with placeholder values


resp = client.verify_email_identity({
  email_address: "Address", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    The email address to be verified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5153
5154
5155
5156
 
# File 'lib/aws-sdk-ses/client.rb', line 5153

def verify_email_identity(params = {}, options = {})
  req = build_request(:verify_email_identity, params)
  req.send_request(options)
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 |

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns ‘true` if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



5268
5269
5270
5271
5272
 
# File 'lib/aws-sdk-ses/client.rb', line 5268

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  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.

Deprecated. 


5276
5277
5278
 
# File 'lib/aws-sdk-ses/client.rb', line 5276

def waiter_names
  waiters.keys
end