Skip to content

IdentityMailFromDomainAttributes

Source code in docs_src/capo_ses/types/identity_mail_from_domain_attributes.py
class IdentityMailFromDomainAttributes(TypedDict, closed=True):
    mail_from_domain: "capo_ses.types.mail_from_domain_name.MailFromDomainName"
    """<p>The custom MAIL FROM domain that the identity is configured to use.</p>"""
    mail_from_domain_status: (
        "capo_ses.types.custom_mail_from_status.CustomMailFromStatus"
    )
    """<p>The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is <code>Success</code>, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by <code>BehaviorOnMXFailure</code>.</p>"""
    behavior_on_mx_failure: "capo_ses.types.behavior_on_mx_failure.BehaviorOnMXFailure"
    """<p>The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of <code>UseDefaultValue</code> indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of <code>RejectMessage</code> indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a <code>MailFromDomainNotVerified</code> error and does not send the email.</p> <p>The custom MAIL FROM setup states that result in this behavior are <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>.</p>"""

behavior_on_mx_failure instance-attribute

behavior_on_mx_failure: BehaviorOnMXFailure

The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

mail_from_domain instance-attribute

mail_from_domain: MailFromDomainName

The custom MAIL FROM domain that the identity is configured to use.

mail_from_domain_status instance-attribute

mail_from_domain_status: CustomMailFromStatus

The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.