Skip to content

MailFromAttributes

Source code in docs_src/capo_sesv2/types/mail_from_attributes.py
class MailFromAttributes(TypedDict, closed=True):
    mail_from_domain: "capo_sesv2.types.mail_from_domain_name.MailFromDomainName"
    """<p>The name of a domain that an email identity uses as a custom MAIL FROM domain.</p>"""
    mail_from_domain_status: (
        "capo_sesv2.types.mail_from_domain_status.MailFromDomainStatus"
    )
    """<p>The status of the MAIL FROM domain. This status can have the following values:</p> <ul> <li> <p> <code>PENDING</code> – Amazon SES hasn't started searching for the MX record yet.</p> </li> <li> <p> <code>SUCCESS</code> – Amazon SES detected the required MX record for the MAIL FROM domain.</p> </li> <li> <p> <code>FAILED</code> – Amazon SES can't find the required MX record, or the record no longer exists.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.</p> </li> </ul>"""
    behavior_on_mx_failure: (
        "capo_sesv2.types.behavior_on_mx_failure.BehaviorOnMxFailure"
    )
    """<p>The action to take if the required MX record can't be found when you send an email. When you set this value to <code>USE_DEFAULT_VALUE</code>, the mail is sent using <i>amazonses.com</i> as the MAIL FROM domain. When you set this value to <code>REJECT_MESSAGE</code>, the Amazon SES API v2 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>"""

behavior_on_mx_failure instance-attribute

behavior_on_mx_failure: BehaviorOnMxFailure

The action to take if the required MX record can't be found when you send an email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE, the Amazon SES API v2 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.

mail_from_domain instance-attribute

mail_from_domain: MailFromDomainName

The name of a domain that an email identity uses as a custom MAIL FROM domain.

mail_from_domain_status instance-attribute

mail_from_domain_status: MailFromDomainStatus

The status of the MAIL FROM domain. This status can have the following values:

  • PENDING – Amazon SES hasn't started searching for the MX record yet.

  • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

  • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.