SDK for PHP 3.x

Client: Aws\Ses\SesClient
Service ID: email
Version: 2010-12-01

This page describes the parameters and results for the operations of the Amazon Simple Email Service (2010-12-01), and shows how to use the Aws\Ses\SesClient object to call the described operations. This documentation is specific to the 2010-12-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CloneReceiptRuleSet ( array $params = [] )
Creates a receipt rule set by cloning an existing one.
CreateConfigurationSet ( array $params = [] )
Creates a configuration set.
CreateConfigurationSetEventDestination ( array $params = [] )
Creates a configuration set event destination.
CreateConfigurationSetTrackingOptions ( array $params = [] )
Creates an association between a configuration set and a custom domain for open and click event tracking.
CreateCustomVerificationEmailTemplate ( array $params = [] )
Creates a new custom verification email template.
CreateReceiptFilter ( array $params = [] )
Creates a new IP address filter.
CreateReceiptRule ( array $params = [] )
Creates a receipt rule.
CreateReceiptRuleSet ( array $params = [] )
Creates an empty receipt rule set.
CreateTemplate ( array $params = [] )
Creates an email template.
DeleteConfigurationSet ( array $params = [] )
Deletes a configuration set.
DeleteConfigurationSetEventDestination ( array $params = [] )
Deletes a configuration set event destination.
DeleteConfigurationSetTrackingOptions ( array $params = [] )
Deletes an association between a configuration set and a custom domain for open and click event tracking.
DeleteCustomVerificationEmailTemplate ( array $params = [] )
Deletes an existing custom verification email template.
DeleteIdentity ( array $params = [] )
Deletes the specified identity (an email address or a domain) from the list of verified identities.
DeleteIdentityPolicy ( array $params = [] )
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
DeleteReceiptFilter ( array $params = [] )
Deletes the specified IP address filter.
DeleteReceiptRule ( array $params = [] )
Deletes the specified receipt rule.
DeleteReceiptRuleSet ( array $params = [] )
Deletes the specified receipt rule set and all of the receipt rules it contains.
DeleteTemplate ( array $params = [] )
Deletes an email template.
DeleteVerifiedEmailAddress ( array $params = [] )
Deprecated.
DescribeActiveReceiptRuleSet ( array $params = [] )
Returns the metadata and receipt rules for the receipt rule set that is currently active.
DescribeConfigurationSet ( array $params = [] )
Returns the details of the specified configuration set.
DescribeReceiptRule ( array $params = [] )
Returns the details of the specified receipt rule.
DescribeReceiptRuleSet ( array $params = [] )
Returns the details of the specified receipt rule set.
GetAccountSendingEnabled ( array $params = [] )
Returns the email sending status of the Amazon SES account for the current Region.
GetCustomVerificationEmailTemplate ( array $params = [] )
Returns the custom email verification template for the template name you specify.
GetIdentityDkimAttributes ( array $params = [] )
Returns the current status of Easy DKIM signing for an entity.
GetIdentityMailFromDomainAttributes ( array $params = [] )
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
GetIdentityNotificationAttributes ( array $params = [] )
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
GetIdentityPolicies ( array $params = [] )
Returns the requested sending authorization policies for the given identity (an email address or a domain).
GetIdentityVerificationAttributes ( array $params = [] )
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
GetSendQuota ( array $params = [] )
Provides the sending limits for the Amazon SES account.
GetSendStatistics ( array $params = [] )
Provides sending statistics for the current Amazon Web Services Region.
GetTemplate ( array $params = [] )
Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
ListConfigurationSets ( array $params = [] )
Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region.
ListCustomVerificationEmailTemplates ( array $params = [] )
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
ListIdentities ( array $params = [] )
Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
ListIdentityPolicies ( array $params = [] )
Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain).
ListReceiptFilters ( array $params = [] )
Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
ListReceiptRuleSets ( array $params = [] )
Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region.
ListTemplates ( array $params = [] )
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
ListVerifiedEmailAddresses ( array $params = [] )
Deprecated.
PutConfigurationSetDeliveryOptions ( array $params = [] )
Adds or updates the delivery options for a configuration set.
PutIdentityPolicy ( array $params = [] )
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
ReorderReceiptRuleSet ( array $params = [] )
Reorders the receipt rules within a receipt rule set.
SendBounce ( array $params = [] )
Generates and sends a bounce message to the sender of an email you received through Amazon SES.
SendBulkTemplatedEmail ( array $params = [] )
Composes an email message to multiple destinations.
SendCustomVerificationEmail ( array $params = [] )
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it.
SendEmail ( array $params = [] )
Composes an email message and immediately queues it for sending.
SendRawEmail ( array $params = [] )
Composes an email message and immediately queues it for sending.
SendTemplatedEmail ( array $params = [] )
Composes an email message using an email template and immediately queues it for sending.
SetActiveReceiptRuleSet ( array $params = [] )
Sets the specified receipt rule set as the active receipt rule set.
SetIdentityDkimEnabled ( array $params = [] )
Enables or disables Easy DKIM signing of email sent from an identity.
SetIdentityFeedbackForwardingEnabled ( array $params = [] )
Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.
SetIdentityHeadersInNotificationsEnabled ( array $params = [] )
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.
SetIdentityMailFromDomain ( array $params = [] )
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
SetIdentityNotificationTopic ( array $params = [] )
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications.
SetReceiptRulePosition ( array $params = [] )
Sets the position of the specified receipt rule in the receipt rule set.
TestRenderTemplate ( array $params = [] )
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
UpdateAccountSendingEnabled ( array $params = [] )
Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region.
UpdateConfigurationSetEventDestination ( array $params = [] )
Updates the event destination of a configuration set.
UpdateConfigurationSetReputationMetricsEnabled ( array $params = [] )
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region.
UpdateConfigurationSetSendingEnabled ( array $params = [] )
Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region.
UpdateConfigurationSetTrackingOptions ( array $params = [] )
Modifies an association between a configuration set and a custom domain for open and click event tracking.
UpdateCustomVerificationEmailTemplate ( array $params = [] )
Updates an existing custom verification email template.
UpdateReceiptRule ( array $params = [] )
Updates a receipt rule.
UpdateTemplate ( array $params = [] )
Updates an email template.
VerifyDomainDkim ( array $params = [] )
Returns a set of DKIM tokens for a domain identity.
VerifyDomainIdentity ( array $params = [] )
Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it.
VerifyEmailAddress ( array $params = [] )
Deprecated.
VerifyEmailIdentity ( array $params = [] )
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListCustomVerificationEmailTemplates
ListIdentities
ListVerifiedEmailAddresses

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
IdentityExists GetIdentityVerificationAttributes 3 20

Operations

CloneReceiptRuleSet

$result = $client->cloneReceiptRuleSet([/* ... */]);
$promise = $client->cloneReceiptRuleSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cloneReceiptRuleSet([
    'OriginalRuleSetName' => '<string>', // REQUIRED
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
OriginalRuleSetName
Required: Yes
Type: string

The name of the rule set to clone.

RuleSetName
Required: Yes
Type: string

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

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

  • Start and end with a letter or number.

  • Contain 64 characters or fewer.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

AlreadyExistsException:

Indicates that a resource could not be created because of a naming conflict.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

Examples

Example 1: CloneReceiptRuleSet

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

$result = $client->cloneReceiptRuleSet([
    'OriginalRuleSetName' => 'RuleSetToClone',
    'RuleSetName' => 'RuleSetToCreate',
]);

CreateConfigurationSet

$result = $client->createConfigurationSet([/* ... */]);
$promise = $client->createConfigurationSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createConfigurationSet([
    'ConfigurationSet' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
ConfigurationSet
Required: Yes
Type: ConfigurationSet structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetAlreadyExistsException:

Indicates that the configuration set could not be created because of a naming conflict.

InvalidConfigurationSetException:

Indicates that the configuration set is invalid. See the error message for details.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

CreateConfigurationSetEventDestination

$result = $client->createConfigurationSetEventDestination([/* ... */]);
$promise = $client->createConfigurationSetEventDestinationAsync([/* ... */]);

Creates a configuration set event destination.

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 Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->createConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestination' => [ // REQUIRED
        'CloudWatchDestination' => [
            'DimensionConfigurations' => [ // REQUIRED
                [
                    'DefaultDimensionValue' => '<string>', // REQUIRED
                    'DimensionName' => '<string>', // REQUIRED
                    'DimensionValueSource' => 'messageTag|emailHeader|linkTag', // REQUIRED
                ],
                // ...
            ],
        ],
        'Enabled' => true || false,
        'KinesisFirehoseDestination' => [
            'DeliveryStreamARN' => '<string>', // REQUIRED
            'IAMRoleARN' => '<string>', // REQUIRED
        ],
        'MatchingEventTypes' => ['<string>', ...], // REQUIRED
        'Name' => '<string>', // REQUIRED
        'SNSDestination' => [
            'TopicARN' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

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

EventDestination
Required: Yes
Type: EventDestination structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

EventDestinationAlreadyExistsException:

Indicates that the event destination could not be created because of a naming conflict.

InvalidCloudWatchDestinationException:

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

InvalidFirehoseDestinationException:

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

InvalidSNSDestinationException:

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

CreateConfigurationSetTrackingOptions

$result = $client->createConfigurationSetTrackingOptions([/* ... */]);
$promise = $client->createConfigurationSetTrackingOptionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createConfigurationSetTrackingOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'TrackingOptions' => [ // REQUIRED
        'CustomRedirectDomain' => '<string>',
    ],
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

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

TrackingOptions
Required: Yes
Type: TrackingOptions structure

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

TrackingOptionsAlreadyExistsException:

Indicates that the configuration set you specified already contains a TrackingOptions object.

InvalidTrackingOptionsException:

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:

  • When the tracking domain you specified is not verified in Amazon SES.

  • When the tracking domain you specified is not a valid domain or subdomain.

CreateCustomVerificationEmailTemplate

$result = $client->createCustomVerificationEmailTemplate([/* ... */]);
$promise = $client->createCustomVerificationEmailTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createCustomVerificationEmailTemplate([
    'FailureRedirectionURL' => '<string>', // REQUIRED
    'FromEmailAddress' => '<string>', // REQUIRED
    'SuccessRedirectionURL' => '<string>', // REQUIRED
    'TemplateContent' => '<string>', // REQUIRED
    'TemplateName' => '<string>', // REQUIRED
    'TemplateSubject' => '<string>', // REQUIRED
]);

Parameter Details

Members
FailureRedirectionURL
Required: Yes
Type: string

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

FromEmailAddress
Required: Yes
Type: string

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

SuccessRedirectionURL
Required: Yes
Type: string

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

TemplateContent
Required: Yes
Type: 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.

TemplateName
Required: Yes
Type: string

The name of the custom verification email template.

TemplateSubject
Required: Yes
Type: string

The subject line of the custom verification email.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CustomVerificationEmailTemplateAlreadyExistsException:

Indicates that a custom verification email template with the name you specified already exists.

FromEmailAddressNotVerifiedException:

Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.

CustomVerificationEmailInvalidContentException:

Indicates that custom verification email template provided content is invalid.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

CreateReceiptFilter

$result = $client->createReceiptFilter([/* ... */]);
$promise = $client->createReceiptFilterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createReceiptFilter([
    'Filter' => [ // REQUIRED
        'IpFilter' => [ // REQUIRED
            'Cidr' => '<string>', // REQUIRED
            'Policy' => 'Block|Allow', // REQUIRED
        ],
        'Name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
Filter
Required: Yes
Type: ReceiptFilter structure

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

AlreadyExistsException:

Indicates that a resource could not be created because of a naming conflict.

Examples

Example 1: CreateReceiptFilter

The following example creates a new IP address filter:

$result = $client->createReceiptFilter([
    'Filter' => [
        'IpFilter' => [
            'Cidr' => '1.2.3.4/24',
            'Policy' => 'Allow',
        ],
        'Name' => 'MyFilter',
    ],
]);

CreateReceiptRule

$result = $client->createReceiptRule([/* ... */]);
$promise = $client->createReceiptRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createReceiptRule([
    'After' => '<string>',
    'Rule' => [ // REQUIRED
        'Actions' => [
            [
                'AddHeaderAction' => [
                    'HeaderName' => '<string>', // REQUIRED
                    'HeaderValue' => '<string>', // REQUIRED
                ],
                'BounceAction' => [
                    'Message' => '<string>', // REQUIRED
                    'Sender' => '<string>', // REQUIRED
                    'SmtpReplyCode' => '<string>', // REQUIRED
                    'StatusCode' => '<string>',
                    'TopicArn' => '<string>',
                ],
                'LambdaAction' => [
                    'FunctionArn' => '<string>', // REQUIRED
                    'InvocationType' => 'Event|RequestResponse',
                    'TopicArn' => '<string>',
                ],
                'S3Action' => [
                    'BucketName' => '<string>', // REQUIRED
                    'IamRoleArn' => '<string>',
                    'KmsKeyArn' => '<string>',
                    'ObjectKeyPrefix' => '<string>',
                    'TopicArn' => '<string>',
                ],
                'SNSAction' => [
                    'Encoding' => 'UTF-8|Base64',
                    'TopicArn' => '<string>', // REQUIRED
                ],
                'StopAction' => [
                    'Scope' => 'RuleSet', // REQUIRED
                    'TopicArn' => '<string>',
                ],
                'WorkmailAction' => [
                    'OrganizationArn' => '<string>', // REQUIRED
                    'TopicArn' => '<string>',
                ],
            ],
            // ...
        ],
        'Enabled' => true || false,
        'Name' => '<string>', // REQUIRED
        'Recipients' => ['<string>', ...],
        'ScanEnabled' => true || false,
        'TlsPolicy' => 'Require|Optional',
    ],
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
After
Type: string

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

Rule
Required: Yes
Type: ReceiptRule structure

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

RuleSetName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidSnsTopicException:

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidS3ConfigurationException:

Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidLambdaFunctionException:

Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

AlreadyExistsException:

Indicates that a resource could not be created because of a naming conflict.

RuleDoesNotExistException:

Indicates that the provided receipt rule does not exist.

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

Examples

Example 1: CreateReceiptRule

The following example creates a new receipt rule:

$result = $client->createReceiptRule([
    'After' => '',
    'Rule' => [
        'Actions' => [
            [
                'S3Action' => [
                    'BucketName' => 'MyBucket',
                    'ObjectKeyPrefix' => 'email',
                ],
            ],
        ],
        'Enabled' => 1,
        'Name' => 'MyRule',
        'ScanEnabled' => 1,
        'TlsPolicy' => 'Optional',
    ],
    'RuleSetName' => 'MyRuleSet',
]);

CreateReceiptRuleSet

$result = $client->createReceiptRuleSet([/* ... */]);
$promise = $client->createReceiptRuleSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createReceiptRuleSet([
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
RuleSetName
Required: Yes
Type: string

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

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

  • Start and end with a letter or number.

  • Contain 64 characters or fewer.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AlreadyExistsException:

Indicates that a resource could not be created because of a naming conflict.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

Examples

Example 1: CreateReceiptRuleSet

The following example creates an empty receipt rule set:

$result = $client->createReceiptRuleSet([
    'RuleSetName' => 'MyRuleSet',
]);

CreateTemplate

$result = $client->createTemplate([/* ... */]);
$promise = $client->createTemplateAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createTemplate([
    'Template' => [ // REQUIRED
        'HtmlPart' => '<string>',
        'SubjectPart' => '<string>',
        'TemplateName' => '<string>', // REQUIRED
        'TextPart' => '<string>',
    ],
]);

Parameter Details

Members
Template
Required: Yes
Type: Template structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AlreadyExistsException:

Indicates that a resource could not be created because of a naming conflict.

InvalidTemplateException:

Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

DeleteConfigurationSet

$result = $client->deleteConfigurationSet([/* ... */]);
$promise = $client->deleteConfigurationSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteConfigurationSet([
    'ConfigurationSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

The name of the configuration set to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

DeleteConfigurationSetEventDestination

$result = $client->deleteConfigurationSetEventDestination([/* ... */]);
$promise = $client->deleteConfigurationSetEventDestinationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestinationName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

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

EventDestinationName
Required: Yes
Type: string

The name of the event destination to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

EventDestinationDoesNotExistException:

Indicates that the event destination does not exist.

DeleteConfigurationSetTrackingOptions

$result = $client->deleteConfigurationSetTrackingOptions([/* ... */]);
$promise = $client->deleteConfigurationSetTrackingOptionsAsync([/* ... */]);

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.

Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

Parameter Syntax

$result = $client->deleteConfigurationSetTrackingOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

The name of the configuration set.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

TrackingOptionsDoesNotExistException:

Indicates that the TrackingOptions object you specified does not exist.

DeleteCustomVerificationEmailTemplate

$result = $client->deleteCustomVerificationEmailTemplate([/* ... */]);
$promise = $client->deleteCustomVerificationEmailTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteCustomVerificationEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
TemplateName
Required: Yes
Type: string

The name of the custom verification email template to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteIdentity

$result = $client->deleteIdentity([/* ... */]);
$promise = $client->deleteIdentityAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteIdentity([
    'Identity' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identity
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: DeleteIdentity

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

$result = $client->deleteIdentity([
    'Identity' => 'user@example.com',
]);

DeleteIdentityPolicy

$result = $client->deleteIdentityPolicy([/* ... */]);
$promise = $client->deleteIdentityPolicyAsync([/* ... */]);

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

This operation is for the identity owner only. If you have not verified the identity, it returns 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.

Parameter Syntax

$result = $client->deleteIdentityPolicy([
    'Identity' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identity
Required: Yes
Type: string

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

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

PolicyName
Required: Yes
Type: string

The name of the policy to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: DeleteIdentityPolicy

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

$result = $client->deleteIdentityPolicy([
    'Identity' => 'user@example.com',
    'PolicyName' => 'MyPolicy',
]);

DeleteReceiptFilter

$result = $client->deleteReceiptFilter([/* ... */]);
$promise = $client->deleteReceiptFilterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteReceiptFilter([
    'FilterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
FilterName
Required: Yes
Type: string

The name of the IP address filter to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: DeleteReceiptFilter

The following example deletes an IP address filter:

$result = $client->deleteReceiptFilter([
    'FilterName' => 'MyFilter',
]);

DeleteReceiptRule

$result = $client->deleteReceiptRule([/* ... */]);
$promise = $client->deleteReceiptRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteReceiptRule([
    'RuleName' => '<string>', // REQUIRED
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
RuleName
Required: Yes
Type: string

The name of the receipt rule to delete.

RuleSetName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

Examples

Example 1: DeleteReceiptRule

The following example deletes a receipt rule:

$result = $client->deleteReceiptRule([
    'RuleName' => 'MyRule',
    'RuleSetName' => 'MyRuleSet',
]);

DeleteReceiptRuleSet

$result = $client->deleteReceiptRuleSet([/* ... */]);
$promise = $client->deleteReceiptRuleSetAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->deleteReceiptRuleSet([
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
RuleSetName
Required: Yes
Type: string

The name of the receipt rule set to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CannotDeleteException:

Indicates that the delete operation could not be completed.

Examples

Example 1: DeleteReceiptRuleSet

The following example deletes a receipt rule set:

$result = $client->deleteReceiptRuleSet([
    'RuleSetName' => 'MyRuleSet',
]);

DeleteTemplate

$result = $client->deleteTemplate([/* ... */]);
$promise = $client->deleteTemplateAsync([/* ... */]);

Deletes an email template.

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

Parameter Syntax

$result = $client->deleteTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
TemplateName
Required: Yes
Type: string

The name of the template to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteVerifiedEmailAddress

$result = $client->deleteVerifiedEmailAddress([/* ... */]);
$promise = $client->deleteVerifiedEmailAddressAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteVerifiedEmailAddress([
    'EmailAddress' => '<string>', // REQUIRED
]);

Parameter Details

Members
EmailAddress
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: DeleteVerifiedEmailAddress

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

$result = $client->deleteVerifiedEmailAddress([
    'EmailAddress' => 'user@example.com',
]);

DescribeActiveReceiptRuleSet

$result = $client->describeActiveReceiptRuleSet([/* ... */]);
$promise = $client->describeActiveReceiptRuleSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeActiveReceiptRuleSet([
]);

Parameter Details

Members

Result Syntax

[
    'Metadata' => [
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
    ],
    'Rules' => [
        [
            'Actions' => [
                [
                    'AddHeaderAction' => [
                        'HeaderName' => '<string>',
                        'HeaderValue' => '<string>',
                    ],
                    'BounceAction' => [
                        'Message' => '<string>',
                        'Sender' => '<string>',
                        'SmtpReplyCode' => '<string>',
                        'StatusCode' => '<string>',
                        'TopicArn' => '<string>',
                    ],
                    'LambdaAction' => [
                        'FunctionArn' => '<string>',
                        'InvocationType' => 'Event|RequestResponse',
                        'TopicArn' => '<string>',
                    ],
                    'S3Action' => [
                        'BucketName' => '<string>',
                        'IamRoleArn' => '<string>',
                        'KmsKeyArn' => '<string>',
                        'ObjectKeyPrefix' => '<string>',
                        'TopicArn' => '<string>',
                    ],
                    'SNSAction' => [
                        'Encoding' => 'UTF-8|Base64',
                        'TopicArn' => '<string>',
                    ],
                    'StopAction' => [
                        'Scope' => 'RuleSet',
                        'TopicArn' => '<string>',
                    ],
                    'WorkmailAction' => [
                        'OrganizationArn' => '<string>',
                        'TopicArn' => '<string>',
                    ],
                ],
                // ...
            ],
            'Enabled' => true || false,
            'Name' => '<string>',
            'Recipients' => ['<string>', ...],
            'ScanEnabled' => true || false,
            'TlsPolicy' => 'Require|Optional',
        ],
        // ...
    ],
]

Result Details

Members
Metadata
Type: ReceiptRuleSetMetadata structure

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

Rules
Type: Array of ReceiptRule structures

The receipt rules that belong to the active rule set.

Errors

There are no errors described for this operation.

Examples

Example 1: DescribeActiveReceiptRuleSet

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

$result = $client->describeActiveReceiptRuleSet([
]);

Result syntax:

[
    'Metadata' => [
        'CreatedTimestamp' => ,
        'Name' => 'default-rule-set',
    ],
    'Rules' => [
        [
            'Actions' => [
                [
                    'S3Action' => [
                        'BucketName' => 'MyBucket',
                        'ObjectKeyPrefix' => 'email',
                    ],
                ],
            ],
            'Enabled' => 1,
            'Name' => 'MyRule',
            'ScanEnabled' => 1,
            'TlsPolicy' => 'Optional',
        ],
    ],
]

DescribeConfigurationSet

$result = $client->describeConfigurationSet([/* ... */]);
$promise = $client->describeConfigurationSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeConfigurationSet([
    'ConfigurationSetAttributeNames' => ['<string>', ...],
    'ConfigurationSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationSetAttributeNames
Type: Array of strings

A list of configuration set attributes to return.

ConfigurationSetName
Required: Yes
Type: string

The name of the configuration set to describe.

Result Syntax

[
    'ConfigurationSet' => [
        'Name' => '<string>',
    ],
    'DeliveryOptions' => [
        'TlsPolicy' => 'Require|Optional',
    ],
    'EventDestinations' => [
        [
            'CloudWatchDestination' => [
                'DimensionConfigurations' => [
                    [
                        'DefaultDimensionValue' => '<string>',
                        'DimensionName' => '<string>',
                        'DimensionValueSource' => 'messageTag|emailHeader|linkTag',
                    ],
                    // ...
                ],
            ],
            'Enabled' => true || false,
            'KinesisFirehoseDestination' => [
                'DeliveryStreamARN' => '<string>',
                'IAMRoleARN' => '<string>',
            ],
            'MatchingEventTypes' => ['<string>', ...],
            'Name' => '<string>',
            'SNSDestination' => [
                'TopicARN' => '<string>',
            ],
        ],
        // ...
    ],
    'ReputationOptions' => [
        'LastFreshStart' => <DateTime>,
        'ReputationMetricsEnabled' => true || false,
        'SendingEnabled' => true || false,
    ],
    'TrackingOptions' => [
        'CustomRedirectDomain' => '<string>',
    ],
]

Result Details

Members
ConfigurationSet
Type: ConfigurationSet structure

The configuration set object associated with the specified configuration set.

DeliveryOptions
Type: DeliveryOptions structure

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

EventDestinations
Type: Array of EventDestination structures

A list of event destinations associated with the configuration set.

ReputationOptions
Type: ReputationOptions structure

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

TrackingOptions
Type: TrackingOptions structure

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

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

DescribeReceiptRule

$result = $client->describeReceiptRule([/* ... */]);
$promise = $client->describeReceiptRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeReceiptRule([
    'RuleName' => '<string>', // REQUIRED
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
RuleName
Required: Yes
Type: string

The name of the receipt rule.

RuleSetName
Required: Yes
Type: string

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

Result Syntax

[
    'Rule' => [
        'Actions' => [
            [
                'AddHeaderAction' => [
                    'HeaderName' => '<string>',
                    'HeaderValue' => '<string>',
                ],
                'BounceAction' => [
                    'Message' => '<string>',
                    'Sender' => '<string>',
                    'SmtpReplyCode' => '<string>',
                    'StatusCode' => '<string>',
                    'TopicArn' => '<string>',
                ],
                'LambdaAction' => [
                    'FunctionArn' => '<string>',
                    'InvocationType' => 'Event|RequestResponse',
                    'TopicArn' => '<string>',
                ],
                'S3Action' => [
                    'BucketName' => '<string>',
                    'IamRoleArn' => '<string>',
                    'KmsKeyArn' => '<string>',
                    'ObjectKeyPrefix' => '<string>',
                    'TopicArn' => '<string>',
                ],
                'SNSAction' => [
                    'Encoding' => 'UTF-8|Base64',
                    'TopicArn' => '<string>',
                ],
                'StopAction' => [
                    'Scope' => 'RuleSet',
                    'TopicArn' => '<string>',
                ],
                'WorkmailAction' => [
                    'OrganizationArn' => '<string>',
                    'TopicArn' => '<string>',
                ],
            ],
            // ...
        ],
        'Enabled' => true || false,
        'Name' => '<string>',
        'Recipients' => ['<string>', ...],
        'ScanEnabled' => true || false,
        'TlsPolicy' => 'Require|Optional',
    ],
]

Result Details

Members
Rule
Type: ReceiptRule structure

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

Errors

RuleDoesNotExistException:

Indicates that the provided receipt rule does not exist.

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

Examples

Example 1: DescribeReceiptRule

The following example returns the details of a receipt rule:

$result = $client->describeReceiptRule([
    'RuleName' => 'MyRule',
    'RuleSetName' => 'MyRuleSet',
]);

Result syntax:

[
    'Rule' => [
        'Actions' => [
            [
                'S3Action' => [
                    'BucketName' => 'MyBucket',
                    'ObjectKeyPrefix' => 'email',
                ],
            ],
        ],
        'Enabled' => 1,
        'Name' => 'MyRule',
        'ScanEnabled' => 1,
        'TlsPolicy' => 'Optional',
    ],
]

DescribeReceiptRuleSet

$result = $client->describeReceiptRuleSet([/* ... */]);
$promise = $client->describeReceiptRuleSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeReceiptRuleSet([
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
RuleSetName
Required: Yes
Type: string

The name of the receipt rule set to describe.

Result Syntax

[
    'Metadata' => [
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
    ],
    'Rules' => [
        [
            'Actions' => [
                [
                    'AddHeaderAction' => [
                        'HeaderName' => '<string>',
                        'HeaderValue' => '<string>',
                    ],
                    'BounceAction' => [
                        'Message' => '<string>',
                        'Sender' => '<string>',
                        'SmtpReplyCode' => '<string>',
                        'StatusCode' => '<string>',
                        'TopicArn' => '<string>',
                    ],
                    'LambdaAction' => [
                        'FunctionArn' => '<string>',
                        'InvocationType' => 'Event|RequestResponse',
                        'TopicArn' => '<string>',
                    ],
                    'S3Action' => [
                        'BucketName' => '<string>',
                        'IamRoleArn' => '<string>',
                        'KmsKeyArn' => '<string>',
                        'ObjectKeyPrefix' => '<string>',
                        'TopicArn' => '<string>',
                    ],
                    'SNSAction' => [
                        'Encoding' => 'UTF-8|Base64',
                        'TopicArn' => '<string>',
                    ],
                    'StopAction' => [
                        'Scope' => 'RuleSet',
                        'TopicArn' => '<string>',
                    ],
                    'WorkmailAction' => [
                        'OrganizationArn' => '<string>',
                        'TopicArn' => '<string>',
                    ],
                ],
                // ...
            ],
            'Enabled' => true || false,
            'Name' => '<string>',
            'Recipients' => ['<string>', ...],
            'ScanEnabled' => true || false,
            'TlsPolicy' => 'Require|Optional',
        ],
        // ...
    ],
]

Result Details

Members
Metadata
Type: ReceiptRuleSetMetadata structure

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

Rules
Type: Array of ReceiptRule structures

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

Errors

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

Examples

Example 1: DescribeReceiptRuleSet

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

$result = $client->describeReceiptRuleSet([
    'RuleSetName' => 'MyRuleSet',
]);

Result syntax:

[
    'Metadata' => [
        'CreatedTimestamp' => ,
        'Name' => 'MyRuleSet',
    ],
    'Rules' => [
        [
            'Actions' => [
                [
                    'S3Action' => [
                        'BucketName' => 'MyBucket',
                        'ObjectKeyPrefix' => 'email',
                    ],
                ],
            ],
            'Enabled' => 1,
            'Name' => 'MyRule',
            'ScanEnabled' => 1,
            'TlsPolicy' => 'Optional',
        ],
    ],
]

GetAccountSendingEnabled

$result = $client->getAccountSendingEnabled([/* ... */]);
$promise = $client->getAccountSendingEnabledAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAccountSendingEnabled([
]);

Parameter Details

Members

Result Syntax

[
    'Enabled' => true || false,
]

Result Details

Members
Enabled
Type: boolean

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

Errors

There are no errors described for this operation.

Examples

Example 1: GetAccountSendingEnabled

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

$result = $client->getAccountSendingEnabled([
]);

Result syntax:

[
    'Enabled' => 1,
]

GetCustomVerificationEmailTemplate

$result = $client->getCustomVerificationEmailTemplate([/* ... */]);
$promise = $client->getCustomVerificationEmailTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getCustomVerificationEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
TemplateName
Required: Yes
Type: string

The name of the custom verification email template to retrieve.

Result Syntax

[
    'FailureRedirectionURL' => '<string>',
    'FromEmailAddress' => '<string>',
    'SuccessRedirectionURL' => '<string>',
    'TemplateContent' => '<string>',
    'TemplateName' => '<string>',
    'TemplateSubject' => '<string>',
]

Result Details

Members
FailureRedirectionURL
Type: string

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

FromEmailAddress
Type: string

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

SuccessRedirectionURL
Type: string

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

TemplateContent
Type: string

The content of the custom verification email.

TemplateName
Type: string

The name of the custom verification email template.

TemplateSubject
Type: string

The subject line of the custom verification email.

Errors

CustomVerificationEmailTemplateDoesNotExistException:

Indicates that a custom verification email template with the name you specified does not exist.

GetIdentityDkimAttributes

$result = $client->getIdentityDkimAttributes([/* ... */]);
$promise = $client->getIdentityDkimAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getIdentityDkimAttributes([
    'Identities' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Identities
Required: Yes
Type: Array of strings

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

Result Syntax

[
    'DkimAttributes' => [
        '<Identity>' => [
            'DkimEnabled' => true || false,
            'DkimTokens' => ['<string>', ...],
            'DkimVerificationStatus' => 'Pending|Success|Failed|TemporaryFailure|NotStarted',
        ],
        // ...
    ],
]

Result Details

Members
DkimAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityDkimAttributes structures

The DKIM attributes for an email address or a domain.

Errors

There are no errors described for this operation.

Examples

Example 1: GetIdentityDkimAttributes

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

$result = $client->getIdentityDkimAttributes([
    'Identities' => [
        'example.com',
        'user@example.com',
    ],
]);

Result syntax:

[
    'DkimAttributes' => [
        'example.com' => [
            'DkimEnabled' => 1,
            'DkimTokens' => [
                'EXAMPLEjcs5xoyqytjsotsijas7236gr',
                'EXAMPLEjr76cvoc6mysspnioorxsn6ep',
                'EXAMPLEkbmkqkhlm2lyz77ppkulerm4k',
            ],
            'DkimVerificationStatus' => 'Success',
        ],
        'user@example.com' => [
            'DkimEnabled' => ,
            'DkimVerificationStatus' => 'NotStarted',
        ],
    ],
]

GetIdentityMailFromDomainAttributes

$result = $client->getIdentityMailFromDomainAttributes([/* ... */]);
$promise = $client->getIdentityMailFromDomainAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getIdentityMailFromDomainAttributes([
    'Identities' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Identities
Required: Yes
Type: Array of strings

A list of one or more identities.

Result Syntax

[
    'MailFromDomainAttributes' => [
        '<Identity>' => [
            'BehaviorOnMXFailure' => 'UseDefaultValue|RejectMessage',
            'MailFromDomain' => '<string>',
            'MailFromDomainStatus' => 'Pending|Success|Failed|TemporaryFailure',
        ],
        // ...
    ],
]

Result Details

Members
MailFromDomainAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityMailFromDomainAttributes structures

A map of identities to custom MAIL FROM attributes.

Errors

There are no errors described for this operation.

Examples

Example 1: GetIdentityMailFromDomainAttributes

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

$result = $client->getIdentityMailFromDomainAttributes([
    'Identities' => [
        'example.com',
    ],
]);

Result syntax:

[
    'MailFromDomainAttributes' => [
        'example.com' => [
            'BehaviorOnMXFailure' => 'UseDefaultValue',
            'MailFromDomain' => 'bounces.example.com',
            'MailFromDomainStatus' => 'Success',
        ],
    ],
]

GetIdentityNotificationAttributes

$result = $client->getIdentityNotificationAttributes([/* ... */]);
$promise = $client->getIdentityNotificationAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getIdentityNotificationAttributes([
    'Identities' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Identities
Required: Yes
Type: Array of strings

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.

Result Syntax

[
    'NotificationAttributes' => [
        '<Identity>' => [
            'BounceTopic' => '<string>',
            'ComplaintTopic' => '<string>',
            'DeliveryTopic' => '<string>',
            'ForwardingEnabled' => true || false,
            'HeadersInBounceNotificationsEnabled' => true || false,
            'HeadersInComplaintNotificationsEnabled' => true || false,
            'HeadersInDeliveryNotificationsEnabled' => true || false,
        ],
        // ...
    ],
]

Result Details

Members
NotificationAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityNotificationAttributes structures

A map of Identity to IdentityNotificationAttributes.

Errors

There are no errors described for this operation.

Examples

Example 1: GetIdentityNotificationAttributes

The following example returns the notification attributes for an identity:

$result = $client->getIdentityNotificationAttributes([
    'Identities' => [
        'example.com',
    ],
]);

Result syntax:

[
    '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' => 1,
            'HeadersInBounceNotificationsEnabled' => ,
            'HeadersInComplaintNotificationsEnabled' => ,
            'HeadersInDeliveryNotificationsEnabled' => ,
        ],
    ],
]

GetIdentityPolicies

$result = $client->getIdentityPolicies([/* ... */]);
$promise = $client->getIdentityPoliciesAsync([/* ... */]);

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.

This operation is for the identity owner only. If you have not verified the identity, it returns 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.

Parameter Syntax

$result = $client->getIdentityPolicies([
    'Identity' => '<string>', // REQUIRED
    'PolicyNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Identity
Required: Yes
Type: string

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

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

PolicyNames
Required: Yes
Type: Array of strings

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.

Result Syntax

[
    'Policies' => ['<string>', ...],
]

Result Details

Members
Policies
Required: Yes
Type: Associative array of custom strings keys (PolicyName) to strings

A map of policy names to policies.

Errors

There are no errors described for this operation.

Examples

Example 1: GetIdentityPolicies

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

$result = $client->getIdentityPolicies([
    'Identity' => 'example.com',
    'PolicyNames' => [
        'MyPolicy',
    ],
]);

Result syntax:

[
    '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"}]}',
    ],
]

GetIdentityVerificationAttributes

$result = $client->getIdentityVerificationAttributes([/* ... */]);
$promise = $client->getIdentityVerificationAttributesAsync([/* ... */]);

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

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

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

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

Parameter Syntax

$result = $client->getIdentityVerificationAttributes([
    'Identities' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Identities
Required: Yes
Type: Array of strings

A list of identities.

Result Syntax

[
    'VerificationAttributes' => [
        '<Identity>' => [
            'VerificationStatus' => 'Pending|Success|Failed|TemporaryFailure|NotStarted',
            'VerificationToken' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
VerificationAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityVerificationAttributes structures

A map of Identities to IdentityVerificationAttributes objects.

Errors

There are no errors described for this operation.

Examples

Example 1: GetIdentityVerificationAttributes

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

$result = $client->getIdentityVerificationAttributes([
    'Identities' => [
        'example.com',
    ],
]);

Result syntax:

[
    'VerificationAttributes' => [
        'example.com' => [
            'VerificationStatus' => 'Success',
            'VerificationToken' => 'EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY=',
        ],
    ],
]

GetSendQuota

$result = $client->getSendQuota([/* ... */]);
$promise = $client->getSendQuotaAsync([/* ... */]);

Provides the sending limits for the Amazon SES account.

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

Parameter Syntax

$result = $client->getSendQuota([
]);

Parameter Details

Members

Result Syntax

[
    'Max24HourSend' => <float>,
    'MaxSendRate' => <float>,
    'SentLast24Hours' => <float>,
]

Result Details

Members
Max24HourSend
Type: double

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
Type: double

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

The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.

SentLast24Hours
Type: double

The number of emails sent during the previous 24 hours.

Errors

There are no errors described for this operation.

Examples

Example 1: GetSendQuota

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

$result = $client->getSendQuota([
]);

Result syntax:

[
    'Max24HourSend' => 200,
    'MaxSendRate' => 1,
    'SentLast24Hours' => 1,
]

GetSendStatistics

$result = $client->getSendStatistics([/* ... */]);
$promise = $client->getSendStatisticsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->getSendStatistics([
]);

Parameter Details

Members

Result Syntax

[
    'SendDataPoints' => [
        [
            'Bounces' => <integer>,
            'Complaints' => <integer>,
            'DeliveryAttempts' => <integer>,
            'Rejects' => <integer>,
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
SendDataPoints
Type: Array of SendDataPoint structures

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

Errors

There are no errors described for this operation.

Examples

Example 1: GetSendStatistics

The following example returns Amazon SES sending statistics:

$result = $client->getSendStatistics([
]);

Result syntax:

[
    'SendDataPoints' => [
        [
            'Bounces' => 0,
            'Complaints' => 0,
            'DeliveryAttempts' => 5,
            'Rejects' => 0,
            'Timestamp' => ,
        ],
        [
            'Bounces' => 0,
            'Complaints' => 0,
            'DeliveryAttempts' => 3,
            'Rejects' => 0,
            'Timestamp' => ,
        ],
        [
            'Bounces' => 0,
            'Complaints' => 0,
            'DeliveryAttempts' => 1,
            'Rejects' => 0,
            'Timestamp' => ,
        ],
    ],
]

GetTemplate

$result = $client->getTemplate([/* ... */]);
$promise = $client->getTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
TemplateName
Required: Yes
Type: string

The name of the template to retrieve.

Result Syntax

[
    'Template' => [
        'HtmlPart' => '<string>',
        'SubjectPart' => '<string>',
        'TemplateName' => '<string>',
        'TextPart' => '<string>',
    ],
]

Result Details

Members
Template
Type: Template structure

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

Errors

TemplateDoesNotExistException:

Indicates that the Template object you specified does not exist in your Amazon SES account.

ListConfigurationSets

$result = $client->listConfigurationSets([/* ... */]);
$promise = $client->listConfigurationSetsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listConfigurationSets([
    'MaxItems' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxItems
Type: int

The number of configuration sets to return.

NextToken
Type: string

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

Result Syntax

[
    'ConfigurationSets' => [
        [
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConfigurationSets
Type: Array of ConfigurationSet structures

A list of configuration sets.

NextToken
Type: string

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

Errors

There are no errors described for this operation.

ListCustomVerificationEmailTemplates

$result = $client->listCustomVerificationEmailTemplates([/* ... */]);
$promise = $client->listCustomVerificationEmailTemplatesAsync([/* ... */]);

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.

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

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

Parameter Syntax

$result = $client->listCustomVerificationEmailTemplates([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'CustomVerificationEmailTemplates' => [
        [
            'FailureRedirectionURL' => '<string>',
            'FromEmailAddress' => '<string>',
            'SuccessRedirectionURL' => '<string>',
            'TemplateName' => '<string>',
            'TemplateSubject' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CustomVerificationEmailTemplates
Type: Array of CustomVerificationEmailTemplate structures

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

NextToken
Type: 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.

Errors

There are no errors described for this operation.

ListIdentities

$result = $client->listIdentities([/* ... */]);
$promise = $client->listIdentitiesAsync([/* ... */]);

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

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

It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the original call and received a NextToken in the response, you should continue providing the IdentityType=Domain parameter for further NextToken calls; however, if you didn't provide the IdentityType parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.

Parameter Syntax

$result = $client->listIdentities([
    'IdentityType' => 'EmailAddress|Domain',
    'MaxItems' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
IdentityType
Type: string

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

MaxItems
Type: int

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

NextToken
Type: string

The token to use for pagination.

Result Syntax

[
    'Identities' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
Identities
Required: Yes
Type: Array of strings

A list of identities.

NextToken
Type: string

The token used for pagination.

Errors

There are no errors described for this operation.

Examples

Example 1: ListIdentities

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

$result = $client->listIdentities([
    'IdentityType' => 'EmailAddress',
    'MaxItems' => 123,
    'NextToken' => '',
]);

Result syntax:

[
    'Identities' => [
        'user@example.com',
    ],
    'NextToken' => '',
]

ListIdentityPolicies

$result = $client->listIdentityPolicies([/* ... */]);
$promise = $client->listIdentityPoliciesAsync([/* ... */]);

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This operation returns only a list. To get the actual policy content, use GetIdentityPolicies.

This operation is for the identity owner only. If you have not verified the identity, it returns 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.

Parameter Syntax

$result = $client->listIdentityPolicies([
    'Identity' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identity
Required: Yes
Type: string

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

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

Result Syntax

[
    'PolicyNames' => ['<string>', ...],
]

Result Details

Members
PolicyNames
Required: Yes
Type: Array of strings

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

Errors

There are no errors described for this operation.

Examples

Example 1: ListIdentityPolicies

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

$result = $client->listIdentityPolicies([
    'Identity' => 'example.com',
]);

Result syntax:

[
    'PolicyNames' => [
        'MyPolicy',
    ],
]

ListReceiptFilters

$result = $client->listReceiptFilters([/* ... */]);
$promise = $client->listReceiptFiltersAsync([/* ... */]);

Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.

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

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

Parameter Syntax

$result = $client->listReceiptFilters([
]);

Parameter Details

Members

Result Syntax

[
    'Filters' => [
        [
            'IpFilter' => [
                'Cidr' => '<string>',
                'Policy' => 'Block|Allow',
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Filters
Type: Array of ReceiptFilter structures

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.

Errors

There are no errors described for this operation.

Examples

Example 1: ListReceiptFilters

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

$result = $client->listReceiptFilters([
]);

Result syntax:

[
    'Filters' => [
        [
            'IpFilter' => [
                'Cidr' => '1.2.3.4/24',
                'Policy' => 'Block',
            ],
            'Name' => 'MyFilter',
        ],
    ],
]

ListReceiptRuleSets

$result = $client->listReceiptRuleSets([/* ... */]);
$promise = $client->listReceiptRuleSetsAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->listReceiptRuleSets([
    'NextToken' => '<string>',
]);

Parameter Details

Members
NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'RuleSets' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: 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.

RuleSets
Type: Array of ReceiptRuleSetMetadata structures

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.

Errors

There are no errors described for this operation.

Examples

Example 1: ListReceiptRuleSets

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

$result = $client->listReceiptRuleSets([
    'NextToken' => '',
]);

Result syntax:

[
    'NextToken' => '',
    'RuleSets' => [
        [
            'CreatedTimestamp' => ,
            'Name' => 'MyRuleSet',
        ],
    ],
]

ListTemplates

$result = $client->listTemplates([/* ... */]);
$promise = $client->listTemplatesAsync([/* ... */]);

Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.

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

Parameter Syntax

$result = $client->listTemplates([
    'MaxItems' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxItems
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'TemplatesMetadata' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: 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 set of email templates within your page size.

TemplatesMetadata
Type: Array of TemplateMetadata structures

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

Errors

There are no errors described for this operation.

ListVerifiedEmailAddresses

$result = $client->listVerifiedEmailAddresses([/* ... */]);
$promise = $client->listVerifiedEmailAddressesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listVerifiedEmailAddresses([
]);

Parameter Details

Members

Result Syntax

[
    'VerifiedEmailAddresses' => ['<string>', ...],
]

Result Details

Members
VerifiedEmailAddresses
Type: Array of strings

A list of email addresses that have been verified.

Errors

There are no errors described for this operation.

Examples

Example 1: ListVerifiedEmailAddresses

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

$result = $client->listVerifiedEmailAddresses([
]);

Result syntax:

[
    'VerifiedEmailAddresses' => [
        'user1@example.com',
        'user2@example.com',
    ],
]

PutConfigurationSetDeliveryOptions

$result = $client->putConfigurationSetDeliveryOptions([/* ... */]);
$promise = $client->putConfigurationSetDeliveryOptionsAsync([/* ... */]);

Adds or updates the delivery options for a configuration set.

Parameter Syntax

$result = $client->putConfigurationSetDeliveryOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'DeliveryOptions' => [
        'TlsPolicy' => 'Require|Optional',
    ],
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

The name of the configuration set.

DeliveryOptions
Type: DeliveryOptions structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

InvalidDeliveryOptionsException:

Indicates that provided delivery option is invalid.

PutIdentityPolicy

$result = $client->putIdentityPolicy([/* ... */]);
$promise = $client->putIdentityPolicyAsync([/* ... */]);

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

This operation is for the identity owner only. If you have not verified the identity, it returns 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.

Parameter Syntax

$result = $client->putIdentityPolicy([
    'Identity' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identity
Required: Yes
Type: string

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

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

Policy
Required: Yes
Type: 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.

PolicyName
Required: Yes
Type: string

The name of the policy.

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidPolicyException:

Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

Examples

Example 1: PutIdentityPolicy

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

$result = $client->putIdentityPolicy([
    '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',
]);

ReorderReceiptRuleSet

$result = $client->reorderReceiptRuleSet([/* ... */]);
$promise = $client->reorderReceiptRuleSetAsync([/* ... */]);

Reorders the receipt rules within a receipt rule set.

All of the rules in the rule set must be represented in this request. That is, it is error if the reorder request doesn't explicitly position all of the rules.

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

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

Parameter Syntax

$result = $client->reorderReceiptRuleSet([
    'RuleNames' => ['<string>', ...], // REQUIRED
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
RuleNames
Required: Yes
Type: Array of strings

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

RuleSetName
Required: Yes
Type: string

The name of the receipt rule set to reorder.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

RuleDoesNotExistException:

Indicates that the provided receipt rule does not exist.

Examples

Example 1: ReorderReceiptRuleSet

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

$result = $client->reorderReceiptRuleSet([
    'RuleNames' => [
        'MyRule',
        'MyOtherRule',
    ],
    'RuleSetName' => 'MyRuleSet',
]);

SendBounce

$result = $client->sendBounce([/* ... */]);
$promise = $client->sendBounceAsync([/* ... */]);

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours after you receive it.

You cannot use this operation 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.

Parameter Syntax

$result = $client->sendBounce([
    'BounceSender' => '<string>', // REQUIRED
    'BounceSenderArn' => '<string>',
    'BouncedRecipientInfoList' => [ // REQUIRED
        [
            'BounceType' => 'DoesNotExist|MessageTooLarge|ExceededQuota|ContentRejected|Undefined|TemporaryFailure',
            'Recipient' => '<string>', // REQUIRED
            'RecipientArn' => '<string>',
            'RecipientDsnFields' => [
                'Action' => 'failed|delayed|delivered|relayed|expanded', // REQUIRED
                'DiagnosticCode' => '<string>',
                'ExtensionFields' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'FinalRecipient' => '<string>',
                'LastAttemptDate' => <integer || string || DateTime>,
                'RemoteMta' => '<string>',
                'Status' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Explanation' => '<string>',
    'MessageDsn' => [
        'ArrivalDate' => <integer || string || DateTime>,
        'ExtensionFields' => [
            [
                'Name' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ReportingMta' => '<string>', // REQUIRED
    ],
    'OriginalMessageId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BounceSender
Required: Yes
Type: 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.

BounceSenderArn
Type: 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.

BouncedRecipientInfoList
Required: Yes
Type: Array of BouncedRecipientInfo structures

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.

Explanation
Type: string

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

MessageDsn
Type: MessageDsn structure

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

OriginalMessageId
Required: Yes
Type: string

The message ID of the message to be bounced.

Result Syntax

[
    'MessageId' => '<string>',
]

Result Details

Members
MessageId
Type: string

The message ID of the bounce message.

Errors

MessageRejected:

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

SendBulkTemplatedEmail

$result = $client->sendBulkTemplatedEmail([/* ... */]);
$promise = $client->sendBulkTemplatedEmailAsync([/* ... */]);

Composes an email message to multiple destinations. The message body is created using an email template.

To send email using this operation, your call must meet the following requirements:

  • The call must refer to an existing email template. You can create email templates using CreateTemplate.

  • The message must be sent from a verified email address or domain.

  • If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

  • The maximum message size is 10 MB.

  • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.

  • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group.

  • The number of destinations you can contact in a single call can be limited by your account's maximum sending rate.

Parameter Syntax

$result = $client->sendBulkTemplatedEmail([
    'ConfigurationSetName' => '<string>',
    'DefaultTags' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DefaultTemplateData' => '<string>', // REQUIRED
    'Destinations' => [ // REQUIRED
        [
            'Destination' => [ // REQUIRED
                'BccAddresses' => ['<string>', ...],
                'CcAddresses' => ['<string>', ...],
                'ToAddresses' => ['<string>', ...],
            ],
            'ReplacementTags' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'ReplacementTemplateData' => '<string>',
        ],
        // ...
    ],
    'ReplyToAddresses' => ['<string>', ...],
    'ReturnPath' => '<string>',
    'ReturnPathArn' => '<string>',
    'Source' => '<string>', // REQUIRED
    'SourceArn' => '<string>',
    'Template' => '<string>', // REQUIRED
    'TemplateArn' => '<string>',
]);

Parameter Details

Members
ConfigurationSetName
Type: string

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

DefaultTags
Type: Array of MessageTag structures

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

DefaultTemplateData
Required: Yes
Type: string

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

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

Destinations
Required: Yes
Type: Array of BulkEmailDestination structures

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

ReplyToAddresses
Type: Array of strings

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

ReturnPath
Type: string

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

ReturnPathArn
Type: 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.

Source
Required: Yes
Type: string

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

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

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

SourceArn
Type: 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.

Template
Required: Yes
Type: string

The template to use when sending this email.

TemplateArn
Type: string

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

Result Syntax

[
    'Status' => [
        [
            'Error' => '<string>',
            'MessageId' => '<string>',
            'Status' => 'Success|MessageRejected|MailFromDomainNotVerified|ConfigurationSetDoesNotExist|TemplateDoesNotExist|AccountSuspended|AccountThrottled|AccountDailyQuotaExceeded|InvalidSendingPoolName|AccountSendingPaused|ConfigurationSetSendingPaused|InvalidParameterValue|TransientFailure|Failed',
        ],
        // ...
    ],
]

Result Details

Members
Status
Required: Yes
Type: Array of BulkEmailDestinationStatus structures

One object per intended recipient. Check each response object and retry any messages with a failure status. (Note that order of responses will be respective to order of destinations in the request.)Receipt rules enable you to specify which actions

Errors

MessageRejected:

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

MailFromDomainNotVerifiedException:

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

TemplateDoesNotExistException:

Indicates that the Template object you specified does not exist in your Amazon SES account.

ConfigurationSetSendingPausedException:

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

AccountSendingPausedException:

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

SendCustomVerificationEmail

$result = $client->sendCustomVerificationEmail([/* ... */]);
$promise = $client->sendCustomVerificationEmailAsync([/* ... */]);

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->sendCustomVerificationEmail([
    'ConfigurationSetName' => '<string>',
    'EmailAddress' => '<string>', // REQUIRED
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationSetName
Type: string

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

EmailAddress
Required: Yes
Type: string

The email address to verify.

TemplateName
Required: Yes
Type: string

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

Result Syntax

[
    'MessageId' => '<string>',
]

Result Details

Members
MessageId
Type: string

The unique message identifier returned from the SendCustomVerificationEmail operation.

Errors

MessageRejected:

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

CustomVerificationEmailTemplateDoesNotExistException:

Indicates that a custom verification email template with the name you specified does not exist.

FromEmailAddressNotVerifiedException:

Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.

ProductionAccessNotGrantedException:

Indicates that the account has not been granted production access.

SendEmail

$result = $client->sendEmail([/* ... */]);
$promise = $client->sendEmailAsync([/* ... */]);

Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:

  • The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an "Email address not verified" error.

  • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

  • The maximum message size is 10 MB.

  • The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.

  • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group.

For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

Parameter Syntax

$result = $client->sendEmail([
    'ConfigurationSetName' => '<string>',
    'Destination' => [ // REQUIRED
        'BccAddresses' => ['<string>', ...],
        'CcAddresses' => ['<string>', ...],
        'ToAddresses' => ['<string>', ...],
    ],
    'Message' => [ // REQUIRED
        'Body' => [ // REQUIRED
            'Html' => [
                'Charset' => '<string>',
                'Data' => '<string>', // REQUIRED
            ],
            'Text' => [
                'Charset' => '<string>',
                'Data' => '<string>', // REQUIRED
            ],
        ],
        'Subject' => [ // REQUIRED
            'Charset' => '<string>',
            'Data' => '<string>', // REQUIRED
        ],
    ],
    'ReplyToAddresses' => ['<string>', ...],
    'ReturnPath' => '<string>',
    'ReturnPathArn' => '<string>',
    'Source' => '<string>', // REQUIRED
    'SourceArn' => '<string>',
    'Tags' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigurationSetName
Type: string

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

Destination
Required: Yes
Type: Destination structure

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

Message
Required: Yes
Type: Message structure

The message to be sent.

ReplyToAddresses
Type: Array of strings

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

ReturnPath
Type: string

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

ReturnPathArn
Type: 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.

Source
Required: Yes
Type: string

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

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

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

SourceArn
Type: 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.

Tags
Type: Array of MessageTag structures

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.

Result Syntax

[
    'MessageId' => '<string>',
]

Result Details

Members
MessageId
Required: Yes
Type: string

The unique message identifier returned from the SendEmail action.

Errors

MessageRejected:

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

MailFromDomainNotVerifiedException:

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

ConfigurationSetSendingPausedException:

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

AccountSendingPausedException:

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

Examples

Example 1: SendEmail

The following example sends a formatted email:

$result = $client->sendEmail([
    '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: Amazon SES Developer Guide.',
            ],
            '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' => '',
]);

Result syntax:

[
    'MessageId' => 'EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000',
]

SendRawEmail

$result = $client->sendRawEmail([/* ... */]);
$promise = $client->sendRawEmailAsync([/* ... */]);

Composes an email message and immediately queues it for sending.

This operation is more flexible than the SendEmail operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.

The SendRawEmail operation has the following requirements:

  • You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.

  • If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.

  • The maximum message size, including attachments, is 10 MB.

  • Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.

  • If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[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 automatically applies its own Message-ID and Date headers; if you passed these headers when creating the message, they are overwritten by the values that Amazon SES provides.

  • If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn, or you can include the following X-headers in the header of your raw email:

    • X-SES-SOURCE-ARN

    • X-SES-FROM-ARN

    • X-SES-RETURN-PATH-ARN

    Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.

    If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.

    For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.

  • For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

Parameter Syntax

$result = $client->sendRawEmail([
    'ConfigurationSetName' => '<string>',
    'Destinations' => ['<string>', ...],
    'FromArn' => '<string>',
    'RawMessage' => [ // REQUIRED
        'Data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    ],
    'ReturnPathArn' => '<string>',
    'Source' => '<string>',
    'SourceArn' => '<string>',
    'Tags' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigurationSetName
Type: string

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

Destinations
Type: Array of strings

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

FromArn
Type: 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.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

RawMessage
Required: Yes
Type: RawMessage structure

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.

This value will be base64 encoded on your behalf.
ReturnPathArn
Type: 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.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

Source
Type: string

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

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

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

SourceArn
Type: 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.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

Tags
Type: Array of MessageTag structures

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.

Result Syntax

[
    'MessageId' => '<string>',
]

Result Details

Members
MessageId
Required: Yes
Type: string

The unique message identifier returned from the SendRawEmail action.

Errors

MessageRejected:

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

MailFromDomainNotVerifiedException:

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

ConfigurationSetSendingPausedException:

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

AccountSendingPausedException:

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

Examples

Example 1: SendRawEmail

The following example sends an email with an attachment:

$result = $client->sendRawEmail([
    'Destinations' => [
    ],
    'FromArn' => '',
    'RawMessage' => [
        'Data' => <BLOB>,
    ],
    'ReturnPathArn' => '',
    'Source' => '',
    'SourceArn' => '',
]);

Result syntax:

[
    'MessageId' => 'EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000',
]

SendTemplatedEmail

$result = $client->sendTemplatedEmail([/* ... */]);
$promise = $client->sendTemplatedEmailAsync([/* ... */]);

Composes an email message using an email template and immediately queues it for sending.

To send email using this operation, your call must meet the following requirements:

  • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

  • The message must be sent from a verified email address or domain.

  • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

  • The maximum message size is 10 MB.

  • Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients that receives the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.

  • The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.

If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.

For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.

Parameter Syntax

$result = $client->sendTemplatedEmail([
    'ConfigurationSetName' => '<string>',
    'Destination' => [ // REQUIRED
        'BccAddresses' => ['<string>', ...],
        'CcAddresses' => ['<string>', ...],
        'ToAddresses' => ['<string>', ...],
    ],
    'ReplyToAddresses' => ['<string>', ...],
    'ReturnPath' => '<string>',
    'ReturnPathArn' => '<string>',
    'Source' => '<string>', // REQUIRED
    'SourceArn' => '<string>',
    'Tags' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Template' => '<string>', // REQUIRED
    'TemplateArn' => '<string>',
    'TemplateData' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationSetName
Type: string

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

Destination
Required: Yes
Type: Destination structure

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

ReplyToAddresses
Type: Array of strings

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

ReturnPath
Type: string

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

ReturnPathArn
Type: 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.

Source
Required: Yes
Type: string

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

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

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

SourceArn
Type: 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.

Tags
Type: Array of MessageTag structures

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.

Template
Required: Yes
Type: string

The template to use when sending this email.

TemplateArn
Type: string

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

TemplateData
Required: Yes
Type: 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.

Result Syntax

[
    'MessageId' => '<string>',
]

Result Details

Members
MessageId
Required: Yes
Type: string

The unique message identifier returned from the SendTemplatedEmail action.

Errors

MessageRejected:

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

MailFromDomainNotVerifiedException:

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

TemplateDoesNotExistException:

Indicates that the Template object you specified does not exist in your Amazon SES account.

ConfigurationSetSendingPausedException:

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

AccountSendingPausedException:

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

SetActiveReceiptRuleSet

$result = $client->setActiveReceiptRuleSet([/* ... */]);
$promise = $client->setActiveReceiptRuleSetAsync([/* ... */]);

Sets the specified receipt rule set as the active receipt rule set.

To disable your email-receiving through Amazon SES completely, you can call this operation 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.

Parameter Syntax

$result = $client->setActiveReceiptRuleSet([
    'RuleSetName' => '<string>',
]);

Parameter Details

Members
RuleSetName
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

Examples

Example 1: SetActiveReceiptRuleSet

The following example sets the active receipt rule set:

$result = $client->setActiveReceiptRuleSet([
    'RuleSetName' => 'RuleSetToActivate',
]);

SetIdentityDkimEnabled

$result = $client->setIdentityDkimEnabled([/* ... */]);
$promise = $client->setIdentityDkimEnabledAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->setIdentityDkimEnabled([
    'DkimEnabled' => true || false, // REQUIRED
    'Identity' => '<string>', // REQUIRED
]);

Parameter Details

Members
DkimEnabled
Required: Yes
Type: boolean

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

Identity
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: SetIdentityDkimEnabled

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

$result = $client->setIdentityDkimEnabled([
    'DkimEnabled' => 1,
    'Identity' => 'user@example.com',
]);

SetIdentityFeedbackForwardingEnabled

$result = $client->setIdentityFeedbackForwardingEnabled([/* ... */]);
$promise = $client->setIdentityFeedbackForwardingEnabledAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->setIdentityFeedbackForwardingEnabled([
    'ForwardingEnabled' => true || false, // REQUIRED
    'Identity' => '<string>', // REQUIRED
]);

Parameter Details

Members
ForwardingEnabled
Required: Yes
Type: boolean

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

Identity
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: SetIdentityFeedbackForwardingEnabled

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

$result = $client->setIdentityFeedbackForwardingEnabled([
    'ForwardingEnabled' => 1,
    'Identity' => 'user@example.com',
]);

SetIdentityHeadersInNotificationsEnabled

$result = $client->setIdentityHeadersInNotificationsEnabled([/* ... */]);
$promise = $client->setIdentityHeadersInNotificationsEnabledAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setIdentityHeadersInNotificationsEnabled([
    'Enabled' => true || false, // REQUIRED
    'Identity' => '<string>', // REQUIRED
    'NotificationType' => 'Bounce|Complaint|Delivery', // REQUIRED
]);

Parameter Details

Members
Enabled
Required: Yes
Type: boolean

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

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

Identity
Required: Yes
Type: string

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

NotificationType
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: SetIdentityHeadersInNotificationsEnabled

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

$result = $client->setIdentityHeadersInNotificationsEnabled([
    'Enabled' => 1,
    'Identity' => 'user@example.com',
    'NotificationType' => 'Bounce',
]);

SetIdentityMailFromDomain

$result = $client->setIdentityMailFromDomain([/* ... */]);
$promise = $client->setIdentityMailFromDomainAsync([/* ... */]);

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->setIdentityMailFromDomain([
    'BehaviorOnMXFailure' => 'UseDefaultValue|RejectMessage',
    'Identity' => '<string>', // REQUIRED
    'MailFromDomain' => '<string>',
]);

Parameter Details

Members
BehaviorOnMXFailure
Type: string

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

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

Identity
Required: Yes
Type: string

The verified identity.

MailFromDomain
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: SetIdentityMailFromDomain

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

$result = $client->setIdentityMailFromDomain([
    'BehaviorOnMXFailure' => 'UseDefaultValue',
    'Identity' => 'user@example.com',
    'MailFromDomain' => 'bounces.example.com',
]);

SetIdentityNotificationTopic

$result = $client->setIdentityNotificationTopic([/* ... */]);
$promise = $client->setIdentityNotificationTopicAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setIdentityNotificationTopic([
    'Identity' => '<string>', // REQUIRED
    'NotificationType' => 'Bounce|Complaint|Delivery', // REQUIRED
    'SnsTopic' => '<string>',
]);

Parameter Details

Members
Identity
Required: Yes
Type: string

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

You can only specify a verified identity for this parameter.

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

NotificationType
Required: Yes
Type: string

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

SnsTopic
Type: 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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: 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:

$result = $client->setIdentityNotificationTopic([
    'Identity' => 'user@example.com',
    'NotificationType' => 'Bounce',
    'SnsTopic' => 'arn:aws:sns:us-west-2:111122223333:MyTopic',
]);

SetReceiptRulePosition

$result = $client->setReceiptRulePosition([/* ... */]);
$promise = $client->setReceiptRulePositionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setReceiptRulePosition([
    'After' => '<string>',
    'RuleName' => '<string>', // REQUIRED
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
After
Type: string

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

RuleName
Required: Yes
Type: string

The name of the receipt rule to reposition.

RuleSetName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

RuleDoesNotExistException:

Indicates that the provided receipt rule does not exist.

Examples

Example 1: SetReceiptRulePosition

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

$result = $client->setReceiptRulePosition([
    'After' => 'PutRuleAfterThisRule',
    'RuleName' => 'RuleToReposition',
    'RuleSetName' => 'MyRuleSet',
]);

TestRenderTemplate

$result = $client->testRenderTemplate([/* ... */]);
$promise = $client->testRenderTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->testRenderTemplate([
    'TemplateData' => '<string>', // REQUIRED
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
TemplateData
Required: Yes
Type: 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.

TemplateName
Required: Yes
Type: string

The name of the template to render.

Result Syntax

[
    'RenderedTemplate' => '<string>',
]

Result Details

Members
RenderedTemplate
Type: string

The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

Errors

TemplateDoesNotExistException:

Indicates that the Template object you specified does not exist in your Amazon SES account.

InvalidRenderingParameterException:

Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.

MissingRenderingAttributeException:

Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.

UpdateAccountSendingEnabled

$result = $client->updateAccountSendingEnabled([/* ... */]);
$promise = $client->updateAccountSendingEnabledAsync([/* ... */]);

Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.

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

Parameter Syntax

$result = $client->updateAccountSendingEnabled([
    'Enabled' => true || false,
]);

Parameter Details

Members
Enabled
Type: boolean

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: UpdateAccountSendingEnabled

The following example updated the sending status for this account.

$result = $client->updateAccountSendingEnabled([
    'Enabled' => 1,
]);

UpdateConfigurationSetEventDestination

$result = $client->updateConfigurationSetEventDestination([/* ... */]);
$promise = $client->updateConfigurationSetEventDestinationAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->updateConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestination' => [ // REQUIRED
        'CloudWatchDestination' => [
            'DimensionConfigurations' => [ // REQUIRED
                [
                    'DefaultDimensionValue' => '<string>', // REQUIRED
                    'DimensionName' => '<string>', // REQUIRED
                    'DimensionValueSource' => 'messageTag|emailHeader|linkTag', // REQUIRED
                ],
                // ...
            ],
        ],
        'Enabled' => true || false,
        'KinesisFirehoseDestination' => [
            'DeliveryStreamARN' => '<string>', // REQUIRED
            'IAMRoleARN' => '<string>', // REQUIRED
        ],
        'MatchingEventTypes' => ['<string>', ...], // REQUIRED
        'Name' => '<string>', // REQUIRED
        'SNSDestination' => [
            'TopicARN' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

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

EventDestination
Required: Yes
Type: EventDestination structure

The event destination object.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

EventDestinationDoesNotExistException:

Indicates that the event destination does not exist.

InvalidCloudWatchDestinationException:

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

InvalidFirehoseDestinationException:

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

InvalidSNSDestinationException:

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.

UpdateConfigurationSetReputationMetricsEnabled

$result = $client->updateConfigurationSetReputationMetricsEnabled([/* ... */]);
$promise = $client->updateConfigurationSetReputationMetricsEnabledAsync([/* ... */]);

Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.

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

Parameter Syntax

$result = $client->updateConfigurationSetReputationMetricsEnabled([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'Enabled' => true || false, // REQUIRED
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

The name of the configuration set to update.

Enabled
Required: Yes
Type: boolean

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

Examples

Example 1: UpdateConfigurationSetReputationMetricsEnabled

Set the reputationMetricsEnabled flag for a specific configuration set.

$result = $client->updateConfigurationSetReputationMetricsEnabled([
    'ConfigurationSetName' => 'foo',
    'Enabled' => 1,
]);

UpdateConfigurationSetSendingEnabled

$result = $client->updateConfigurationSetSendingEnabled([/* ... */]);
$promise = $client->updateConfigurationSetSendingEnabledAsync([/* ... */]);

Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.

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

Parameter Syntax

$result = $client->updateConfigurationSetSendingEnabled([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'Enabled' => true || false, // REQUIRED
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

The name of the configuration set to update.

Enabled
Required: Yes
Type: boolean

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

Examples

Example 1: UpdateConfigurationSetReputationMetricsEnabled

Set the sending enabled flag for a specific configuration set.

$result = $client->updateConfigurationSetSendingEnabled([
    'ConfigurationSetName' => 'foo',
    'Enabled' => 1,
]);

UpdateConfigurationSetTrackingOptions

$result = $client->updateConfigurationSetTrackingOptions([/* ... */]);
$promise = $client->updateConfigurationSetTrackingOptionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateConfigurationSetTrackingOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'TrackingOptions' => [ // REQUIRED
        'CustomRedirectDomain' => '<string>',
    ],
]);

Parameter Details

Members
ConfigurationSetName
Required: Yes
Type: string

The name of the configuration set.

TrackingOptions
Required: Yes
Type: TrackingOptions structure

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConfigurationSetDoesNotExistException:

Indicates that the configuration set does not exist.

TrackingOptionsDoesNotExistException:

Indicates that the TrackingOptions object you specified does not exist.

InvalidTrackingOptionsException:

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:

  • When the tracking domain you specified is not verified in Amazon SES.

  • When the tracking domain you specified is not a valid domain or subdomain.

UpdateCustomVerificationEmailTemplate

$result = $client->updateCustomVerificationEmailTemplate([/* ... */]);
$promise = $client->updateCustomVerificationEmailTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateCustomVerificationEmailTemplate([
    'FailureRedirectionURL' => '<string>',
    'FromEmailAddress' => '<string>',
    'SuccessRedirectionURL' => '<string>',
    'TemplateContent' => '<string>',
    'TemplateName' => '<string>', // REQUIRED
    'TemplateSubject' => '<string>',
]);

Parameter Details

Members
FailureRedirectionURL
Type: string

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

FromEmailAddress
Type: string

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

SuccessRedirectionURL
Type: string

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

TemplateContent
Type: 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.

TemplateName
Required: Yes
Type: string

The name of the custom verification email template to update.

TemplateSubject
Type: string

The subject line of the custom verification email.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CustomVerificationEmailTemplateDoesNotExistException:

Indicates that a custom verification email template with the name you specified does not exist.

FromEmailAddressNotVerifiedException:

Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.

CustomVerificationEmailInvalidContentException:

Indicates that custom verification email template provided content is invalid.

UpdateReceiptRule

$result = $client->updateReceiptRule([/* ... */]);
$promise = $client->updateReceiptRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateReceiptRule([
    'Rule' => [ // REQUIRED
        'Actions' => [
            [
                'AddHeaderAction' => [
                    'HeaderName' => '<string>', // REQUIRED
                    'HeaderValue' => '<string>', // REQUIRED
                ],
                'BounceAction' => [
                    'Message' => '<string>', // REQUIRED
                    'Sender' => '<string>', // REQUIRED
                    'SmtpReplyCode' => '<string>', // REQUIRED
                    'StatusCode' => '<string>',
                    'TopicArn' => '<string>',
                ],
                'LambdaAction' => [
                    'FunctionArn' => '<string>', // REQUIRED
                    'InvocationType' => 'Event|RequestResponse',
                    'TopicArn' => '<string>',
                ],
                'S3Action' => [
                    'BucketName' => '<string>', // REQUIRED
                    'IamRoleArn' => '<string>',
                    'KmsKeyArn' => '<string>',
                    'ObjectKeyPrefix' => '<string>',
                    'TopicArn' => '<string>',
                ],
                'SNSAction' => [
                    'Encoding' => 'UTF-8|Base64',
                    'TopicArn' => '<string>', // REQUIRED
                ],
                'StopAction' => [
                    'Scope' => 'RuleSet', // REQUIRED
                    'TopicArn' => '<string>',
                ],
                'WorkmailAction' => [
                    'OrganizationArn' => '<string>', // REQUIRED
                    'TopicArn' => '<string>',
                ],
            ],
            // ...
        ],
        'Enabled' => true || false,
        'Name' => '<string>', // REQUIRED
        'Recipients' => ['<string>', ...],
        'ScanEnabled' => true || false,
        'TlsPolicy' => 'Require|Optional',
    ],
    'RuleSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Rule
Required: Yes
Type: ReceiptRule structure

A data structure that contains the updated receipt rule information.

RuleSetName
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidSnsTopicException:

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidS3ConfigurationException:

Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

InvalidLambdaFunctionException:

Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

RuleSetDoesNotExistException:

Indicates that the provided receipt rule set does not exist.

RuleDoesNotExistException:

Indicates that the provided receipt rule does not exist.

LimitExceededException:

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

Examples

Example 1: UpdateReceiptRule

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

$result = $client->updateReceiptRule([
    'Rule' => [
        'Actions' => [
            [
                'S3Action' => [
                    'BucketName' => 'MyBucket',
                    'ObjectKeyPrefix' => 'email',
                ],
            ],
        ],
        'Enabled' => 1,
        'Name' => 'MyRule',
        'ScanEnabled' => 1,
        'TlsPolicy' => 'Optional',
    ],
    'RuleSetName' => 'MyRuleSet',
]);

UpdateTemplate

$result = $client->updateTemplate([/* ... */]);
$promise = $client->updateTemplateAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->updateTemplate([
    'Template' => [ // REQUIRED
        'HtmlPart' => '<string>',
        'SubjectPart' => '<string>',
        'TemplateName' => '<string>', // REQUIRED
        'TextPart' => '<string>',
    ],
]);

Parameter Details

Members
Template
Required: Yes
Type: Template structure

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TemplateDoesNotExistException:

Indicates that the Template object you specified does not exist in your Amazon SES account.

InvalidTemplateException:

Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.

VerifyDomainDkim

$result = $client->verifyDomainDkim([/* ... */]);
$promise = $client->verifyDomainDkimAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->verifyDomainDkim([
    'Domain' => '<string>', // REQUIRED
]);

Parameter Details

Members
Domain
Required: Yes
Type: string

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

Result Syntax

[
    'DkimTokens' => ['<string>', ...],
]

Result Details

Members
DkimTokens
Required: Yes
Type: Array of strings

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.

Errors

There are no errors described for this operation.

Examples

Example 1: VerifyDomainDkim

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

$result = $client->verifyDomainDkim([
    'Domain' => 'example.com',
]);

Result syntax:

[
    'DkimTokens' => [
        'EXAMPLEq76owjnks3lnluwg65scbemvw',
        'EXAMPLEi3dnsj67hstzaj673klariwx2',
        'EXAMPLEwfbtcukvimehexktmdtaz6naj',
    ],
]

VerifyDomainIdentity

$result = $client->verifyDomainIdentity([/* ... */]);
$promise = $client->verifyDomainIdentityAsync([/* ... */]);

Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->verifyDomainIdentity([
    'Domain' => '<string>', // REQUIRED
]);

Parameter Details

Members
Domain
Required: Yes
Type: string

The domain to be verified.

Result Syntax

[
    'VerificationToken' => '<string>',
]

Result Details

Members
VerificationToken
Required: Yes
Type: 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, to verify the domain, you must restart the verification process from the beginning. The domain's verification status also changes to "Success" when it is DKIM verified.

Errors

There are no errors described for this operation.

Examples

Example 1: VerifyDomainIdentity

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

$result = $client->verifyDomainIdentity([
    'Domain' => 'example.com',
]);

Result syntax:

[
    'VerificationToken' => 'eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE',
]

VerifyEmailAddress

$result = $client->verifyEmailAddress([/* ... */]);
$promise = $client->verifyEmailAddressAsync([/* ... */]);

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

Parameter Syntax

$result = $client->verifyEmailAddress([
    'EmailAddress' => '<string>', // REQUIRED
]);

Parameter Details

Members
EmailAddress
Required: Yes
Type: string

The email address to be verified.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: VerifyEmailAddress

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

$result = $client->verifyEmailAddress([
    'EmailAddress' => 'user@example.com',
]);

VerifyEmailIdentity

$result = $client->verifyEmailIdentity([/* ... */]);
$promise = $client->verifyEmailIdentityAsync([/* ... */]);

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.

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

Parameter Syntax

$result = $client->verifyEmailIdentity([
    'EmailAddress' => '<string>', // REQUIRED
]);

Parameter Details

Members
EmailAddress
Required: Yes
Type: string

The email address to be verified.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: VerifyEmailIdentity

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

$result = $client->verifyEmailIdentity([
    'EmailAddress' => 'user@example.com',
]);

Shapes

AccountSendingPausedException

Description

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

Members

AddHeaderAction

Description

When included in a receipt rule, this action adds a header to the received email.

For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.

Members
HeaderName
Required: Yes
Type: string

The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.

HeaderValue
Required: Yes
Type: string

The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.

AlreadyExistsException

Description

Indicates that a resource could not be created because of a naming conflict.

Members
Name
Type: string

Indicates that a resource could not be created because the resource name already exists.

Body

Description

Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.

Members
Html
Type: Content structure

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.

Text
Type: Content structure

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

BounceAction

Description

When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.

Members
Message
Required: Yes
Type: string

Human-readable text to include in the bounce message.

Sender
Required: Yes
Type: string

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

SmtpReplyCode
Required: Yes
Type: string

The SMTP reply code, as defined by RFC 5321.

StatusCode
Type: string

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

TopicArn
Type: string

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

BouncedRecipientInfo

Description

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Members
BounceType
Type: string

The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

Recipient
Required: Yes
Type: string

The email address of the recipient of the bounced email.

RecipientArn
Type: 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.

RecipientDsnFields
Type: RecipientDsnFields structure

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.

BulkEmailDestination

Description

An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.

Members
Destination
Required: Yes
Type: Destination structure

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

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

ReplacementTags
Type: Array of MessageTag structures

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.

ReplacementTemplateData
Type: 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.

BulkEmailDestinationStatus

Description

An object that contains the response from the SendBulkTemplatedEmail operation.

Members
Error
Type: string

A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.

MessageId
Type: string

The unique message identifier returned from the SendBulkTemplatedEmail operation.

Status
Type: string

The status of a message sent using the SendBulkTemplatedEmail operation.

Possible values for this parameter include:

  • Success: Amazon SES accepted the message, and attempts 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.

CannotDeleteException

Description

Indicates that the delete operation could not be completed.

Members
Name
Type: string

Indicates that a resource could not be deleted because no resource with the specified name exists.

CloneReceiptRuleSetResponse

Description

An empty element returned on a successful request.

Members

CloudWatchDestination

Description

Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.

Event destinations, such as Amazon CloudWatch, 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.

Members
DimensionConfigurations
Required: Yes
Type: Array of CloudWatchDimensionConfiguration structures

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

CloudWatchDimensionConfiguration

Description

Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

Members
DefaultDimensionValue
Required: Yes
Type: 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 meet the following requirements:

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

  • Contain 256 characters or fewer.

DimensionName
Required: Yes
Type: string

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements:

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

  • Contain 256 characters or fewer.

DimensionValueSource
Required: Yes
Type: string

The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.

ConfigurationSet

Description

The name of the configuration set.

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.

Members
Name
Required: Yes
Type: 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.

ConfigurationSetAlreadyExistsException

Description

Indicates that the configuration set could not be created because of a naming conflict.

Members
ConfigurationSetName
Type: string

Indicates that the configuration set does not exist.

ConfigurationSetDoesNotExistException

Description

Indicates that the configuration set does not exist.

Members
ConfigurationSetName
Type: string

Indicates that the configuration set does not exist.

ConfigurationSetSendingPausedException

Description

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

Members
ConfigurationSetName
Type: string

The name of the configuration set for which email sending is disabled.

Content

Description

Represents textual data, plus an optional character set specification.

By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.

Members
Charset
Type: string

The character set of the content.

Data
Required: Yes
Type: string

The textual data of the content.

CreateConfigurationSetEventDestinationResponse

Description

An empty element returned on a successful request.

Members

CreateConfigurationSetResponse

Description

An empty element returned on a successful request.

Members

CreateConfigurationSetTrackingOptionsResponse

Description

An empty element returned on a successful request.

Members

CreateReceiptFilterResponse

Description

An empty element returned on a successful request.

Members

CreateReceiptRuleResponse

Description

An empty element returned on a successful request.

Members

CreateReceiptRuleSetResponse

Description

An empty element returned on a successful request.

Members

CreateTemplateResponse

Members

CustomVerificationEmailInvalidContentException

Description

Indicates that custom verification email template provided content is invalid.

Members

CustomVerificationEmailTemplate

Description

Contains information about a custom verification email template.

Members
FailureRedirectionURL
Type: string

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

FromEmailAddress
Type: string

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

SuccessRedirectionURL
Type: string

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

TemplateName
Type: string

The name of the custom verification email template.

TemplateSubject
Type: string

The subject line of the custom verification email.

CustomVerificationEmailTemplateAlreadyExistsException

Description

Indicates that a custom verification email template with the name you specified already exists.

Members
CustomVerificationEmailTemplateName
Type: string

Indicates that the provided custom verification email template with the specified template name already exists.

CustomVerificationEmailTemplateDoesNotExistException

Description

Indicates that a custom verification email template with the name you specified does not exist.

Members
CustomVerificationEmailTemplateName
Type: string

Indicates that the provided custom verification email template does not exist.

DeleteConfigurationSetEventDestinationResponse

Description

An empty element returned on a successful request.

Members

DeleteConfigurationSetResponse

Description

An empty element returned on a successful request.

Members

DeleteConfigurationSetTrackingOptionsResponse

Description

An empty element returned on a successful request.

Members

DeleteIdentityPolicyResponse

Description

An empty element returned on a successful request.

Members

DeleteIdentityResponse

Description

An empty element returned on a successful request.

Members

DeleteReceiptFilterResponse

Description

An empty element returned on a successful request.

Members

DeleteReceiptRuleResponse

Description

An empty element returned on a successful request.

Members

DeleteReceiptRuleSetResponse

Description

An empty element returned on a successful request.

Members

DeleteTemplateResponse

Members

DeliveryOptions

Description

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

Members
TlsPolicy
Type: 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.

DescribeActiveReceiptRuleSetResponse

Description

Represents the metadata and receipt rules for the receipt rule set that is currently active.

Members
Metadata
Type: ReceiptRuleSetMetadata structure

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

Rules
Type: Array of ReceiptRule structures

The receipt rules that belong to the active rule set.

DescribeConfigurationSetResponse

Description

Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Members
ConfigurationSet
Type: ConfigurationSet structure

The configuration set object associated with the specified configuration set.

DeliveryOptions
Type: DeliveryOptions structure

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

EventDestinations
Type: Array of EventDestination structures

A list of event destinations associated with the configuration set.

ReputationOptions
Type: ReputationOptions structure

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

TrackingOptions
Type: TrackingOptions structure

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

DescribeReceiptRuleResponse

Description

Represents the details of a receipt rule.

Members
Rule
Type: ReceiptRule structure

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

DescribeReceiptRuleSetResponse

Description

Represents the details of the specified receipt rule set.

Members
Metadata
Type: ReceiptRuleSetMetadata structure

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

Rules
Type: Array of ReceiptRule structures

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

Destination

Description

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

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

Members
BccAddresses
Type: Array of strings

The recipients to place on the BCC: line of the message.

CcAddresses
Type: Array of strings

The recipients to place on the CC: line of the message.

ToAddresses
Type: Array of strings

The recipients to place on the To: line of the message.

EventDestination

Description

Contains information about an event destination.

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

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

Members
CloudWatchDestination
Type: CloudWatchDestination structure

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

Enabled
Type: 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.

KinesisFirehoseDestination
Type: KinesisFirehoseDestination structure

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

MatchingEventTypes
Required: Yes
Type: Array of strings

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

  • send - The call was successful and Amazon SES is attempting to deliver the email.

  • reject - Amazon SES determined that the email contained a virus and rejected it.

  • bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.

  • complaint - The recipient marked the email as spam.

  • delivery - Amazon SES successfully delivered the email to the recipient's mail server.

  • open - The recipient received the email and opened it in their email client.

  • click - The recipient clicked one or more links in the email.

  • renderingFailure - Amazon SES did not send the email because of a template rendering issue.

Name
Required: Yes
Type: string

The name of the event destination. The name must meet the following requirements:

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

  • Contain 64 characters or fewer.

SNSDestination
Type: SNSDestination structure

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

EventDestinationAlreadyExistsException

Description

Indicates that the event destination could not be created because of a naming conflict.

Members
ConfigurationSetName
Type: string

Indicates that the configuration set does not exist.

EventDestinationName
Type: string

Indicates that the event destination does not exist.

EventDestinationDoesNotExistException

Description

Indicates that the event destination does not exist.

Members
ConfigurationSetName
Type: string

Indicates that the configuration set does not exist.

EventDestinationName
Type: string

Indicates that the event destination does not exist.

ExtensionField

Description

Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Members
Name
Required: Yes
Type: 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: Yes
Type: string

The value of the header to add. Must contain 2048 characters or fewer, and must not contain newline characters ("\r" or "\n").

FromEmailAddressNotVerifiedException

Description

Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.

Members
FromEmailAddress
Type: string

Indicates that the from email address associated with the custom verification email template is not verified.

GetAccountSendingEnabledResponse

Description

Represents a request to return the email sending status for your Amazon SES account in the current Amazon Web Services Region.

Members
Enabled
Type: boolean

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

GetCustomVerificationEmailTemplateResponse

Description

The content of the custom verification email template.

Members
FailureRedirectionURL
Type: string

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

FromEmailAddress
Type: string

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

SuccessRedirectionURL
Type: string

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

TemplateContent
Type: string

The content of the custom verification email.

TemplateName
Type: string

The name of the custom verification email template.

TemplateSubject
Type: string

The subject line of the custom verification email.

GetIdentityDkimAttributesResponse

Description

Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.

Members
DkimAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityDkimAttributes structures

The DKIM attributes for an email address or a domain.

GetIdentityMailFromDomainAttributesResponse

Description

Represents the custom MAIL FROM attributes for a list of identities.

Members
MailFromDomainAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityMailFromDomainAttributes structures

A map of identities to custom MAIL FROM attributes.

GetIdentityNotificationAttributesResponse

Description

Represents the notification attributes for a list of identities.

Members
NotificationAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityNotificationAttributes structures

A map of Identity to IdentityNotificationAttributes.

GetIdentityPoliciesResponse

Description

Represents the requested sending authorization policies.

Members
Policies
Required: Yes
Type: Associative array of custom strings keys (PolicyName) to strings

A map of policy names to policies.

GetIdentityVerificationAttributesResponse

Description

The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

Members
VerificationAttributes
Required: Yes
Type: Associative array of custom strings keys (Identity) to IdentityVerificationAttributes structures

A map of Identities to IdentityVerificationAttributes objects.

GetSendQuotaResponse

Description

Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.

Members
Max24HourSend
Type: double

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
Type: double

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

The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.

SentLast24Hours
Type: double

The number of emails sent during the previous 24 hours.

GetSendStatisticsResponse

Description

Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.

Members
SendDataPoints
Type: Array of SendDataPoint structures

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

GetTemplateResponse

Members
Template
Type: Template structure

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

IdentityDkimAttributes

Description

Represents the DKIM attributes of a verified email address or a domain.

Members
DkimEnabled
Required: Yes
Type: boolean

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

DkimTokens
Type: Array of strings

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.

DkimVerificationStatus
Required: Yes
Type: 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.)

IdentityMailFromDomainAttributes

Description

Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).

Members
BehaviorOnMXFailure
Required: Yes
Type: 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.

MailFromDomain
Required: Yes
Type: string

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

MailFromDomainStatus
Required: Yes
Type: 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.

IdentityNotificationAttributes

Description

Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

Members
BounceTopic
Required: Yes
Type: string

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

ComplaintTopic
Required: Yes
Type: string

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

DeliveryTopic
Required: Yes
Type: string

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

ForwardingEnabled
Required: Yes
Type: boolean

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

HeadersInBounceNotificationsEnabled
Type: 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 includes headers in bounce notifications, and a value of false specifies that Amazon SES does not include headers in bounce notifications.

HeadersInComplaintNotificationsEnabled
Type: 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 includes headers in complaint notifications, and a value of false specifies that Amazon SES does not include headers in complaint notifications.

HeadersInDeliveryNotificationsEnabled
Type: 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 includes headers in delivery notifications, and a value of false specifies that Amazon SES does not include headers in delivery notifications.

IdentityVerificationAttributes

Description

Represents the verification attributes of a single identity.

Members
VerificationStatus
Required: Yes
Type: string

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

VerificationToken
Type: string

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

InvalidCloudWatchDestinationException

Description

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

Members
ConfigurationSetName
Type: string

Indicates that the configuration set does not exist.

EventDestinationName
Type: string

Indicates that the event destination does not exist.

InvalidConfigurationSetException

Description

Indicates that the configuration set is invalid. See the error message for details.

Members

InvalidDeliveryOptionsException

Description

Indicates that provided delivery option is invalid.

Members

InvalidFirehoseDestinationException

Description

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

Members
ConfigurationSetName
Type: string

Indicates that the configuration set does not exist.

EventDestinationName
Type: string

Indicates that the event destination does not exist.

InvalidLambdaFunctionException

Description

Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Members
FunctionArn
Type: string

Indicates that the ARN of the function was not found.

InvalidPolicyException

Description

Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

Members

InvalidRenderingParameterException

Description

Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.

Members
TemplateName
Type: string

InvalidS3ConfigurationException

Description

Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Members
Bucket
Type: string

Indicated that the S3 Bucket was not found.

InvalidSNSDestinationException

Description

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.

Members
ConfigurationSetName
Type: string

Indicates that the configuration set does not exist.

EventDestinationName
Type: string

Indicates that the event destination does not exist.

InvalidSnsTopicException

Description

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Members
Topic
Type: string

Indicates that the topic does not exist.

InvalidTemplateException

Description

Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.

Members
TemplateName
Type: string

InvalidTrackingOptionsException

Description

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:

  • When the tracking domain you specified is not verified in Amazon SES.

  • When the tracking domain you specified is not a valid domain or subdomain.

Members

KinesisFirehoseDestination

Description

Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Event destinations, such as Amazon Kinesis Firehose, 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.

Members
DeliveryStreamARN
Required: Yes
Type: string

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

IAMRoleARN
Required: Yes
Type: string

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

LambdaAction

Description

When included in a receipt rule, this action calls an Amazon Web Services Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

For information about using Amazon Web Services Lambda actions in receipt rules, see the Amazon SES Developer Guide.

Members
FunctionArn
Required: Yes
Type: string

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

InvocationType
Type: string

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

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

TopicArn
Type: string

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

LimitExceededException

Description

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

Members

ListConfigurationSetsResponse

Description

A list of configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Members
ConfigurationSets
Type: Array of ConfigurationSet structures

A list of configuration sets.

NextToken
Type: string

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

ListCustomVerificationEmailTemplatesResponse

Description

A paginated list of custom verification email templates.

Members
CustomVerificationEmailTemplates
Type: Array of CustomVerificationEmailTemplate structures

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

NextToken
Type: 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.

ListIdentitiesResponse

Description

A list of all identities that you have attempted to verify under your Amazon Web Services account, regardless of verification status.

Members
Identities
Required: Yes
Type: Array of strings

A list of identities.

NextToken
Type: string

The token used for pagination.

ListIdentityPoliciesResponse

Description

A list of names of sending authorization policies that apply to an identity.

Members
PolicyNames
Required: Yes
Type: Array of strings

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

ListReceiptFiltersResponse

Description

A list of IP address filters that exist under your Amazon Web Services account.

Members
Filters
Type: Array of ReceiptFilter structures

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.

ListReceiptRuleSetsResponse

Description

A list of receipt rule sets that exist under your Amazon Web Services account.

Members
NextToken
Type: 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.

RuleSets
Type: Array of ReceiptRuleSetMetadata structures

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.

ListTemplatesResponse

Members
NextToken
Type: 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 set of email templates within your page size.

TemplatesMetadata
Type: Array of TemplateMetadata structures

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

ListVerifiedEmailAddressesResponse

Description

A list of email addresses that you have verified with Amazon SES under your Amazon Web Services account.

Members
VerifiedEmailAddresses
Type: Array of strings

A list of email addresses that have been verified.

MailFromDomainNotVerifiedException

Description

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

Members

Message

Description

Represents the message to be sent, composed of a subject and a body.

Members
Body
Required: Yes
Type: Body structure

The message body.

Subject
Required: Yes
Type: Content structure

The subject of the message: A short summary of the content, which appears in the recipient's inbox.

MessageDsn

Description

Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Members
ArrivalDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.

ExtensionFields
Type: Array of ExtensionField structures

Additional X-headers to include in the DSN.

ReportingMta
Required: Yes
Type: 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.

MessageRejected

Description

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

Members

MessageTag

Description

Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.

Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Members
Name
Required: Yes
Type: string

The name of the tag. The name must meet the following requirements:

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

  • Contain 256 characters or fewer.

Value
Required: Yes
Type: string

The value of the tag. The value must meet the following requirements:

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

  • Contain 256 characters or fewer.

MissingRenderingAttributeException

Description

Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.

Members
TemplateName
Type: string

ProductionAccessNotGrantedException

Description

Indicates that the account has not been granted production access.

Members

PutConfigurationSetDeliveryOptionsResponse

Description

An HTTP 200 response if the request succeeds, or an error message if the request fails.

Members

PutIdentityPolicyResponse

Description

An empty element returned on a successful request.

Members

RawMessage

Description

Represents the raw data of the message.

This value will be base64 encoded on your behalf.
Members
Data
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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 Amazon Web Services 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.

ReceiptAction

Description

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

Members
AddHeaderAction
Type: AddHeaderAction structure

Adds a header to the received email.

BounceAction
Type: BounceAction structure

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

LambdaAction
Type: LambdaAction structure

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

S3Action
Type: S3Action structure

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

SNSAction
Type: SNSAction structure

Publishes the email content within a notification to Amazon SNS.

StopAction
Type: StopAction structure

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

WorkmailAction
Type: WorkmailAction structure

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

ReceiptFilter

Description

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

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

Members
IpFilter
Required: Yes
Type: ReceiptIpFilter structure

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

Name
Required: Yes
Type: string

The name of the IP address filter. The name must meet the following requirements:

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

  • Start and end with a letter or number.

  • Contain 64 characters or fewer.

ReceiptIpFilter

Description

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

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

Members
Cidr
Required: Yes
Type: string

A single IP address or a range of IP addresses 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.

Policy
Required: Yes
Type: string

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

ReceiptRule

Description

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

Members
Actions
Type: Array of ReceiptAction structures

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.

Enabled
Type: boolean

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

Name
Required: Yes
Type: string

The name of the receipt rule. The name must meet the following requirements:

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

  • Start and end with a letter or number.

  • Contain 64 characters or fewer.

Recipients
Type: Array of strings

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

ScanEnabled
Type: boolean

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

TlsPolicy
Type: 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 bounces emails that are not received over TLS. The default is Optional.

ReceiptRuleSetMetadata

Description

Information about a receipt rule set.

A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.

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

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the receipt rule set was created.

Name
Type: string

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

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

  • Start and end with a letter or number.

  • Contain 64 characters or fewer.

RecipientDsnFields

Description

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Members
Action
Required: Yes
Type: 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.

DiagnosticCode
Type: string

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

ExtensionFields
Type: Array of ExtensionField structures

Additional X-headers to include in the DSN.

FinalRecipient
Type: string

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient is 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.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

LastAttemptDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the final delivery attempt was made, in RFC 822 date-time format.

RemoteMta
Type: 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: Yes
Type: string

The status code that indicates what went wrong. This is required by RFC 3464.

ReorderReceiptRuleSetResponse

Description

An empty element returned on a successful request.

Members

ReputationOptions

Description

Contains information about the reputation settings for a configuration set.

Members
LastFreshStart
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

ReputationMetricsEnabled
Type: 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.

SendingEnabled
Type: boolean

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

RuleDoesNotExistException

Description

Indicates that the provided receipt rule does not exist.

Members
Name
Type: string

Indicates that the named receipt rule does not exist.

RuleSetDoesNotExistException

Description

Indicates that the provided receipt rule set does not exist.

Members
Name
Type: string

Indicates that the named receipt rule set does not exist.

S3Action

Description

When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about granting permissions, see the Amazon SES Developer Guide.

When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 40 MB. Emails larger than that bounces.

For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.

Members
BucketName
Required: Yes
Type: string

The name of the Amazon S3 bucket for incoming email.

IamRoleArn
Type: string

The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic. This role should have access to the following APIs:

  • s3:PutObject, kms:Encrypt and kms:GenerateDataKey for the given Amazon S3 bucket.

  • kms:GenerateDataKey for the given Amazon Web Services KMS customer managed key.

  • sns:Publish for the given Amazon SNS topic.

If an IAM role ARN is provided, the role (and only the role) is used to access all the given resources (Amazon S3 bucket, Amazon Web Services KMS customer managed key and Amazon SNS topic). Therefore, setting up individual resource access permissions is not required.

KmsKeyArn
Type: string

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

  • To use the default managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your Amazon Web Services account ID is 123456789012 and you want to use the default managed 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 managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

  • To use a custom managed key that you created in Amazon Web Services KMS, provide the ARN of the managed 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 Amazon Web Services KMS Developer Guide. If you do not specify a managed key, Amazon SES does 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 Amazon Web Services KMS keys for decryption. This encryption client is currently available with the Amazon Web Services SDK for Java and Amazon Web Services SDK for Ruby only. For more information about client-side encryption using Amazon Web Services KMS managed keys, see the Amazon S3 Developer Guide.

ObjectKeyPrefix
Type: 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.

TopicArn
Type: string

The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

SNSAction

Description

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

Members
Encoding
Type: 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.

TopicArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

SNSDestination

Description

Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Event destinations, such as Amazon SNS, 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.

Members
TopicARN
Required: Yes
Type: string

The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

SendBounceResponse

Description

Represents a unique message ID.

Members
MessageId
Type: string

The message ID of the bounce message.

SendBulkTemplatedEmailResponse

Members
Status
Required: Yes
Type: Array of BulkEmailDestinationStatus structures

One object per intended recipient. Check each response object and retry any messages with a failure status. (Note that order of responses will be respective to order of destinations in the request.)Receipt rules enable you to specify which actions

SendCustomVerificationEmailResponse

Description

The response received when attempting to send the custom verification email.

Members
MessageId
Type: string

The unique message identifier returned from the SendCustomVerificationEmail operation.

SendDataPoint

Description

Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.

Members
Bounces
Type: long (int|float)

Number of emails that have bounced.

Complaints
Type: long (int|float)

Number of unwanted emails that were rejected by recipients.

DeliveryAttempts
Type: long (int|float)

Number of emails that have been sent.

Rejects
Type: long (int|float)

Number of emails rejected by Amazon SES.

Timestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time of the data point.

SendEmailResponse

Description

Represents a unique message ID.

Members
MessageId
Required: Yes
Type: string

The unique message identifier returned from the SendEmail action.

SendRawEmailResponse

Description

Represents a unique message ID.

Members
MessageId
Required: Yes
Type: string

The unique message identifier returned from the SendRawEmail action.

SendTemplatedEmailResponse

Members
MessageId
Required: Yes
Type: string

The unique message identifier returned from the SendTemplatedEmail action.

SetActiveReceiptRuleSetResponse

Description

An empty element returned on a successful request.

Members

SetIdentityDkimEnabledResponse

Description

An empty element returned on a successful request.

Members

SetIdentityFeedbackForwardingEnabledResponse

Description

An empty element returned on a successful request.

Members

SetIdentityHeadersInNotificationsEnabledResponse

Description

An empty element returned on a successful request.

Members

SetIdentityMailFromDomainResponse

Description

An empty element returned on a successful request.

Members

SetIdentityNotificationTopicResponse

Description

An empty element returned on a successful request.

Members

SetReceiptRulePositionResponse

Description

An empty element returned on a successful request.

Members

StopAction

Description

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

Members
Scope
Required: Yes
Type: string

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

TopicArn
Type: string

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Template

Description

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

Members
HtmlPart
Type: string

The HTML body of the email.

SubjectPart
Type: string

The subject line of the email.

TemplateName
Required: Yes
Type: string

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

TextPart
Type: string

The email body that is visible to recipients whose email clients do not display HTML content.

TemplateDoesNotExistException

Description

Indicates that the Template object you specified does not exist in your Amazon SES account.

Members
TemplateName
Type: string

TemplateMetadata

Description

Contains information about an email template.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time and date the template was created.

Name
Type: string

The name of the template.

TestRenderTemplateResponse

Members
RenderedTemplate
Type: string

The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

TrackingOptions

Description

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.

Members
CustomRedirectDomain
Type: string

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

TrackingOptionsAlreadyExistsException

Description

Indicates that the configuration set you specified already contains a TrackingOptions object.

Members
ConfigurationSetName
Type: string

Indicates that a TrackingOptions object already exists in the specified configuration set.

TrackingOptionsDoesNotExistException

Description

Indicates that the TrackingOptions object you specified does not exist.

Members
ConfigurationSetName
Type: string

Indicates that a TrackingOptions object does not exist in the specified configuration set.

UpdateConfigurationSetEventDestinationResponse

Description

An empty element returned on a successful request.

Members

UpdateConfigurationSetTrackingOptionsResponse

Description

An empty element returned on a successful request.

Members

UpdateReceiptRuleResponse

Description

An empty element returned on a successful request.

Members

UpdateTemplateResponse

Members

VerifyDomainDkimResponse

Description

Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.

Members
DkimTokens
Required: Yes
Type: Array of strings

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.

VerifyDomainIdentityResponse

Description

Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.

Members
VerificationToken
Required: Yes
Type: 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, to verify the domain, you must restart the verification process from the beginning. The domain's verification status also changes to "Success" when it is DKIM verified.

VerifyEmailIdentityResponse

Description

An empty element returned on a successful request.

Members

WorkmailAction

Description

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.

Members
OrganizationArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:

arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>

You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.

For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

TopicArn
Type: string

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.