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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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.

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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',
]);