SetIdentityMailFromDomain
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
Important
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- BehaviorOnMXFailure
-
The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you chooseRejectMessage
, Amazon SES returns aMailFromDomainNotVerified
error and not send the email.The action specified in
BehaviorOnMXFailure
is taken when the custom MAIL FROM domain setup is in thePending
,Failed
, andTemporaryFailure
states.Type: String
Valid Values:
UseDefaultValue | RejectMessage
Required: No
- Identity
-
The verified identity.
Type: String
Required: Yes
- MailFromDomain
-
The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of
null
disables the custom MAIL FROM setting for the identity.Type: String
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: