Domains
Adding domains, the DNS records they need, and their addresses.
Domains tools
| Tool | What it does |
|---|---|
| listDomains | The domains in this workspace, with whether each is verified, can send, has its catch-all on, and how many addresses it has. Returned a page at a time. |
| getDomain | Everything about one domain, by id or name, including every DNS record to publish and whether it is found, missing or not checked yet. |
| addDomain | Add a domain and get back the DNS records to publish at its DNS host. |
| verifyDomain | Check a domain’s DNS again now and say which records are still missing. |
| setDomainCatchAll | Turn the catch-all on or off, so either any address on the domain or only its listed addresses take mail. |
| removeDomain | Remove a domain and withdraw the records written to a connected DNS host. A chat always asks first. |
| listDomainAddresses | The addresses on one domain, with their label, whether each takes mail, and when it last received any. Returned a page at a time. |
| addDomainAddress | Create an address on a domain, with an optional label. |
| updateDomainAddress | Change an address’s label, whether it takes mail, or both. |
| removeDomainAddress | Remove an address, so it stops taking mail and any sign-in for it ends. A chat always asks first. |
Reading needs domains:read and changing needs domains:write. A domain reaches every address on it, so a client limited to some addresses or domains cannot add one, and changes a domain or its addresses only when it holds that whole domain.
The workspace’s last domain cannot be removed from here, because removing it deletes the whole mailbox with it. That is done in the app, where it is confirmed first.
The tools act exactly as the REST API does, and the /domains pages of the API reference describe every field and refusal.