Skip to content

mail_domain_get

Get a sending domain with its DNS records and per-record verification status

Tool

mail_domain_get

Get a sending domain with its DNS records and per-record verification status

Get a sending domain with its DNS records and per-record verification status

Behavior

HTTP
GET /mail/domains/:id

Arguments

Name
Type
Required
Description
id
string
•
Sending domain id

Response

Field
Type
Always
Description
id
string
•
Sending domain id
tls
string
•
TLS policy for delivery: opportunistic falls back to plaintext if the recipient offers no TLS, enforced fails the send instead
apex
string
•
Governed apex this domain sits under; null if it is not governed
mode
string
•
Who operates DNS: managed if the platform publishes the records for you, external if you publish them yourself; null if the domain is not governed
name
string
•
The sending domain itself, e.g. "example.com"
active
boolean
•
True only when the domain is verified AND its governance binding is active — the condition for sending from it
region
string
•
AWS region hosting the SES identity, which fixes data residency; set at create time and immutable
status
string
•
SES verification state: not_started before the first check, pending while DNS propagates, verified once sending is allowed, failed or temporary_failure when SES could not verify
records
array
•
DNS records to publish for this domain, each with its last-seen resolution status
createdAt
string
•
When the domain was registered (ISO 8601 UTC)
updatedAt
string
•
When the domain record was last changed (ISO 8601 UTC)
verifiedAt
string
•
When the domain became verified (ISO 8601 UTC); null while it is not
instructions
array
•
Human-readable steps still outstanding before this domain can send
openTracking
boolean
•
True if a 1x1 pixel is injected into outgoing mail to record opens
bindingStatus
string
•
Governance binding state: pending while it is being granted, active once the domain may be used, failed if it could not be granted
clickTracking
boolean
•
True if links are rewritten through the tracking host to record clicks
dmarcBindingId
string
•
Id of the separate binding that publishes this domain's DMARC record; null on external domains, which publish DMARC themselves, and when the _dmarc host could not be claimed
customReturnPath
string
•
Host used as the bounce (Return-Path) address, so bounces come back to this product
trackingSubdomain
string
•
Host serving the click redirect and the open pixel; null if tracking is off
governanceDomainId
string
•
Id of the governance domain this one is registered under; null if it is not governed
governanceBindingId
string
•
Id of the binding between this product and the governance domain; null if unbound
verificationStartedAt
string
•
When verification was first requested (ISO 8601 UTC)
lastVerificationCheckAt
string
•
When DNS and SES were last checked (ISO 8601 UTC); null if no check has run yet

Try it

Get a sending domain with its DNS records and per-record verification status.

When to use

Get a sending domain with its DNS records and per-record verification status

Example

Ask your agent something like this:

Get a sending domain with its DNS records and per-record verification status.

The agent will invoke mail_domain_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select