Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

PutEmailIdentityMailFromAttributes

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Request Syntax

PUT /v1/email/identities/EmailIdentity/mail-from HTTP/1.1 Content-type: application/json { "BehaviorOnMxFailure": "string", "MailFromDomain": "string" }

URI Request Parameters

The request requires the following URI parameters.

EmailIdentity

The verified email identity that you want to set up the custom MAIL FROM domain for.

Request Body

The request accepts the following data in JSON format.

BehaviorOnMxFailure

The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

Type: String

Valid Values: USE_DEFAULT_VALUE | REJECT_MESSAGE

Required: No

MailFromDomain

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

  • It has to be a subdomain of the verified identity.

  • It can't be used to receive email.

  • It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.

Type: String

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: