Check an email domain of a site
check_site_email_domain
Checks one email domain of a site again now, looking up its DNS records and asking the mail provider where it stands.
It returns the site's email settings with the result in emailDomains.items: the domain's status, its dkimStatus and the status of each record. A record is valid when it is in place, pending while it is not found yet, invalid when it holds a different value, missing when it is not there, elsewhere when the domain receives its mail at another host, inherited when the DMARC record of the parent domain already covers it, or unknown when the lookup could not be completed.
Run it once you have added or changed the records. Every check starts the 14 days an unverified domain is kept for over again. Any member of the workspace who has API access may check.
manual true counts as you checking by hand: the DNS records are looked up fresh, at most once every 5 seconds, and the mail provider is asked at most once every 60 seconds. Without it, a check made in the last few seconds can be reused.
Domains are also checked on their own in the background, and a DNS change can take a while to show up, so the tool tells the client to call it once after a change rather than polling it. The mail provider can take up to 72 hours to confirm a domain after every record is found. See The records to add.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
domainId |
string | Yes | The id of the email domain, from emailDomains.items in get_site_email_settings. |
manual |
boolean | No | True when you asked for the check, to look the DNS records up fresh. |