Skip to Content

The Domain type of the TypeScript SDK, which domains.create and 3 more methods take or answer.

type Domain = {
  accountId: string | null
  aliasOf: string | null
  createdAt: number
  dav: boolean
  dmarc: boolean
  dnsCheckedAt: number | null
  dnsStatus: DnsStatus | null
  domain: string
  enabled: boolean
  fbl: boolean
  itip: boolean
  jmap: boolean
  mailboxCount?: number
  pimBytes?: number | null
  receiveOnly: boolean
  receiving: boolean
  sendHold: ('disabled' | 'paused') | null
  sendOnly: boolean
  sendVerified: boolean
  sending: boolean
  srs: boolean
  subaddressing: boolean
  unicodeName: string
  usageAt?: number
  usageStale?: boolean
  usedBytes?: number
}

Fields

FieldTypeDescription
accountIdstring | nullAccount ID owning this domain, or null
aliasOfstring | nullTarget domain if this domain is an alias, otherwise null
createdAtnumberCreation timestamp in epoch seconds
davbooleanTrue if CalDAV and CardDAV service discovery is enabled
dmarcbooleanTrue if DMARC aggregate report processing is enabled
dnsCheckedAtnumber | nullTimestamp when DNS was last checked in epoch seconds
dnsStatusDnsStatus | nullDNS verification status for mail records
domainstringFully qualified domain name
enabledbooleanTrue if the domain is in service (both directions) — the owner's switch
fblbooleanTrue if Feedback Loop (FBL) complaint processing is enabled
itipbooleanTrue if calendar invites received via email are automatically processed
jmapbooleanTrue if JMAP service discovery is enabled
mailboxCountnumberOptional. Count of mailboxes on this domain (when requested with ?mailboxCounts=true)
pimBytesnumber | nullOptional. Sampled calendar/contacts storage in bytes (when requested with ?usage=true)
receiveOnlybooleanTrue for the RECEIVE-ONLY mode, the mirror of sendOnly: the domain receives here and its outbound mail goes through somebody else, so the send-authentication records (bounce CNAME + both DKIM CNAMEs) leave the DNS checklist AND the verdict and sending is never activated. The owner's choice, not an enforcement state; mutually exclusive with sendOnly
receivingbooleanThis domain receives here (enabled && !sendOnly)
sendHold('disabled' | 'paused') | nullThis domain's own operator enforcement: 'disabled' = permanent stop (403 sending_disabled), 'paused' = reversible hold (429 sending_paused), null = neither. System-written only; the account's hold is reported on the Account
sendOnlybooleanTrue for the SEND-ONLY mode: the tenant sends as the domain while its inbound MX stays at another provider, so nothing on it is a local recipient — the owner's choice of where their mail lives, not an enforcement state
sendVerifiedbooleanTrue once the send records (bounce CNAME + both DKIM CNAMEs) were proven live by POST /domains — the EARNED half of sendability; false means 'publish DNS', never 'stopped'. Always false for a receiveOnly domain, which is never offered those records
sendingbooleanThis domain may send by its own switches (enabled && sendVerified && sendHold === null). The account's hold is not folded in — read it from the Account; /auth/verify reports the effective fold for a login
srsbooleanTrue if the SRS0=/SRS1= local-part namespace at this domain is the platform's forwarding bounce-return path (system-managed)
subaddressingbooleanWhether + is a tag delimiter on this domain (default true): mail to alice+anything@ reaches alice@, and alice+*@ is a permitted sender family. False makes + an ordinary character — no stripping, no tag recorded, no +* family advertised
unicodeNamestringThe Unicode presentation of the domain (D4): domainToUnicode of the stored A-label, equal to domain when it is pure ASCII. A display form only - never an identifier; DNS instructions and all routing use domain
usageAtnumberOptional. Timestamp when usage was sampled in epoch seconds
usageStalebooleanOptional. True if sampled usage figures could not be refreshed recently
usedBytesnumberOptional. Sampled mail storage in bytes (when requested with ?usage=true)

Used by

MethodWhat it does
domains.createRegister or verify a domain
domains.listList domains
domains.getGet domain details
domains.updateUpdate domain settings

On this page