Skip to content

GetMailDomainResponse

Source code in docs_src/capo_workmail/types/get_mail_domain_response.py
class GetMailDomainResponse(TypedDict, closed=True):
    records: NotRequired["capo_workmail.types.dns_records.DnsRecords"]
    """<p>A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.</p>"""
    is_test_domain: "capo_workmail.types.boolean.Boolean"
    """<p>Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.</p>"""
    is_default: "capo_workmail.types.boolean.Boolean"
    """<p>Specifies whether the domain is the default domain for your organization.</p>"""
    ownership_verification_status: NotRequired[
        "capo_workmail.types.dns_record_verification_status.DnsRecordVerificationStatus"
    ]
    """<p> Indicates the status of the domain ownership verification.</p>"""
    dkim_verification_status: NotRequired[
        "capo_workmail.types.dns_record_verification_status.DnsRecordVerificationStatus"
    ]
    """<p>Indicates the status of a DKIM verification.</p>"""

dkim_verification_status instance-attribute

dkim_verification_status: NotRequired[DnsRecordVerificationStatus]

Indicates the status of a DKIM verification.

is_default instance-attribute

is_default: Boolean

Specifies whether the domain is the default domain for your organization.

is_test_domain instance-attribute

is_test_domain: Boolean

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

ownership_verification_status instance-attribute

ownership_verification_status: NotRequired[DnsRecordVerificationStatus]

Indicates the status of the domain ownership verification.

records instance-attribute

records: NotRequired[DnsRecords]

A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.