SES / Client / set_identity_mail_from_domain

set_identity_mail_from_domain#

SES.Client.set_identity_mail_from_domain(**kwargs)#

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

Warning

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

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

See also: AWS API Documentation

Request Syntax

response = client.set_identity_mail_from_domain(
    Identity='string',
    MailFromDomain='string',
    BehaviorOnMXFailure='UseDefaultValue'|'RejectMessage'
)
Parameters:

  • Identity (string) –

    [REQUIRED]

    The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

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

  • BehaviorOnMXFailure (string) –

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

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An empty element returned on a successful request.

Examples

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

response = client.set_identity_mail_from_domain(
    BehaviorOnMXFailure='UseDefaultValue',
    Identity='user@example.com',
    MailFromDomain='bounces.example.com',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}