:doc:`PinpointEmail <../../pinpoint-email>` / Client / put_email_identity_mail_from_attributes

***************************************
put_email_identity_mail_from_attributes
***************************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityMailFromAttributes>`_  


  **Request Syntax**
  ::

    response = client.put_email_identity_mail_from_attributes(
        EmailIdentity='string',
        MailFromDomain='string',
        BehaviorOnMxFailure='USE_DEFAULT_VALUE'|'REJECT_MESSAGE'
    )
    
  :type EmailIdentity: string
  :param EmailIdentity: **[REQUIRED]** 

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

    

  
  :type MailFromDomain: string
  :param 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 BehaviorOnMxFailure: string
  :param 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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 

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

      
  
  **Exceptions**
  
  *   :py:class:`PinpointEmail.Client.exceptions.NotFoundException`

  
  *   :py:class:`PinpointEmail.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`PinpointEmail.Client.exceptions.BadRequestException`

  