# Domain

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

```ts
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

| Field | Type | Description |
| --- | --- | --- |
| `accountId` | `string` \| `null` | Account ID owning this domain, or null |
| `aliasOf` | `string` \| `null` | Target domain if this domain is an alias, otherwise null |
| `createdAt` | `number` | Creation timestamp in epoch seconds |
| `dav` | `boolean` | True if CalDAV and CardDAV service discovery is enabled |
| `dmarc` | `boolean` | True if DMARC aggregate report processing is enabled |
| `dnsCheckedAt` | `number` \| `null` | Timestamp when DNS was last checked in epoch seconds |
| `dnsStatus` | [`DnsStatus`](/docs/sdks/typescript/types/dns-status) \| `null` | DNS verification status for mail records |
| `domain` | `string` | Fully qualified domain name |
| `enabled` | `boolean` | True if the domain is in service (both directions) — the owner's switch |
| `fbl` | `boolean` | True if Feedback Loop (FBL) complaint processing is enabled |
| `itip` | `boolean` | True if calendar invites received via email are automatically processed |
| `jmap` | `boolean` | True if JMAP service discovery is enabled |
| `mailboxCount` | `number` | Optional. Count of mailboxes on this domain (when requested with ?mailboxCounts=true) |
| `pimBytes` | `number` \| `null` | Optional. Sampled calendar/contacts storage in bytes (when requested with ?usage=true) |
| `receiveOnly` | `boolean` | True 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 |
| `receiving` | `boolean` | This domain receives here (enabled && !sendOnly) |
| `sendHold` | `('disabled' \| 'paused') \| null` | This 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 |
| `sendOnly` | `boolean` | True 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 |
| `sendVerified` | `boolean` | True 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 |
| `sending` | `boolean` | This 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 |
| `srs` | `boolean` | True if the SRS0=/SRS1= local-part namespace at this domain is the platform's forwarding bounce-return path (system-managed) |
| `subaddressing` | `boolean` | Whether `+` 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 |
| `unicodeName` | `string` | The 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` |
| `usageAt` | `number` | Optional. Timestamp when usage was sampled in epoch seconds |
| `usageStale` | `boolean` | Optional. True if sampled usage figures could not be refreshed recently |
| `usedBytes` | `number` | Optional. Sampled mail storage in bytes (when requested with ?usage=true) |

## Used by

| Method | What it does |
| --- | --- |
| [`domains.create`](/docs/sdks/typescript/domains/create) | Register or verify a domain |
| [`domains.list`](/docs/sdks/typescript/domains/list) | List domains |
| [`domains.get`](/docs/sdks/typescript/domains/get) | Get domain details |
| [`domains.update`](/docs/sdks/typescript/domains/update) | Update domain settings |
