Reference
Domains
The domains this server receives and sends mail for. Each person’s address belongs to one of them.
On this page
In the console: Management › Domains › Domains
The domains this server receives and sends mail for. Each person’s address belongs to one of them.
Domain
Domain Name
The domain people’s addresses end in, like example.com.
Text. Name in the API: name.
Aliases
Other domains that deliver to the same people. Mail to someone@alias.com lands in someone@example.com.
A list. Each one: text. Name in the API: aliases.
Enabled
Turn off to stop accepting mail for this domain without deleting anything.
On or off. Default: On. Name in the API: isEnabled.
Tenant
The customer or organization this domain belongs to, if you host more than one.
One of your Tenants, chosen from a list. Name in the API: memberTenantId.
Directory
Where this domain’s accounts and passwords are kept: here, or an outside directory.
One of your Directories, chosen from a list. Name in the API: directoryId.
Allow SCIM Provisioning
Whether external SCIM clients may provision accounts in this domain. When enabled, SCIM becomes authoritative for accounts in this domain and just-in-time directory provisioning no longer modifies them.
On or off. Name in the API: allowScimProvisioning.
Catch-All Address
Where mail to addresses that don’t exist goes. Handy for small teams; on a busy domain it collects spam.
An email address. Name in the API: catchAllAddress.
Sub-Addressing
Lets people use address+anything@example.com to sort or trace their mail. On for most domains.
Settings of their own: see Sub addressing. Name in the API: subAddressing.
Allow Relaying
Forward mail for unknown people to another server, for domains split between two systems. Leave off otherwise.
On or off. Name in the API: allowRelaying.
DKIM
DKIM Management
Signing keys that prove mail from this domain is really yours. Automatic creates and rotates them for you.
Settings of their own: see DKIM management. Name in the API: dkimManagement.
TLS
Certificate Management
The TLS certificate for this domain’s mail and web addresses. Automatic gets and renews one for you.
Settings of their own: see Certificate management. Name in the API: certificateManagement.
DNS
DNS Management
Whether the server writes this domain’s DNS records itself through your DNS host, or you add them by hand.
Settings of their own: see DNS management. Name in the API: dnsManagement.
Reports
Report Address
Where other mail servers send reports about mail claiming to be from you (DMARC, TLS). Postmaster is a good choice.
Text. Default: mailto:postmaster. Name in the API: reportAddressUri.
Details
Description
Description of the domain.
Text. Name in the API: description.
Logo
A logo for this domain’s sign-in page and mail apps. A link or an uploaded image.
Text. Name in the API: logo.
Created At
Creation date of the domain.
A date and time. Read only. Name in the API: createdAt.
Set by the server
DNS zone file
Current DNS zone data for the domain.
Text, over several lines if needed. Read only. Name in the API: dnsZoneFile.