put_email_identity_mail_from_attributes async ¶

async def put_email_identity_mail_from_attributes(
    self,
    email_identity: "capo_pinpoint_email.types.identity.Identity",
    *,
    config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
    mail_from_domain: Optional[
        "capo_pinpoint_email.types.mail_from_domain_name.MailFromDomainName"
    ] = None,
    behavior_on_mx_failure: Optional[
        "capo_pinpoint_email.types.behavior_on_mx_failure.BehaviorOnMxFailure"
    ] = None,
) -> "capo_pinpoint_email.types.put_email_identity_mail_from_attributes_response.PutEmailIdentityMailFromAttributesResponse":
    """<p>Used to enable or disable the custom Mail-From domain configuration for an email identity.</p>

    Args:
        email_identity: <p>The verified email identity that you want to set up the custom MAIL FROM domain for.</p>
        mail_from_domain: <p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:</p> <ul> <li> <p>It has to be a subdomain of the verified identity.</p> </li> <li> <p>It can't be used to receive email.</p> </li> <li> <p>It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.</p> </li> </ul>
        behavior_on_mx_failure: <p>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 <code>UseDefaultValue</code>, Amazon Pinpoint uses <i>amazonses.com</i> as the MAIL FROM domain. When you set this value to <code>RejectMessage</code>, Amazon Pinpoint returns a <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the email.</p> <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code> states.</p>

    Raises:
        capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_pinpoint_email.errors.not_found_exception.NotFoundException: <p>The resource you attempted to access doesn't exist.</p>
        capo_pinpoint_email.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_pinpoint_email.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint_email.types.put_email_identity_mail_from_attributes_request.PutEmailIdentityMailFromAttributesRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint_email.types.put_email_identity_mail_from_attributes_response.PutEmailIdentityMailFromAttributesResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_email_identity_mail_from_attributes

        (
            output,
            http_response,
        ) = await capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_email_identity_mail_from_attributes.async_put_email_identity_mail_from_attributes(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutEmailIdentityMailFromAttributes")
    )
    input_: capo_pinpoint_email.types.put_email_identity_mail_from_attributes_request.PutEmailIdentityMailFromAttributesRequest = {
        "email_identity": email_identity
    }
    if mail_from_domain is not None:
        input_["mail_from_domain"] = mail_from_domain
    if behavior_on_mx_failure is not None:
        input_["behavior_on_mx_failure"] = behavior_on_mx_failure

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output