You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.SES

Inherits:
AWS.Service show all
Identifier:
ses
API Version:
2010-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.

Note: For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

Sending a Request Using SES

var ses = new AWS.SES();
ses.cloneReceiptRuleSet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SES object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ses = new AWS.SES({apiVersion: '2010-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the ses service identifier:

AWS.config.apiVersions = {
  ses: '2010-12-01',
  // other service API versions
};

var ses = new AWS.SES();

Version:

  • 2010-12-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

identityExists

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.SES(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SES object

var ses = new AWS.SES({apiVersion: '2010-12-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.SES.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.SES.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.SES.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cloneReceiptRuleSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

CloneReceiptRuleSet


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

 var params = {
  OriginalRuleSetName: "RuleSetToClone", 
  RuleSetName: "RuleSetToCreate"
 };
 ses.cloneReceiptRuleSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the cloneReceiptRuleSet operation

var params = {
  OriginalRuleSetName: 'STRING_VALUE', /* required */
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.cloneReceiptRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

      The name of the rule set to create. The name must:

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

      • Start and end with a letter or number.

      • Contain less than 64 characters.

    • OriginalRuleSetName — (String)

      The name of the rule set to clone.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createConfigurationSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createConfigurationSet operation

var params = {
  ConfigurationSet: { /* required */
    Name: 'STRING_VALUE' /* required */
  }
};
ses.createConfigurationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSet — (map)

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

      • Name — required — (String)

        The name of the configuration set. The name must meet the following requirements:

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

        • Contain 64 characters or fewer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request

Creates a configuration set event destination.

Note: 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).

An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

Calling the createConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestination: { /* required */
    MatchingEventTypes: [ /* required */
      send | reject | bounce | complaint | delivery | open | click | renderingFailure,
      /* more items */
    ],
    Name: 'STRING_VALUE', /* required */
    CloudWatchDestination: {
      DimensionConfigurations: [ /* required */
        {
          DefaultDimensionValue: 'STRING_VALUE', /* required */
          DimensionName: 'STRING_VALUE', /* required */
          DimensionValueSource: messageTag | emailHeader | linkTag /* required */
        },
        /* more items */
      ]
    },
    Enabled: true || false,
    KinesisFirehoseDestination: {
      DeliveryStreamARN: 'STRING_VALUE', /* required */
      IAMRoleARN: 'STRING_VALUE' /* required */
    },
    SNSDestination: {
      TopicARN: 'STRING_VALUE' /* required */
    }
  }
};
ses.createConfigurationSetEventDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

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

    • EventDestination — (map)

      An object that describes the AWS service that email sending event information will be published to.

      • Name — required — (String)

        The name of the event destination. The name must:

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

        • Contain less than 64 characters.

      • Enabled — (Boolean)

        Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

      • MatchingEventTypes — required — (Array<String>)

        The type of email sending events to publish to the event destination.

      • KinesisFirehoseDestination — (map)

        An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

        • IAMRoleARN — required — (String)

          The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

        • DeliveryStreamARN — required — (String)

          The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

      • CloudWatchDestination — (map)

        An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

        • DimensionConfigurations — required — (Array<map>)

          A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

          • DimensionName — required — (String)

            The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

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

            • Contain less than 256 characters.

          • DimensionValueSource — required — (String)

            The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.

            Possible values include:
            • "messageTag"
            • "emailHeader"
            • "linkTag"
          • DefaultDimensionValue — required — (String)

            The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

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

            • Contain less than 256 characters.

      • SNSDestination — (map)

        An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

        • TopicARN — required — (String)

          The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createConfigurationSetTrackingOptions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createConfigurationSetTrackingOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  TrackingOptions: { /* required */
    CustomRedirectDomain: 'STRING_VALUE'
  }
};
ses.createConfigurationSetTrackingOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

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

    • TrackingOptions — (map)

      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.

      • CustomRedirectDomain — (String)

        The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCustomVerificationEmailTemplate(params = {}, callback) ⇒ AWS.Request

Creates a new custom verification email template.

For more information about 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.

Service Reference:

Examples:

Calling the createCustomVerificationEmailTemplate operation

var params = {
  FailureRedirectionURL: 'STRING_VALUE', /* required */
  FromEmailAddress: 'STRING_VALUE', /* required */
  SuccessRedirectionURL: 'STRING_VALUE', /* required */
  TemplateContent: 'STRING_VALUE', /* required */
  TemplateName: 'STRING_VALUE', /* required */
  TemplateSubject: 'STRING_VALUE' /* required */
};
ses.createCustomVerificationEmailTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateName — (String)

      The name of the custom verification email template.

    • FromEmailAddress — (String)

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

    • TemplateSubject — (String)

      The subject line of the custom verification email.

    • TemplateContent — (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.

    • SuccessRedirectionURL — (String)

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

    • FailureRedirectionURL — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createReceiptFilter(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

CreateReceiptFilter


/* The following example creates a new IP address filter: */

 var params = {
  Filter: {
   IpFilter: {
    Cidr: "1.2.3.4/24", 
    Policy: "Allow"
   }, 
   Name: "MyFilter"
  }
 };
 ses.createReceiptFilter(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createReceiptFilter operation

var params = {
  Filter: { /* required */
    IpFilter: { /* required */
      Cidr: 'STRING_VALUE', /* required */
      Policy: Block | Allow /* required */
    },
    Name: 'STRING_VALUE' /* required */
  }
};
ses.createReceiptFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filter — (map)

      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.

      • Name — required — (String)

        The name of the IP address filter. The name must:

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

        • Start and end with a letter or number.

        • Contain less than 64 characters.

      • IpFilter — required — (map)

        A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.

        • Policy — required — (String)

          Indicates whether to block or allow incoming mail from the specified IP addresses.

          Possible values include:
          • "Block"
          • "Allow"
        • Cidr — required — (String)

          A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createReceiptRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

CreateReceiptRule


/* The following example creates a new receipt rule: */

 var params = {
  After: "", 
  Rule: {
   Actions: [
      {
     S3Action: {
      BucketName: "MyBucket", 
      ObjectKeyPrefix: "email"
     }
    }
   ], 
   Enabled: true, 
   Name: "MyRule", 
   ScanEnabled: true, 
   TlsPolicy: "Optional"
  }, 
  RuleSetName: "MyRuleSet"
 };
 ses.createReceiptRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createReceiptRule operation

var params = {
  Rule: { /* required */
    Name: 'STRING_VALUE', /* required */
    Actions: [
      {
        AddHeaderAction: {
          HeaderName: 'STRING_VALUE', /* required */
          HeaderValue: 'STRING_VALUE' /* required */
        },
        BounceAction: {
          Message: 'STRING_VALUE', /* required */
          Sender: 'STRING_VALUE', /* required */
          SmtpReplyCode: 'STRING_VALUE', /* required */
          StatusCode: 'STRING_VALUE',
          TopicArn: 'STRING_VALUE'
        },
        LambdaAction: {
          FunctionArn: 'STRING_VALUE', /* required */
          InvocationType: Event | RequestResponse,
          TopicArn: 'STRING_VALUE'
        },
        S3Action: {
          BucketName: 'STRING_VALUE', /* required */
          KmsKeyArn: 'STRING_VALUE',
          ObjectKeyPrefix: 'STRING_VALUE',
          TopicArn: 'STRING_VALUE'
        },
        SNSAction: {
          TopicArn: 'STRING_VALUE', /* required */
          Encoding: UTF-8 | Base64
        },
        StopAction: {
          Scope: RuleSet, /* required */
          TopicArn: 'STRING_VALUE'
        },
        WorkmailAction: {
          OrganizationArn: 'STRING_VALUE', /* required */
          TopicArn: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    Enabled: true || false,
    Recipients: [
      'STRING_VALUE',
      /* more items */
    ],
    ScanEnabled: true || false,
    TlsPolicy: Require | Optional
  },
  RuleSetName: 'STRING_VALUE', /* required */
  After: 'STRING_VALUE'
};
ses.createReceiptRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

      The name of the rule set that the receipt rule will be added to.

    • After — (String)

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

    • Rule — (map)

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

      • Name — required — (String)

        The name of the receipt rule. The name must:

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

        • Start and end with a letter or number.

        • Contain less than 64 characters.

      • Enabled — (Boolean)

        If true, the receipt rule is active. The default value is false.

      • TlsPolicy — (String)

        Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

        Possible values include:
        • "Require"
        • "Optional"
      • Recipients — (Array<String>)

        The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

      • Actions — (Array<map>)

        An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

        • S3Action — (map)

          Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

          • TopicArn — (String)

            The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • BucketName — required — (String)

            The name of the Amazon S3 bucket that incoming email will be saved to.

          • ObjectKeyPrefix — (String)

            The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

          • KmsKeyArn — (String)

            The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

            • To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

            • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

            For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

            Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

        • BounceAction — (map)

          Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • SmtpReplyCode — required — (String)

            The SMTP reply code, as defined by RFC 5321.

          • StatusCode — (String)

            The SMTP enhanced status code, as defined by RFC 3463.

          • Message — required — (String)

            Human-readable text to include in the bounce message.

          • Sender — required — (String)

            The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

        • WorkmailAction — (map)

          Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • OrganizationArn — required — (String)

            The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

        • LambdaAction — (map)

          Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • FunctionArn — required — (String)

            The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

          • InvocationType — (String)

            The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

            There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

             Possible values include:
            • "Event"
            • "RequestResponse"
        • StopAction — (map)

          Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

          • Scope — required — (String)

            The scope of the StopAction. The only acceptable value is RuleSet.

            Possible values include:
            • "RuleSet"
          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

        • AddHeaderAction — (map)

          Adds a header to the received email.

          • HeaderName — required — (String)

            The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

          • HeaderValue — required — (String)

            Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

        • SNSAction — (map)

          Publishes the email content within a notification to Amazon SNS.

          • TopicArn — required — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • Encoding — (String)

            The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

            Possible values include:
            • "UTF-8"
            • "Base64"
      • ScanEnabled — (Boolean)

        If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createReceiptRuleSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

CreateReceiptRuleSet


/* The following example creates an empty receipt rule set: */

 var params = {
  RuleSetName: "MyRuleSet"
 };
 ses.createReceiptRuleSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createReceiptRuleSet operation

var params = {
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.createReceiptRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

      The name of the rule set to create. The name must:

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

      • Start and end with a letter or number.

      • Contain less than 64 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTemplate(params = {}, callback) ⇒ AWS.Request

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

Calling the createTemplate operation

var params = {
  Template: { /* required */
    TemplateName: 'STRING_VALUE', /* required */
    HtmlPart: 'STRING_VALUE',
    SubjectPart: 'STRING_VALUE',
    TextPart: 'STRING_VALUE'
  }
};
ses.createTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Template — (map)

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

      • TemplateName — required — (String)

        The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

      • SubjectPart — (String)

        The subject line of the email.

      • TextPart — (String)

        The email body that will be visible to recipients whose email clients do not display HTML.

      • HtmlPart — (String)

        The HTML body of the email.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConfigurationSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteConfigurationSet operation

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
ses.deleteConfigurationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestinationName: 'STRING_VALUE' /* required */
};
ses.deleteConfigurationSetEventDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

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

    • EventDestinationName — (String)

      The name of the event destination to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConfigurationSetTrackingOptions(params = {}, callback) ⇒ AWS.Request

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: Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

Service Reference:

Examples:

Calling the deleteConfigurationSetTrackingOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
ses.deleteConfigurationSetTrackingOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set from which you want to delete the tracking options.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCustomVerificationEmailTemplate(params = {}, callback) ⇒ AWS.Request

Deletes an existing custom verification email template.

For more information about 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.

Service Reference:

Examples:

Calling the deleteCustomVerificationEmailTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
ses.deleteCustomVerificationEmailTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateName — (String)

      The name of the custom verification email template that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIdentity(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

DeleteIdentity


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

 var params = {
  Identity: "user@example.com"
 };
 ses.deleteIdentity(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteIdentity operation

var params = {
  Identity: 'STRING_VALUE' /* required */
};
ses.deleteIdentity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

      The identity to be removed from the list of identities for the AWS Account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIdentityPolicy(params = {}, callback) ⇒ AWS.Request

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

Note: This API is for the identity owner only. If you have not verified the identity, this API will return an error.

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.

Service Reference:

Examples:

DeleteIdentityPolicy


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

 var params = {
  Identity: "user@example.com", 
  PolicyName: "MyPolicy"
 };
 ses.deleteIdentityPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteIdentityPolicy operation

var params = {
  Identity: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE' /* required */
};
ses.deleteIdentityPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

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

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

    • PolicyName — (String)

      The name of the policy to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteReceiptFilter(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

DeleteReceiptFilter


/* The following example deletes an IP address filter: */

 var params = {
  FilterName: "MyFilter"
 };
 ses.deleteReceiptFilter(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteReceiptFilter operation

var params = {
  FilterName: 'STRING_VALUE' /* required */
};
ses.deleteReceiptFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FilterName — (String)

      The name of the IP address filter to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteReceiptRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

DeleteReceiptRule


/* The following example deletes a receipt rule: */

 var params = {
  RuleName: "MyRule", 
  RuleSetName: "MyRuleSet"
 };
 ses.deleteReceiptRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteReceiptRule operation

var params = {
  RuleName: 'STRING_VALUE', /* required */
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.deleteReceiptRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

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

    • RuleName — (String)

      The name of the receipt rule to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteReceiptRuleSet(params = {}, callback) ⇒ AWS.Request

Deletes the specified receipt rule set and all of the receipt rules it contains.

Note: The currently active rule set cannot be deleted.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

DeleteReceiptRuleSet


/* The following example deletes a receipt rule set: */

 var params = {
  RuleSetName: "MyRuleSet"
 };
 ses.deleteReceiptRuleSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteReceiptRuleSet operation

var params = {
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.deleteReceiptRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

      The name of the receipt rule set to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTemplate(params = {}, callback) ⇒ AWS.Request

Deletes an email template.

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

Service Reference:

Examples:

Calling the deleteTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
ses.deleteTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateName — (String)

      The name of the template to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVerifiedEmailAddress(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

DeleteVerifiedEmailAddress


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

 var params = {
  EmailAddress: "user@example.com"
 };
 ses.deleteVerifiedEmailAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteVerifiedEmailAddress operation

var params = {
  EmailAddress: 'STRING_VALUE' /* required */
};
ses.deleteVerifiedEmailAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EmailAddress — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeActiveReceiptRuleSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

DescribeActiveReceiptRuleSet


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

 var params = {
 };
 ses.describeActiveReceiptRuleSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Metadata: {
     CreatedTimestamp: <Date Representation>, 
     Name: "default-rule-set"
    }, 
    Rules: [
       {
      Actions: [
         {
        S3Action: {
         BucketName: "MyBucket", 
         ObjectKeyPrefix: "email"
        }
       }
      ], 
      Enabled: true, 
      Name: "MyRule", 
      ScanEnabled: true, 
      TlsPolicy: "Optional"
     }
    ]
   }
   */
 });

Calling the describeActiveReceiptRuleSet operation

var params = {
};
ses.describeActiveReceiptRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Metadata — (map)

        The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.

        • Name — (String)

          The name of the receipt rule set. The name must:

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

          • Start and end with a letter or number.

          • Contain less than 64 characters.

        • CreatedTimestamp — (Date)

          The date and time the receipt rule set was created.

      • Rules — (Array<map>)

        The receipt rules that belong to the active rule set.

        • Name — required — (String)

          The name of the receipt rule. The name must:

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

          • Start and end with a letter or number.

          • Contain less than 64 characters.

        • Enabled — (Boolean)

          If true, the receipt rule is active. The default value is false.

        • TlsPolicy — (String)

          Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

          Possible values include:
          • "Require"
          • "Optional"
        • Recipients — (Array<String>)

          The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

        • Actions — (Array<map>)

          An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

          • S3Action — (map)

            Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

            • TopicArn — (String)

              The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • BucketName — required — (String)

              The name of the Amazon S3 bucket that incoming email will be saved to.

            • ObjectKeyPrefix — (String)

              The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

            • KmsKeyArn — (String)

              The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

              • To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

              • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

              For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

              Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

          • BounceAction — (map)

            Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • SmtpReplyCode — required — (String)

              The SMTP reply code, as defined by RFC 5321.

            • StatusCode — (String)

              The SMTP enhanced status code, as defined by RFC 3463.

            • Message — required — (String)

              Human-readable text to include in the bounce message.

            • Sender — required — (String)

              The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

          • WorkmailAction — (map)

            Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • OrganizationArn — required — (String)

              The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

          • LambdaAction — (map)

            Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • FunctionArn — required — (String)

              The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

            • InvocationType — (String)

              The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

              There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

               Possible values include:
              • "Event"
              • "RequestResponse"
          • StopAction — (map)

            Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

            • Scope — required — (String)

              The scope of the StopAction. The only acceptable value is RuleSet.

              Possible values include:
              • "RuleSet"
            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • AddHeaderAction — (map)

            Adds a header to the received email.

            • HeaderName — required — (String)

              The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

            • HeaderValue — required — (String)

              Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

          • SNSAction — (map)

            Publishes the email content within a notification to Amazon SNS.

            • TopicArn — required — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • Encoding — (String)

              The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

              Possible values include:
              • "UTF-8"
              • "Base64"
        • ScanEnabled — (Boolean)

          If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigurationSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeConfigurationSet operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  ConfigurationSetAttributeNames: [
    eventDestinations | trackingOptions | deliveryOptions | reputationOptions,
    /* more items */
  ]
};
ses.describeConfigurationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set to describe.

    • ConfigurationSetAttributeNames — (Array<String>)

      A list of configuration set attributes to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationSet — (map)

        The configuration set object associated with the specified configuration set.

        • Name — required — (String)

          The name of the configuration set. The name must meet the following requirements:

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

          • Contain 64 characters or fewer.

      • EventDestinations — (Array<map>)

        A list of event destinations associated with the configuration set.

        • Name — required — (String)

          The name of the event destination. The name must:

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

          • Contain less than 64 characters.

        • Enabled — (Boolean)

          Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

        • MatchingEventTypes — required — (Array<String>)

          The type of email sending events to publish to the event destination.

        • KinesisFirehoseDestination — (map)

          An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

          • IAMRoleARN — required — (String)

            The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

          • DeliveryStreamARN — required — (String)

            The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

        • CloudWatchDestination — (map)

          An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

          • DimensionConfigurations — required — (Array<map>)

            A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

            • DimensionName — required — (String)

              The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

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

              • Contain less than 256 characters.

            • DimensionValueSource — required — (String)

              The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.

              Possible values include:
              • "messageTag"
              • "emailHeader"
              • "linkTag"
            • DefaultDimensionValue — required — (String)

              The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

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

              • Contain less than 256 characters.

        • SNSDestination — (map)

          An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

          • TopicARN — required — (String)

            The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

      • TrackingOptions — (map)

        The name of the custom open and click tracking domain associated with the configuration set.

        • CustomRedirectDomain — (String)

          The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.

      • DeliveryOptions — (map)

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

        • TlsPolicy — (String)

          Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

          Possible values include:
          • "Require"
          • "Optional"
      • ReputationOptions — (map)

        An object that represents the reputation settings for the configuration set.

        • SendingEnabled — (Boolean)

          Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES will send emails that use the configuration set. If the value is false, Amazon SES will not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.

        • ReputationMetricsEnabled — (Boolean)

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

          If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.

        • LastFreshStart — (Date)

          The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

          When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset.

          If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReceiptRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

DescribeReceiptRule


/* The following example returns the details of a receipt rule: */

 var params = {
  RuleName: "MyRule", 
  RuleSetName: "MyRuleSet"
 };
 ses.describeReceiptRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Rule: {
     Actions: [
        {
       S3Action: {
        BucketName: "MyBucket", 
        ObjectKeyPrefix: "email"
       }
      }
     ], 
     Enabled: true, 
     Name: "MyRule", 
     ScanEnabled: true, 
     TlsPolicy: "Optional"
    }
   }
   */
 });

Calling the describeReceiptRule operation

var params = {
  RuleName: 'STRING_VALUE', /* required */
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.describeReceiptRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

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

    • RuleName — (String)

      The name of the receipt rule.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Rule — (map)

        A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

        • Name — required — (String)

          The name of the receipt rule. The name must:

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

          • Start and end with a letter or number.

          • Contain less than 64 characters.

        • Enabled — (Boolean)

          If true, the receipt rule is active. The default value is false.

        • TlsPolicy — (String)

          Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

          Possible values include:
          • "Require"
          • "Optional"
        • Recipients — (Array<String>)

          The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

        • Actions — (Array<map>)

          An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

          • S3Action — (map)

            Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

            • TopicArn — (String)

              The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • BucketName — required — (String)

              The name of the Amazon S3 bucket that incoming email will be saved to.

            • ObjectKeyPrefix — (String)

              The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

            • KmsKeyArn — (String)

              The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

              • To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

              • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

              For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

              Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

          • BounceAction — (map)

            Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • SmtpReplyCode — required — (String)

              The SMTP reply code, as defined by RFC 5321.

            • StatusCode — (String)

              The SMTP enhanced status code, as defined by RFC 3463.

            • Message — required — (String)

              Human-readable text to include in the bounce message.

            • Sender — required — (String)

              The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

          • WorkmailAction — (map)

            Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • OrganizationArn — required — (String)

              The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

          • LambdaAction — (map)

            Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • FunctionArn — required — (String)

              The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

            • InvocationType — (String)

              The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

              There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

               Possible values include:
              • "Event"
              • "RequestResponse"
          • StopAction — (map)

            Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

            • Scope — required — (String)

              The scope of the StopAction. The only acceptable value is RuleSet.

              Possible values include:
              • "RuleSet"
            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • AddHeaderAction — (map)

            Adds a header to the received email.

            • HeaderName — required — (String)

              The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

            • HeaderValue — required — (String)

              Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

          • SNSAction — (map)

            Publishes the email content within a notification to Amazon SNS.

            • TopicArn — required — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • Encoding — (String)

              The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

              Possible values include:
              • "UTF-8"
              • "Base64"
        • ScanEnabled — (Boolean)

          If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReceiptRuleSet(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

DescribeReceiptRuleSet


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

 var params = {
  RuleSetName: "MyRuleSet"
 };
 ses.describeReceiptRuleSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Metadata: {
     CreatedTimestamp: <Date Representation>, 
     Name: "MyRuleSet"
    }, 
    Rules: [
       {
      Actions: [
         {
        S3Action: {
         BucketName: "MyBucket", 
         ObjectKeyPrefix: "email"
        }
       }
      ], 
      Enabled: true, 
      Name: "MyRule", 
      ScanEnabled: true, 
      TlsPolicy: "Optional"
     }
    ]
   }
   */
 });

Calling the describeReceiptRuleSet operation

var params = {
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.describeReceiptRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

      The name of the receipt rule set to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Metadata — (map)

        The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.

        • Name — (String)

          The name of the receipt rule set. The name must:

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

          • Start and end with a letter or number.

          • Contain less than 64 characters.

        • CreatedTimestamp — (Date)

          The date and time the receipt rule set was created.

      • Rules — (Array<map>)

        A list of the receipt rules that belong to the specified receipt rule set.

        • Name — required — (String)

          The name of the receipt rule. The name must:

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

          • Start and end with a letter or number.

          • Contain less than 64 characters.

        • Enabled — (Boolean)

          If true, the receipt rule is active. The default value is false.

        • TlsPolicy — (String)

          Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

          Possible values include:
          • "Require"
          • "Optional"
        • Recipients — (Array<String>)

          The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

        • Actions — (Array<map>)

          An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

          • S3Action — (map)

            Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

            • TopicArn — (String)

              The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • BucketName — required — (String)

              The name of the Amazon S3 bucket that incoming email will be saved to.

            • ObjectKeyPrefix — (String)

              The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

            • KmsKeyArn — (String)

              The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

              • To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

              • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

              For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

              Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

          • BounceAction — (map)

            Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • SmtpReplyCode — required — (String)

              The SMTP reply code, as defined by RFC 5321.

            • StatusCode — (String)

              The SMTP enhanced status code, as defined by RFC 3463.

            • Message — required — (String)

              Human-readable text to include in the bounce message.

            • Sender — required — (String)

              The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

          • WorkmailAction — (map)

            Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • OrganizationArn — required — (String)

              The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

          • LambdaAction — (map)

            Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • FunctionArn — required — (String)

              The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

            • InvocationType — (String)

              The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

              There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

               Possible values include:
              • "Event"
              • "RequestResponse"
          • StopAction — (map)

            Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

            • Scope — required — (String)

              The scope of the StopAction. The only acceptable value is RuleSet.

              Possible values include:
              • "RuleSet"
            • TopicArn — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • AddHeaderAction — (map)

            Adds a header to the received email.

            • HeaderName — required — (String)

              The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

            • HeaderValue — required — (String)

              Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

          • SNSAction — (map)

            Publishes the email content within a notification to Amazon SNS.

            • TopicArn — required — (String)

              The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

            • Encoding — (String)

              The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

              Possible values include:
              • "UTF-8"
              • "Base64"
        • ScanEnabled — (Boolean)

          If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAccountSendingEnabled(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

GetAccountSendingEnabled


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

 var params = {};
 ses.getAccountSendingEnabled(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Enabled: true
   }
   */
 });

Calling the getAccountSendingEnabled operation

ses.getAccountSendingEnabled(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Enabled — (Boolean)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCustomVerificationEmailTemplate(params = {}, callback) ⇒ AWS.Request

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 in the Amazon SES Developer Guide.

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

Service Reference:

Examples:

Calling the getCustomVerificationEmailTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
ses.getCustomVerificationEmailTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateName — (String)

      The name of the custom verification email template that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateName — (String)

        The name of the custom verification email template.

      • FromEmailAddress — (String)

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

      • TemplateSubject — (String)

        The subject line of the custom verification email.

      • TemplateContent — (String)

        The content of the custom verification email.

      • SuccessRedirectionURL — (String)

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

      • FailureRedirectionURL — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getIdentityDkimAttributes(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

GetIdentityDkimAttributes


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

 var params = {
  Identities: [
     "example.com", 
     "user@example.com"
  ]
 };
 ses.getIdentityDkimAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DkimAttributes: {
     "example.com": {
       DkimEnabled: true, 
       DkimTokens: [
          "EXAMPLEjcs5xoyqytjsotsijas7236gr", 
          "EXAMPLEjr76cvoc6mysspnioorxsn6ep", 
          "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k"
       ], 
       DkimVerificationStatus: "Success"
      }, 
     "user@example.com": {
       DkimEnabled: false, 
       DkimVerificationStatus: "NotStarted"
      }
    }
   }
   */
 });

Calling the getIdentityDkimAttributes operation

var params = {
  Identities: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ses.getIdentityDkimAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identities — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DkimAttributes — (map<map>)

        The DKIM attributes for an email address or a domain.

        • DkimEnabled — required — (Boolean)

          Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.

        • DkimVerificationStatus — required — (String)

          Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

          Possible values include:
          • "Pending"
          • "Success"
          • "Failed"
          • "TemporaryFailure"
          • "NotStarted"
        • DkimTokens — (Array<String>)

          A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

          For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getIdentityMailFromDomainAttributes(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

GetIdentityMailFromDomainAttributes


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

 var params = {
  Identities: [
     "example.com"
  ]
 };
 ses.getIdentityMailFromDomainAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    MailFromDomainAttributes: {
     "example.com": {
       BehaviorOnMXFailure: "UseDefaultValue", 
       MailFromDomain: "bounces.example.com", 
       MailFromDomainStatus: "Success"
      }
    }
   }
   */
 });

Calling the getIdentityMailFromDomainAttributes operation

var params = {
  Identities: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ses.getIdentityMailFromDomainAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identities — (Array<String>)

      A list of one or more identities.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MailFromDomainAttributes — (map<map>)

        A map of identities to custom MAIL FROM attributes.

        • MailFromDomain — required — (String)

          The custom MAIL FROM domain that the identity is configured to use.

        • MailFromDomainStatus — required — (String)

          The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

          Possible values include:
          • "Pending"
          • "Success"
          • "Failed"
          • "TemporaryFailure"
        • BehaviorOnMXFailure — required — (String)

          The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

          The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

          Possible values include:
          • "UseDefaultValue"
          • "RejectMessage"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getIdentityNotificationAttributes(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

GetIdentityNotificationAttributes


/* The following example returns the notification attributes for an identity: */

 var params = {
  Identities: [
     "example.com"
  ]
 };
 ses.getIdentityNotificationAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NotificationAttributes: {
     "example.com": {
       BounceTopic: "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", 
       ComplaintTopic: "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", 
       DeliveryTopic: "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", 
       ForwardingEnabled: true, 
       HeadersInBounceNotificationsEnabled: false, 
       HeadersInComplaintNotificationsEnabled: false, 
       HeadersInDeliveryNotificationsEnabled: false
      }
    }
   }
   */
 });

Calling the getIdentityNotificationAttributes operation

var params = {
  Identities: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ses.getIdentityNotificationAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identities — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NotificationAttributes — (map<map>)

        A map of Identity to IdentityNotificationAttributes.

        • BounceTopic — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

        • ComplaintTopic — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

        • DeliveryTopic — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

        • ForwardingEnabled — required — (Boolean)

          Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.

        • HeadersInBounceNotificationsEnabled — (Boolean)

          Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.

        • HeadersInComplaintNotificationsEnabled — (Boolean)

          Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.

        • HeadersInDeliveryNotificationsEnabled — (Boolean)

          Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getIdentityPolicies(params = {}, callback) ⇒ AWS.Request

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: This API is for the identity owner only. If you have not verified the identity, this API will return an error.

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.

Service Reference:

Examples:

GetIdentityPolicies


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

 var params = {
  Identity: "example.com", 
  PolicyNames: [
     "MyPolicy"
  ]
 };
 ses.getIdentityPolicies(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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\"}]}"
    }
   }
   */
 });

Calling the getIdentityPolicies operation

var params = {
  Identity: 'STRING_VALUE', /* required */
  PolicyNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ses.getIdentityPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

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

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

    • PolicyNames — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policies — (map<String>)

        A map of policy names to policies.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getIdentityVerificationAttributes(params = {}, callback) ⇒ AWS.Request

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning.

For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

Service Reference:

Examples:

GetIdentityVerificationAttributes


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

 var params = {
  Identities: [
     "example.com"
  ]
 };
 ses.getIdentityVerificationAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VerificationAttributes: {
     "example.com": {
       VerificationStatus: "Success", 
       VerificationToken: "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY="
      }
    }
   }
   */
 });

Calling the getIdentityVerificationAttributes operation

var params = {
  Identities: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ses.getIdentityVerificationAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identities — (Array<String>)

      A list of identities.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerificationAttributes — (map<map>)

        A map of Identities to IdentityVerificationAttributes objects.

        • VerificationStatus — required — (String)

          The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".

          Possible values include:
          • "Pending"
          • "Success"
          • "Failed"
          • "TemporaryFailure"
          • "NotStarted"
        • VerificationToken — (String)

          The verification token for a domain identity. Null for email address identities.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

getSendQuota(params = {}, callback) ⇒ AWS.Request

Provides the sending limits for the Amazon SES account.

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

Service Reference:

Examples:

GetSendQuota


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

 var params = {};
 ses.getSendQuota(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Max24HourSend: 200, 
    MaxSendRate: 1, 
    SentLast24Hours: 1
   }
   */
 });

Calling the getSendQuota operation

ses.getSendQuota(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Max24HourSend — (Float)

        The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.

      • MaxSendRate — (Float)

        The maximum number of emails that Amazon SES can accept from the user's account per second.

        Note: The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.
      • SentLast24Hours — (Float)

        The number of emails sent during the previous 24 hours.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSendStatistics(params = {}, callback) ⇒ AWS.Request

Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.

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

Service Reference:

Examples:

GetSendStatistics


/* The following example returns Amazon SES sending statistics: */

 var params = {};
 ses.getSendStatistics(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SendDataPoints: [
       {
      Bounces: 0, 
      Complaints: 0, 
      DeliveryAttempts: 5, 
      Rejects: 0, 
      Timestamp: <Date Representation>
     }, 
       {
      Bounces: 0, 
      Complaints: 0, 
      DeliveryAttempts: 3, 
      Rejects: 0, 
      Timestamp: <Date Representation>
     }, 
       {
      Bounces: 0, 
      Complaints: 0, 
      DeliveryAttempts: 1, 
      Rejects: 0, 
      Timestamp: <Date Representation>
     }
    ]
   }
   */
 });

Calling the getSendStatistics operation

ses.getSendStatistics(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SendDataPoints — (Array<map>)

        A list of data points, each of which represents 15 minutes of activity.

        • Timestamp — (Date)

          Time of the data point.

        • DeliveryAttempts — (Integer)

          Number of emails that have been sent.

        • Bounces — (Integer)

          Number of emails that have bounced.

        • Complaints — (Integer)

          Number of unwanted emails that were rejected by recipients.

        • Rejects — (Integer)

          Number of emails rejected by Amazon SES.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getTemplate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
ses.getTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateName — (String)

      The name of the template you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Template — (map)

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

        • TemplateName — required — (String)

          The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

        • SubjectPart — (String)

          The subject line of the email.

        • TextPart — (String)

          The email body that will be visible to recipients whose email clients do not display HTML.

        • HtmlPart — (String)

          The HTML body of the email.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listConfigurationSets(params = {}, callback) ⇒ AWS.Request

Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

Service Reference:

Examples:

Calling the listConfigurationSets operation

var params = {
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ses.listConfigurationSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

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

    • MaxItems — (Integer)

      The number of configuration sets to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationSets — (Array<map>)

        A list of configuration sets.

        • Name — required — (String)

          The name of the configuration set. The name must meet the following requirements:

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

          • Contain 64 characters or fewer.

      • NextToken — (String)

        A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listCustomVerificationEmailTemplates(params = {}, callback) ⇒ AWS.Request

Lists the existing custom verification email templates for your account in the current AWS Region.

For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

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

Service Reference:

Examples:

Calling the listCustomVerificationEmailTemplates operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ses.listCustomVerificationEmailTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

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

    • MaxResults — (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 will return up to 50 results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomVerificationEmailTemplates — (Array<map>)

        A list of the custom verification email templates that exist in your account.

        • TemplateName — (String)

          The name of the custom verification email template.

        • FromEmailAddress — (String)

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

        • TemplateSubject — (String)

          The subject line of the custom verification email.

        • SuccessRedirectionURL — (String)

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

        • FailureRedirectionURL — (String)

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

      • NextToken — (String)

        A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom verification email templates.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listIdentities(params = {}, callback) ⇒ AWS.Request

Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

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

Service Reference:

Examples:

ListIdentities


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

 var params = {
  IdentityType: "EmailAddress", 
  MaxItems: 123, 
  NextToken: ""
 };
 ses.listIdentities(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Identities: [
       "user@example.com"
    ], 
    NextToken: ""
   }
   */
 });

Calling the listIdentities operation

var params = {
  IdentityType: EmailAddress | Domain,
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ses.listIdentities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • IdentityType — (String)

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

      Possible values include:
      • "EmailAddress"
      • "Domain"
    • NextToken — (String)

      The token to use for pagination.

    • MaxItems — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Identities — (Array<String>)

        A list of identities.

      • NextToken — (String)

        The token used for pagination.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listIdentityPolicies(params = {}, callback) ⇒ AWS.Request

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

Note: This API is for the identity owner only. If you have not verified the identity, this API will return an error.

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.

Service Reference:

Examples:

ListIdentityPolicies


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

 var params = {
  Identity: "example.com"
 };
 ses.listIdentityPolicies(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    PolicyNames: [
       "MyPolicy"
    ]
   }
   */
 });

Calling the listIdentityPolicies operation

var params = {
  Identity: 'STRING_VALUE' /* required */
};
ses.listIdentityPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

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

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyNames — (Array<String>)

        A list of names of policies that apply to the specified identity.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listReceiptFilters(params = {}, callback) ⇒ AWS.Request

Lists the IP address filters associated with your AWS account in the current AWS Region.

For information about managing IP address filters, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

ListReceiptFilters


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

 var params = {
 };
 ses.listReceiptFilters(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Filters: [
       {
      IpFilter: {
       Cidr: "1.2.3.4/24", 
       Policy: "Block"
      }, 
      Name: "MyFilter"
     }
    ]
   }
   */
 });

Calling the listReceiptFilters operation

var params = {
};
ses.listReceiptFilters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Filters — (Array<map>)

        A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.

        • Name — required — (String)

          The name of the IP address filter. The name must:

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

          • Start and end with a letter or number.

          • Contain less than 64 characters.

        • IpFilter — required — (map)

          A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.

          • Policy — required — (String)

            Indicates whether to block or allow incoming mail from the specified IP addresses.

            Possible values include:
            • "Block"
            • "Allow"
          • Cidr — required — (String)

            A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listReceiptRuleSets(params = {}, callback) ⇒ AWS.Request

Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

ListReceiptRuleSets


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

 var params = {
  NextToken: ""
 };
 ses.listReceiptRuleSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NextToken: "", 
    RuleSets: [
       {
      CreatedTimestamp: <Date Representation>, 
      Name: "MyRuleSet"
     }
    ]
   }
   */
 });

Calling the listReceiptRuleSets operation

var params = {
  NextToken: 'STRING_VALUE'
};
ses.listReceiptRuleSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RuleSets — (Array<map>)

        The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.

        • Name — (String)

          The name of the receipt rule set. The name must:

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

          • Start and end with a letter or number.

          • Contain less than 64 characters.

        • CreatedTimestamp — (Date)

          The date and time the receipt rule set was created.

      • NextToken — (String)

        A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTemplates(params = {}, callback) ⇒ AWS.Request

Lists the email templates present in your Amazon SES account in the current AWS Region.

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

Service Reference:

Examples:

Calling the listTemplates operation

var params = {
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ses.listTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

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

    • MaxItems — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplatesMetadata — (Array<map>)

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

        • Name — (String)

          The name of the template.

        • CreatedTimestamp — (Date)

          The time and date the template was created.

      • NextToken — (String)

        A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listVerifiedEmailAddresses(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

ListVerifiedEmailAddresses


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

 var params = {};
 ses.listVerifiedEmailAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VerifiedEmailAddresses: [
       "user1@example.com", 
       "user2@example.com"
    ]
   }
   */
 });

Calling the listVerifiedEmailAddresses operation

ses.listVerifiedEmailAddresses(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerifiedEmailAddresses — (Array<String>)

        A list of email addresses that have been verified.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putConfigurationSetDeliveryOptions(params = {}, callback) ⇒ AWS.Request

Adds or updates the delivery options for a configuration set.

Service Reference:

Examples:

Calling the putConfigurationSetDeliveryOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  DeliveryOptions: {
    TlsPolicy: Require | Optional
  }
};
ses.putConfigurationSetDeliveryOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to specify the delivery options for.

    • DeliveryOptions — (map)

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

      • TlsPolicy — (String)

        Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

        Possible values include:
        • "Require"
        • "Optional"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putIdentityPolicy(params = {}, callback) ⇒ AWS.Request

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

Note: This API is for the identity owner only. If you have not verified the identity, this API will return an error.

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.

Service Reference:

Examples:

PutIdentityPolicy


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

 var params = {
  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\"}]}", 
  PolicyName: "MyPolicy"
 };
 ses.putIdentityPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the putIdentityPolicy operation

var params = {
  Identity: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE' /* required */
};
ses.putIdentityPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

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

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

    • PolicyName — (String)

      The name of the policy.

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

    • Policy — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

reorderReceiptRuleSet(params = {}, callback) ⇒ AWS.Request

Reorders the receipt rules within a receipt rule set.

Note: All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

ReorderReceiptRuleSet


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

 var params = {
  RuleNames: [
     "MyRule", 
     "MyOtherRule"
  ], 
  RuleSetName: "MyRuleSet"
 };
 ses.reorderReceiptRuleSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the reorderReceiptRuleSet operation

var params = {
  RuleNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.reorderReceiptRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

      The name of the receipt rule set to reorder.

    • RuleNames — (Array<String>)

      A list of the specified receipt rule set's receipt rules in the order that you want to put them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendBounce(params = {}, callback) ⇒ AWS.Request

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

Note: You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

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.

Service Reference:

Examples:

Calling the sendBounce operation

var params = {
  BounceSender: 'STRING_VALUE', /* required */
  BouncedRecipientInfoList: [ /* required */
    {
      Recipient: 'STRING_VALUE', /* required */
      BounceType: DoesNotExist | MessageTooLarge | ExceededQuota | ContentRejected | Undefined | TemporaryFailure,
      RecipientArn: 'STRING_VALUE',
      RecipientDsnFields: {
        Action: failed | delayed | delivered | relayed | expanded, /* required */
        Status: 'STRING_VALUE', /* required */
        DiagnosticCode: 'STRING_VALUE',
        ExtensionFields: [
          {
            Name: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        FinalRecipient: 'STRING_VALUE',
        LastAttemptDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        RemoteMta: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  OriginalMessageId: 'STRING_VALUE', /* required */
  BounceSenderArn: 'STRING_VALUE',
  Explanation: 'STRING_VALUE',
  MessageDsn: {
    ReportingMta: 'STRING_VALUE', /* required */
    ArrivalDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ExtensionFields: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  }
};
ses.sendBounce(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OriginalMessageId — (String)

      The message ID of the message to be bounced.

    • BounceSender — (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 will be auto-generated based on the bounced recipient information.

    • MessageDsn — (map)

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

      • ReportingMta — required — (String)

        The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com.

      • ArrivalDate — (Date)

        When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.

      • ExtensionFields — (Array<map>)

        Additional X-headers to include in the DSN.

        • Name — required — (String)

          The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

        • Value — required — (String)

          The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

    • BouncedRecipientInfoList — (Array<map>)

      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.

      • Recipient — required — (String)

        The email address of the recipient of the bounced email.

      • RecipientArn — (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 receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

      • BounceType — (String)

        The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

        Possible values include:
        • "DoesNotExist"
        • "MessageTooLarge"
        • "ExceededQuota"
        • "ContentRejected"
        • "Undefined"
        • "TemporaryFailure"
      • RecipientDsnFields — (map)

        Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

        • FinalRecipient — (String)

          The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

          Note: Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.
        • Action — required — (String)

          The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

          Possible values include:
          • "failed"
          • "delayed"
          • "delivered"
          • "relayed"
          • "expanded"
        • RemoteMta — (String)

          The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

        • Status — required — (String)

          The status code that indicates what went wrong. This is required by RFC 3464.

        • DiagnosticCode — (String)

          An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

        • LastAttemptDate — (Date)

          The time the final delivery attempt was made, in RFC 822 date-time format.

        • ExtensionFields — (Array<map>)

          Additional X-headers to include in the DSN.

          • Name — required — (String)

            The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

          • Value — required — (String)

            The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

    • BounceSenderArn — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageId — (String)

        The message ID of the bounce message.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendBulkTemplatedEmail(params = {}, callback) ⇒ AWS.Request

Composes an email message to multiple destinations. The message body is created using an email template.

In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

  • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

  • The message must be sent from a verified email address or domain.

  • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

  • The maximum message size is 10 MB.

  • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

  • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group.

  • The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

Service Reference:

Examples:

Calling the sendBulkTemplatedEmail operation

var params = {
  Destinations: [ /* required */
    {
      Destination: { /* required */
        BccAddresses: [
          'STRING_VALUE',
          /* more items */
        ],
        CcAddresses: [
          'STRING_VALUE',
          /* more items */
        ],
        ToAddresses: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      ReplacementTags: [
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      ReplacementTemplateData: 'STRING_VALUE'
    },
    /* more items */
  ],
  Source: 'STRING_VALUE', /* required */
  Template: 'STRING_VALUE', /* required */
  ConfigurationSetName: 'STRING_VALUE',
  DefaultTags: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  DefaultTemplateData: 'STRING_VALUE',
  ReplyToAddresses: [
    'STRING_VALUE',
    /* more items */
  ],
  ReturnPath: 'STRING_VALUE',
  ReturnPathArn: 'STRING_VALUE',
  SourceArn: 'STRING_VALUE',
  TemplateArn: 'STRING_VALUE'
};
ses.sendBulkTemplatedEmail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Source — (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: Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
    • SourceArn — (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.

    • ReplyToAddresses — (Array<String>)

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

    • ReturnPath — (String)

      The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. 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.

    • ReturnPathArn — (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.

    • ConfigurationSetName — (String)

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

    • DefaultTags — (Array<map>)

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

      • Name — required — (String)

        The name of the tag. The name must:

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

        • Contain less than 256 characters.

      • Value — required — (String)

        The value of the tag. The value must:

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

        • Contain less than 256 characters.

    • Template — (String)

      The template to use when sending this email.

    • TemplateArn — (String)

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

    • DefaultTemplateData — (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 — (Array<map>)

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

      • Destination — required — (map)

        Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

        Note: Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
        • ToAddresses — (Array<String>)

          The recipients to place on the To: line of the message.

        • CcAddresses — (Array<String>)

          The recipients to place on the CC: line of the message.

        • BccAddresses — (Array<String>)

          The recipients to place on the BCC: line of the message.

      • ReplacementTags — (Array<map>)

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

        • Name — required — (String)

          The name of the tag. The name must:

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

          • Contain less than 256 characters.

        • Value — required — (String)

          The value of the tag. The value must:

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

          • Contain less than 256 characters.

      • ReplacementTemplateData — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (Array<map>)

        The unique message identifier returned from the SendBulkTemplatedEmail action.

        • Status — (String)

          The status of a message sent using the SendBulkTemplatedEmail operation.

          Possible values for this parameter include:

          • Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.

          • MessageRejected: The message was rejected because it contained a virus.

          • MailFromDomainNotVerified: The sender's email address or domain was not verified.

          • ConfigurationSetDoesNotExist: The configuration set you specified does not exist.

          • TemplateDoesNotExist: The template you specified does not exist.

          • AccountSuspended: Your account has been shut down because of issues related to your email sending practices.

          • AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.

          • AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.

          • InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist.

          • AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.

          • ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.

          • InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.

          • TransientFailure: Amazon SES was unable to process your request because of a temporary issue.

          • Failed: Amazon SES was unable to process your request. See the error message for additional information.

          Possible values include:
          • "Success"
          • "MessageRejected"
          • "MailFromDomainNotVerified"
          • "ConfigurationSetDoesNotExist"
          • "TemplateDoesNotExist"
          • "AccountSuspended"
          • "AccountThrottled"
          • "AccountDailyQuotaExceeded"
          • "InvalidSendingPoolName"
          • "AccountSendingPaused"
          • "ConfigurationSetSendingPaused"
          • "InvalidParameterValue"
          • "TransientFailure"
          • "Failed"
        • Error — (String)

          A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.

        • MessageId — (String)

          The unique message identifier returned from the SendBulkTemplatedEmail operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendCustomVerificationEmail(params = {}, callback) ⇒ AWS.Request

Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

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

Service Reference:

Examples:

Calling the sendCustomVerificationEmail operation

var params = {
  EmailAddress: 'STRING_VALUE', /* required */
  TemplateName: 'STRING_VALUE', /* required */
  ConfigurationSetName: 'STRING_VALUE'
};
ses.sendCustomVerificationEmail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EmailAddress — (String)

      The email address to verify.

    • TemplateName — (String)

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

    • ConfigurationSetName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageId — (String)

        The unique message identifier returned from the SendCustomVerificationEmail operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendEmail(params = {}, callback) ⇒ AWS.Request

Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements:

  • The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error.

  • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

  • The maximum message size is 10 MB.

  • The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

  • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group.

For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

Service Reference:

Examples:

SendEmail


/* The following example sends a formatted email: */

 var params = {
  Destination: {
   BccAddresses: [
   ], 
   CcAddresses: [
      "recipient3@example.com"
   ], 
   ToAddresses: [
      "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"
   }
  }, 
  ReplyToAddresses: [
  ], 
  ReturnPath: "", 
  ReturnPathArn: "", 
  Source: "sender@example.com", 
  SourceArn: ""
 };
 ses.sendEmail(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    MessageId: "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000"
   }
   */
 });

Calling the sendEmail operation

var params = {
  Destination: { /* required */
    BccAddresses: [
      'STRING_VALUE',
      /* more items */
    ],
    CcAddresses: [
      'STRING_VALUE',
      /* more items */
    ],
    ToAddresses: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Message: { /* required */
    Body: { /* required */
      Html: {
        Data: 'STRING_VALUE', /* required */
        Charset: 'STRING_VALUE'
      },
      Text: {
        Data: 'STRING_VALUE', /* required */
        Charset: 'STRING_VALUE'
      }
    },
    Subject: { /* required */
      Data: 'STRING_VALUE', /* required */
      Charset: 'STRING_VALUE'
    }
  },
  Source: 'STRING_VALUE', /* required */
  ConfigurationSetName: 'STRING_VALUE',
  ReplyToAddresses: [
    'STRING_VALUE',
    /* more items */
  ],
  ReturnPath: 'STRING_VALUE',
  ReturnPathArn: 'STRING_VALUE',
  SourceArn: 'STRING_VALUE',
  Tags: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ses.sendEmail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Source — (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: Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
    • Destination — (map)

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

      • ToAddresses — (Array<String>)

        The recipients to place on the To: line of the message.

      • CcAddresses — (Array<String>)

        The recipients to place on the CC: line of the message.

      • BccAddresses — (Array<String>)

        The recipients to place on the BCC: line of the message.

    • Message — (map)

      The message to be sent.

      • Subject — required — (map)

        The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

        • Data — required — (String)

          The textual data of the content.

        • Charset — (String)

          The character set of the content.

      • Body — required — (map)

        The message body.

        • Text — (map)

          The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).

          • Data — required — (String)

            The textual data of the content.

          • Charset — (String)

            The character set of the content.

        • Html — (map)

          The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.

          • Data — required — (String)

            The textual data of the content.

          • Charset — (String)

            The character set of the content.

    • ReplyToAddresses — (Array<String>)

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

    • ReturnPath — (String)

      The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. 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.

    • SourceArn — (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.

    • ReturnPathArn — (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.

    • Tags — (Array<map>)

      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.

      • Name — required — (String)

        The name of the tag. The name must:

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

        • Contain less than 256 characters.

      • Value — required — (String)

        The value of the tag. The value must:

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

        • Contain less than 256 characters.

    • ConfigurationSetName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageId — (String)

        The unique message identifier returned from the SendEmail action.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendRawEmail(params = {}, callback) ⇒ AWS.Request

Composes an email message and immediately queues it for sending.

This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.

The SendRawEmail operation has the following requirements:

  • You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.

  • If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.

  • The maximum message size, including attachments, is 10 MB.

  • Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.

  • If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.

  • Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.

  • Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.

Additionally, keep the following considerations in mind when using the SendRawEmail operation:

  • Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.

  • If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:

    • X-SES-SOURCE-ARN

    • X-SES-FROM-ARN

    • X-SES-RETURN-PATH-ARN

    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.

Service Reference:

Examples:

SendRawEmail


/* The following example sends an email with an attachment: */

 var params = {
  Destinations: [
  ], 
  FromArn: "", 
  RawMessage: {
   Data: <Binary String>
  }, 
  ReturnPathArn: "", 
  Source: "", 
  SourceArn: ""
 };
 ses.sendRawEmail(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    MessageId: "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000"
   }
   */
 });

Calling the sendRawEmail operation

var params = {
  RawMessage: { /* required */
    Data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
  },
  ConfigurationSetName: 'STRING_VALUE',
  Destinations: [
    'STRING_VALUE',
    /* more items */
  ],
  FromArn: 'STRING_VALUE',
  ReturnPathArn: 'STRING_VALUE',
  Source: 'STRING_VALUE',
  SourceArn: 'STRING_VALUE',
  Tags: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ses.sendRawEmail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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: Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

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

    • Destinations — (Array<String>)

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

    • RawMessage — (map)

      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 <CRLF>, must not exceed 1,000 characters.

      • Data — required — (Buffer, Typed Array, Blob, String)

        The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.

        The To:, CC:, and BCC: headers in the raw message can contain a group list.

        If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail.

        Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

        For more information, go to the Amazon SES Developer Guide.

    • FromArn — (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: For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
    • SourceArn — (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: For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
    • ReturnPathArn — (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: For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
    • Tags — (Array<map>)

      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.

      • Name — required — (String)

        The name of the tag. The name must:

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

        • Contain less than 256 characters.

      • Value — required — (String)

        The value of the tag. The value must:

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

        • Contain less than 256 characters.

    • ConfigurationSetName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageId — (String)

        The unique message identifier returned from the SendRawEmail action.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendTemplatedEmail(params = {}, callback) ⇒ AWS.Request

Composes an email message using an email template and immediately queues it for sending.

In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements:

  • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

  • The message must be sent from a verified email address or domain.

  • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

  • The maximum message size is 10 MB.

  • Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.

  • The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.

For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.

Service Reference:

Examples:

Calling the sendTemplatedEmail operation

var params = {
  Destination: { /* required */
    BccAddresses: [
      'STRING_VALUE',
      /* more items */
    ],
    CcAddresses: [
      'STRING_VALUE',
      /* more items */
    ],
    ToAddresses: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Source: 'STRING_VALUE', /* required */
  Template: 'STRING_VALUE', /* required */
  TemplateData: 'STRING_VALUE', /* required */
  ConfigurationSetName: 'STRING_VALUE',
  ReplyToAddresses: [
    'STRING_VALUE',
    /* more items */
  ],
  ReturnPath: 'STRING_VALUE',
  ReturnPathArn: 'STRING_VALUE',
  SourceArn: 'STRING_VALUE',
  Tags: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TemplateArn: 'STRING_VALUE'
};
ses.sendTemplatedEmail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Source — (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: Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
    • Destination — (map)

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

      • ToAddresses — (Array<String>)

        The recipients to place on the To: line of the message.

      • CcAddresses — (Array<String>)

        The recipients to place on the CC: line of the message.

      • BccAddresses — (Array<String>)

        The recipients to place on the BCC: line of the message.

    • ReplyToAddresses — (Array<String>)

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

    • ReturnPath — (String)

      The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. 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.

    • SourceArn — (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.

    • ReturnPathArn — (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.

    • Tags — (Array<map>)

      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.

      • Name — required — (String)

        The name of the tag. The name must:

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

        • Contain less than 256 characters.

      • Value — required — (String)

        The value of the tag. The value must:

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

        • Contain less than 256 characters.

    • ConfigurationSetName — (String)

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

    • Template — (String)

      The template to use when sending this email.

    • TemplateArn — (String)

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

    • TemplateData — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageId — (String)

        The unique message identifier returned from the SendTemplatedEmail action.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setActiveReceiptRuleSet(params = {}, callback) ⇒ AWS.Request

Sets the specified receipt rule set as the active receipt rule set.

Note: To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

SetActiveReceiptRuleSet


/* The following example sets the active receipt rule set: */

 var params = {
  RuleSetName: "RuleSetToActivate"
 };
 ses.setActiveReceiptRuleSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setActiveReceiptRuleSet operation

var params = {
  RuleSetName: 'STRING_VALUE'
};
ses.setActiveReceiptRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setIdentityDkimEnabled(params = {}, callback) ⇒ AWS.Request

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

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.

Service Reference:

Examples:

SetIdentityDkimEnabled


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

 var params = {
  DkimEnabled: true, 
  Identity: "user@example.com"
 };
 ses.setIdentityDkimEnabled(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setIdentityDkimEnabled operation

var params = {
  DkimEnabled: true || false, /* required */
  Identity: 'STRING_VALUE' /* required */
};
ses.setIdentityDkimEnabled(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

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

    • DkimEnabled — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setIdentityFeedbackForwardingEnabled(params = {}, callback) ⇒ AWS.Request

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: Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

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.

Service Reference:

Examples:

SetIdentityFeedbackForwardingEnabled


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

 var params = {
  ForwardingEnabled: true, 
  Identity: "user@example.com"
 };
 ses.setIdentityFeedbackForwardingEnabled(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setIdentityFeedbackForwardingEnabled operation

var params = {
  ForwardingEnabled: true || false, /* required */
  Identity: 'STRING_VALUE' /* required */
};
ses.setIdentityFeedbackForwardingEnabled(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

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

    • ForwardingEnabled — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setIdentityHeadersInNotificationsEnabled(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

SetIdentityHeadersInNotificationsEnabled


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

 var params = {
  Enabled: true, 
  Identity: "user@example.com", 
  NotificationType: "Bounce"
 };
 ses.setIdentityHeadersInNotificationsEnabled(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setIdentityHeadersInNotificationsEnabled operation

var params = {
  Enabled: true || false, /* required */
  Identity: 'STRING_VALUE', /* required */
  NotificationType: Bounce | Complaint | Delivery /* required */
};
ses.setIdentityHeadersInNotificationsEnabled(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

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

    • NotificationType — (String)

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

      Possible values include:
      • "Bounce"
      • "Complaint"
      • "Delivery"
    • Enabled — (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 will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setIdentityMailFromDomain(params = {}, callback) ⇒ AWS.Request

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

SetIdentityMailFromDomain


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

 var params = {
  BehaviorOnMXFailure: "UseDefaultValue", 
  Identity: "user@example.com", 
  MailFromDomain: "bounces.example.com"
 };
 ses.setIdentityMailFromDomain(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setIdentityMailFromDomain operation

var params = {
  Identity: 'STRING_VALUE', /* required */
  BehaviorOnMXFailure: UseDefaultValue | RejectMessage,
  MailFromDomain: 'STRING_VALUE'
};
ses.setIdentityMailFromDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

      The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

    • MailFromDomain — (String)

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

    • BehaviorOnMXFailure — (String)

      The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return 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.

      Possible values include:
      • "UseDefaultValue"
      • "RejectMessage"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setIdentityNotificationTopic(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

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: */

 var params = {
  Identity: "user@example.com", 
  NotificationType: "Bounce", 
  SnsTopic: "arn:aws:sns:us-west-2:111122223333:MyTopic"
 };
 ses.setIdentityNotificationTopic(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setIdentityNotificationTopic operation

var params = {
  Identity: 'STRING_VALUE', /* required */
  NotificationType: Bounce | Complaint | Delivery, /* required */
  SnsTopic: 'STRING_VALUE'
};
ses.setIdentityNotificationTopic(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identity — (String)

      The identity (email address or domain) that you want to set the Amazon SNS topic for.

      You can only specify a verified identity for this parameter.

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

    • NotificationType — (String)

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

      Possible values include:
      • "Bounce"
      • "Complaint"
      • "Delivery"
    • SnsTopic — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setReceiptRulePosition(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

SetReceiptRulePosition


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

 var params = {
  After: "PutRuleAfterThisRule", 
  RuleName: "RuleToReposition", 
  RuleSetName: "MyRuleSet"
 };
 ses.setReceiptRulePosition(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setReceiptRulePosition operation

var params = {
  RuleName: 'STRING_VALUE', /* required */
  RuleSetName: 'STRING_VALUE', /* required */
  After: 'STRING_VALUE'
};
ses.setReceiptRulePosition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

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

    • RuleName — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

testRenderTemplate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the testRenderTemplate operation

var params = {
  TemplateData: 'STRING_VALUE', /* required */
  TemplateName: 'STRING_VALUE' /* required */
};
ses.testRenderTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateName — (String)

      The name of the template that you want to render.

    • TemplateData — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RenderedTemplate — (String)

        The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateAccountSendingEnabled(params = {}, callback) ⇒ AWS.Request

Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.

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

Service Reference:

Examples:

UpdateAccountSendingEnabled


/* The following example updated the sending status for this account. */

 var params = {
  Enabled: true
 };
 ses.updateAccountSendingEnabled(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the updateAccountSendingEnabled operation

var params = {
  Enabled: true || false
};
ses.updateAccountSendingEnabled(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Enabled — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request

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: 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).

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

Service Reference:

Examples:

Calling the updateConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestination: { /* required */
    MatchingEventTypes: [ /* required */
      send | reject | bounce | complaint | delivery | open | click | renderingFailure,
      /* more items */
    ],
    Name: 'STRING_VALUE', /* required */
    CloudWatchDestination: {
      DimensionConfigurations: [ /* required */
        {
          DefaultDimensionValue: 'STRING_VALUE', /* required */
          DimensionName: 'STRING_VALUE', /* required */
          DimensionValueSource: messageTag | emailHeader | linkTag /* required */
        },
        /* more items */
      ]
    },
    Enabled: true || false,
    KinesisFirehoseDestination: {
      DeliveryStreamARN: 'STRING_VALUE', /* required */
      IAMRoleARN: 'STRING_VALUE' /* required */
    },
    SNSDestination: {
      TopicARN: 'STRING_VALUE' /* required */
    }
  }
};
ses.updateConfigurationSetEventDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set that contains the event destination that you want to update.

    • EventDestination — (map)

      The event destination object that you want to apply to the specified configuration set.

      • Name — required — (String)

        The name of the event destination. The name must:

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

        • Contain less than 64 characters.

      • Enabled — (Boolean)

        Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

      • MatchingEventTypes — required — (Array<String>)

        The type of email sending events to publish to the event destination.

      • KinesisFirehoseDestination — (map)

        An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

        • IAMRoleARN — required — (String)

          The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

        • DeliveryStreamARN — required — (String)

          The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

      • CloudWatchDestination — (map)

        An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

        • DimensionConfigurations — required — (Array<map>)

          A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

          • DimensionName — required — (String)

            The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

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

            • Contain less than 256 characters.

          • DimensionValueSource — required — (String)

            The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.

            Possible values include:
            • "messageTag"
            • "emailHeader"
            • "linkTag"
          • DefaultDimensionValue — required — (String)

            The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

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

            • Contain less than 256 characters.

      • SNSDestination — (map)

        An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

        • TopicARN — required — (String)

          The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateConfigurationSetReputationMetricsEnabled(params = {}, callback) ⇒ AWS.Request

Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.

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

Service Reference:

Examples:

UpdateConfigurationSetReputationMetricsEnabled


/* Set the reputationMetricsEnabled flag for a specific configuration set. */

 var params = {
  ConfigurationSetName: "foo", 
  Enabled: true
 };
 ses.updateConfigurationSetReputationMetricsEnabled(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the updateConfigurationSetReputationMetricsEnabled operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  Enabled: true || false /* required */
};
ses.updateConfigurationSetReputationMetricsEnabled(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to update.

    • Enabled — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateConfigurationSetSendingEnabled(params = {}, callback) ⇒ AWS.Request

Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.

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

Service Reference:

Examples:

UpdateConfigurationSetReputationMetricsEnabled


/* Set the sending enabled flag for a specific configuration set. */

 var params = {
  ConfigurationSetName: "foo", 
  Enabled: true
 };
 ses.updateConfigurationSetSendingEnabled(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the updateConfigurationSetSendingEnabled operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  Enabled: true || false /* required */
};
ses.updateConfigurationSetSendingEnabled(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to update.

    • Enabled — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateConfigurationSetTrackingOptions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateConfigurationSetTrackingOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  TrackingOptions: { /* required */
    CustomRedirectDomain: 'STRING_VALUE'
  }
};
ses.updateConfigurationSetTrackingOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationSetName — (String)

      The name of the configuration set for which you want to update the custom tracking domain.

    • TrackingOptions — (map)

      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.

      • CustomRedirectDomain — (String)

        The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateCustomVerificationEmailTemplate(params = {}, callback) ⇒ AWS.Request

Updates an existing custom verification email template.

For more information about 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.

Service Reference:

Examples:

Calling the updateCustomVerificationEmailTemplate operation

var params = {
  TemplateName: 'STRING_VALUE', /* required */
  FailureRedirectionURL: 'STRING_VALUE',
  FromEmailAddress: 'STRING_VALUE',
  SuccessRedirectionURL: 'STRING_VALUE',
  TemplateContent: 'STRING_VALUE',
  TemplateSubject: 'STRING_VALUE'
};
ses.updateCustomVerificationEmailTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateName — (String)

      The name of the custom verification email template that you want to update.

    • FromEmailAddress — (String)

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

    • TemplateSubject — (String)

      The subject line of the custom verification email.

    • TemplateContent — (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.

    • SuccessRedirectionURL — (String)

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

    • FailureRedirectionURL — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateReceiptRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

UpdateReceiptRule


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

 var params = {
  Rule: {
   Actions: [
      {
     S3Action: {
      BucketName: "MyBucket", 
      ObjectKeyPrefix: "email"
     }
    }
   ], 
   Enabled: true, 
   Name: "MyRule", 
   ScanEnabled: true, 
   TlsPolicy: "Optional"
  }, 
  RuleSetName: "MyRuleSet"
 };
 ses.updateReceiptRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the updateReceiptRule operation

var params = {
  Rule: { /* required */
    Name: 'STRING_VALUE', /* required */
    Actions: [
      {
        AddHeaderAction: {
          HeaderName: 'STRING_VALUE', /* required */
          HeaderValue: 'STRING_VALUE' /* required */
        },
        BounceAction: {
          Message: 'STRING_VALUE', /* required */
          Sender: 'STRING_VALUE', /* required */
          SmtpReplyCode: 'STRING_VALUE', /* required */
          StatusCode: 'STRING_VALUE',
          TopicArn: 'STRING_VALUE'
        },
        LambdaAction: {
          FunctionArn: 'STRING_VALUE', /* required */
          InvocationType: Event | RequestResponse,
          TopicArn: 'STRING_VALUE'
        },
        S3Action: {
          BucketName: 'STRING_VALUE', /* required */
          KmsKeyArn: 'STRING_VALUE',
          ObjectKeyPrefix: 'STRING_VALUE',
          TopicArn: 'STRING_VALUE'
        },
        SNSAction: {
          TopicArn: 'STRING_VALUE', /* required */
          Encoding: UTF-8 | Base64
        },
        StopAction: {
          Scope: RuleSet, /* required */
          TopicArn: 'STRING_VALUE'
        },
        WorkmailAction: {
          OrganizationArn: 'STRING_VALUE', /* required */
          TopicArn: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    Enabled: true || false,
    Recipients: [
      'STRING_VALUE',
      /* more items */
    ],
    ScanEnabled: true || false,
    TlsPolicy: Require | Optional
  },
  RuleSetName: 'STRING_VALUE' /* required */
};
ses.updateReceiptRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RuleSetName — (String)

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

    • Rule — (map)

      A data structure that contains the updated receipt rule information.

      • Name — required — (String)

        The name of the receipt rule. The name must:

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

        • Start and end with a letter or number.

        • Contain less than 64 characters.

      • Enabled — (Boolean)

        If true, the receipt rule is active. The default value is false.

      • TlsPolicy — (String)

        Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

        Possible values include:
        • "Require"
        • "Optional"
      • Recipients — (Array<String>)

        The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

      • Actions — (Array<map>)

        An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

        • S3Action — (map)

          Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

          • TopicArn — (String)

            The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • BucketName — required — (String)

            The name of the Amazon S3 bucket that incoming email will be saved to.

          • ObjectKeyPrefix — (String)

            The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

          • KmsKeyArn — (String)

            The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

            • To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

            • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

            For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

            Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

        • BounceAction — (map)

          Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • SmtpReplyCode — required — (String)

            The SMTP reply code, as defined by RFC 5321.

          • StatusCode — (String)

            The SMTP enhanced status code, as defined by RFC 3463.

          • Message — required — (String)

            Human-readable text to include in the bounce message.

          • Sender — required — (String)

            The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

        • WorkmailAction — (map)

          Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • OrganizationArn — required — (String)

            The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

        • LambdaAction — (map)

          Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • FunctionArn — required — (String)

            The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

          • InvocationType — (String)

            The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

            There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

             Possible values include:
            • "Event"
            • "RequestResponse"
        • StopAction — (map)

          Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

          • Scope — required — (String)

            The scope of the StopAction. The only acceptable value is RuleSet.

            Possible values include:
            • "RuleSet"
          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

        • AddHeaderAction — (map)

          Adds a header to the received email.

          • HeaderName — required — (String)

            The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

          • HeaderValue — required — (String)

            Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

        • SNSAction — (map)

          Publishes the email content within a notification to Amazon SNS.

          • TopicArn — required — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

          • Encoding — (String)

            The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

            Possible values include:
            • "UTF-8"
            • "Base64"
      • ScanEnabled — (Boolean)

        If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateTemplate(params = {}, callback) ⇒ AWS.Request

Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

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

Service Reference:

Examples:

Calling the updateTemplate operation

var params = {
  Template: { /* required */
    TemplateName: 'STRING_VALUE', /* required */
    HtmlPart: 'STRING_VALUE',
    SubjectPart: 'STRING_VALUE',
    TextPart: 'STRING_VALUE'
  }
};
ses.updateTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Template — (map)

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

      • TemplateName — required — (String)

        The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

      • SubjectPart — (String)

        The subject line of the email.

      • TextPart — (String)

        The email body that will be visible to recipients whose email clients do not display HTML.

      • HtmlPart — (String)

        The HTML body of the email.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

verifyDomainDkim(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

VerifyDomainDkim


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

 var params = {
  Domain: "example.com"
 };
 ses.verifyDomainDkim(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DkimTokens: [
       "EXAMPLEq76owjnks3lnluwg65scbemvw", 
       "EXAMPLEi3dnsj67hstzaj673klariwx2", 
       "EXAMPLEwfbtcukvimehexktmdtaz6naj"
    ]
   }
   */
 });

Calling the verifyDomainDkim operation

var params = {
  Domain: 'STRING_VALUE' /* required */
};
ses.verifyDomainDkim(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Domain — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DkimTokens — (Array<String>)

        A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.

        Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

        For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

verifyDomainIdentity(params = {}, callback) ⇒ AWS.Request

Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

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

Service Reference:

Examples:

VerifyDomainIdentity


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

 var params = {
  Domain: "example.com"
 };
 ses.verifyDomainIdentity(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VerificationToken: "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE"
   }
   */
 });

Calling the verifyDomainIdentity operation

var params = {
  Domain: 'STRING_VALUE' /* required */
};
ses.verifyDomainIdentity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Domain — (String)

      The domain to be verified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerificationToken — (String)

        A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.

        As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

verifyEmailAddress(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

VerifyEmailAddress


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

 var params = {
  EmailAddress: "user@example.com"
 };
 ses.verifyEmailAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the verifyEmailAddress operation

var params = {
  EmailAddress: 'STRING_VALUE' /* required */
};
ses.verifyEmailAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EmailAddress — (String)

      The email address to be verified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

verifyEmailIdentity(params = {}, callback) ⇒ AWS.Request

Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.

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

Service Reference:

Examples:

VerifyEmailIdentity


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

 var params = {
  EmailAddress: "user@example.com"
 };
 ses.verifyEmailIdentity(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the verifyEmailIdentity operation

var params = {
  EmailAddress: 'STRING_VALUE' /* required */
};
ses.verifyEmailIdentity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EmailAddress — (String)

      The email address to be verified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given SES resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the identityExists state

var params = {
  Identities: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ses.waitFor('identityExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

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

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

ses.waitFor('identityExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the identityExists state by periodically calling the underlying SES.getIdentityVerificationAttributes() operation every 3 seconds (at most 20 times).

Examples:

Waiting for the identityExists state

var params = {
  Identities: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ses.waitFor('identityExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • Identities — (Array<String>)

      A list of identities.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VerificationAttributes — (map<map>)

        A map of Identities to IdentityVerificationAttributes objects.

        • VerificationStatus — required — (String)

          The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".

          Possible values include:
          • "Pending"
          • "Success"
          • "Failed"
          • "TemporaryFailure"
          • "NotStarted"
        • VerificationToken — (String)

          The verification token for a domain identity. Null for email address identities.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: