put_email_identity_mail_from_attributes

PinpointEmail.Client.put_email_identity_mail_from_attributes(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.put_email_identity_mail_from_attributes(
    EmailIdentity='string',
    MailFromDomain='string',
    BehaviorOnMxFailure='USE_DEFAULT_VALUE'|'REJECT_MESSAGE'
)

Parameters

• EmailIdentity (string) --

  [REQUIRED]

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

• MailFromDomain (string) --

  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.
• BehaviorOnMxFailure (string) --

  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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

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

Exceptions

• PinpointEmail.Client.exceptions.NotFoundException
• PinpointEmail.Client.exceptions.TooManyRequestsException
• PinpointEmail.Client.exceptions.BadRequestException