--- title: "openemail.domains" description: "Every method in this namespace: its signature, its parameters, what it returns and an example." url: "https://openemail.uk/docs/sdk/reference/domains" area: "SDK" category: "Reference" --- # openemail.domains Every method in this namespace: its signature, its parameters, what it returns and an example. ## Methods Custom domains attached to the workspace: add and remove them, read the DNS records to publish, check whether they can receive and send, manage their addresses and their photos, and set the catch-all, the tracking and files domains, the DMARC policy and the brand logo. ### `domains.list()` List the workspace's domains and their receiving state ```ts list(options?: ListOptions): Promise> ``` Returns one page of the domains added to the workspace, alphabetically by domain. `listAll` collects every page and `iterate` walks them lazily. `receiving` reports the inbound checks: `verified` is true once `verifiedAt` is set, `catchAll` is the domain's catch all setting, `lastCheckedAt` is the most recent check and `error` is the last verification failure. `receiving` and `sending` are independent. A verified domain can receive mail, and that says nothing about whether outbound mail from it is signed. `sending.status` is the signing state as the last check saw it, one of `verified`, `pending`, `failed`, `no_identity` or `unknown`, `sending.canSend` says whether a send from the domain would be accepted right now, `sending.checkedAt` dates that verdict, and `sending.error` carries the last failure. A negative verdict older than a day is treated as unknown rather than as a refusal, so `canSend` can be true while `status` is `pending`. `tracking` reports the domain's custom tracking domain, set with `update`, and only a `tracking.status` of `active` means tracked links and the open pixel in new mail from the domain use its `host` instead of the default OpenEmail host. `storage` reports the domain's custom files domain the same way, and only a `storage.status` of `active` means the download links for files sent from the domain use its `host`. Scopes: `domains:read`. **Parameters** - `options.limit` (`number`): Page size, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): The `nextCursor` of the previous page. Leave it out for the first page. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `Page` with `items`, `hasMore` and `nextCursor`. Each item has `id`, `domain`, `receiving`, `sending`, `tracking`, `storage`, `logo`, `dmarcPolicy` and `createdAt`. **Example** ```ts const domains = await openemail.domains.listAll() const unverified = domains.filter((domain) => !domain.receiving.verified) for (const domain of unverified) { console.log(domain.domain, domain.receiving.error ?? 'waiting for DNS', domain.receiving.lastCheckedAt) } ``` **Notes** - A narrowed key still sees every domain in the workspace, whether it is narrowed by whole domains or by individual addresses. - Addresses, DNS records and the DMARC reading are only on `get`. `listAddresses` pages through the addresses on one domain. - The cursor is opaque and holds where the last row sat in this order, so a row deleted or edited between pages never breaks the walk: the next page starts at the first row that sorts after it. A cursor this list did not hand out is a 400 `invalid_cursor`. Also available in: API [`GET /domains`](https://openemail.uk/docs/api/reference/domains#get-domains); CLI [`openemail domains list`](https://openemail.uk/docs/cli/reference/domains#domains-list). ### `domains.listAll()` Collect every domain into one array ```ts listAll(options?: ListOptions): Promise> ``` Walks every page of `list` and resolves with all domains, alphabetically by domain. One request per page. Scopes: `domains:read`. **Parameters** - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `Array` holding every domain. **Example** ```ts const all = await openemail.domains.listAll({ limit: 100 }) console.log(all.length) ``` **Notes** - If any page fails the promise rejects and the domains already fetched are discarded. Also available in: API [`GET /domains`](https://openemail.uk/docs/api/reference/domains#get-domains). ### `domains.iterate()` Stream the domains one at a time ```ts iterate(options?: ListOptions): AsyncGenerator ``` Returns an async generator that yields domains individually, alphabetically by domain, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests. Scopes: `domains:read`. **Parameters** - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `AsyncGenerator` yielding one domain per step. **Example** ```ts for await (const item of openemail.domains.iterate()) { console.log(item) } ``` **Notes** - The generator is lazy, so an abandoned loop costs only the pages you consumed. Also available in: API [`GET /domains`](https://openemail.uk/docs/api/reference/domains#get-domains). ### `domains.get()` Read one domain with its addresses, DNS records and DMARC reading ```ts get(id: string, options?: RequestScope): Promise ``` Returns the same `receiving` and `sending` blocks as `list`, plus `addresses`: every address on the domain as a full lower cased address with its `enabled` flag. Disabled addresses are listed too. `listAddresses` returns the same addresses with their ids and labels. It also carries the `tracking` and `storage` blocks described on `list`, whose `record` is the CNAME record to add at your DNS provider for the tracking domain and for the files domain. `records` is every DNS record the domain uses, each with `type`, `name`, `value`, `priority` on an MX record, a `purpose` written to be shown to a person, and `status`: `found` when the last check saw it in public DNS, `missing` when it did not, and null when it has not been checked yet. Publish each one exactly as given, since the values are specific to this domain. `dmarc` is the domain's DMARC record as public DNS has it, with its `stage`, any `issues`, and whether a policy stricter than `p=none` is safe yet. It is null until the domain is verified. Reading an unverified domain checks its DNS again when the last check is more than 20 seconds old, so polling `get` is one way to wait for verification. `verify` checks straight away. The id must belong to the calling workspace. Another workspace's domain id is a 404, the same as an id that does not exist, and the domain name is not accepted in its place. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list`, a UUID. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainDetailResource`, a `DomainResource` plus `addresses` as `{ address, enabled }`, `records` as `DomainRecordResource` and `dmarc` as `DomainDmarcResource` or null. **Example** ```ts const domain = await openemail.domains.get('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') const live = domain.addresses.filter((entry) => entry.enabled) console.log(domain.domain, domain.receiving.verified, live.map((entry) => entry.address)) ``` **Notes** - `sending.canSend` is the value to branch on before a send: when it is false, `emails.send` from this domain is refused with 409 `domain_not_sendable`. - A narrowed key still sees every address on the domain, whether it is narrowed by whole domains or by individual addresses. Also available in: API [`GET /domains/{id}`](https://openemail.uk/docs/api/reference/domains#get-domains-id); CLI [`openemail domains get`](https://openemail.uk/docs/cli/reference/domains#domains-get). ### `domains.create()` Add a domain to the workspace ```ts create(body: DomainCreate, options?: RequestScope): Promise ``` Adds a domain and returns it with every DNS record to publish, in the same shape as `get`. The first DNS check runs during the call, so `records[].status` already says what public DNS answers with. The domain receives mail once public DNS answers with its MX records and its `_openemail-challenge` TXT record, and it can send once its signing records are in place. Publish every entry in `records` exactly as given, since the values are specific to this domain, then call `verify` or poll `get` until `receiving.verified` is true. A new domain starts with its catch-all on and no addresses. Create addresses with `createAddress`, or turn the catch-all off with `update`. Scopes: `domains:write`. **Parameters** - `body.domain` (`string`, required): A bare domain such as `example.com`. It is trimmed, lower cased and converted to its ASCII form, so an internationalised name is stored as punycode. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainDetailResource`: the new domain with `addresses` empty, `records` holding every DNS record to publish, and `dmarc` null until the domain is verified. **Example** ```ts const domain = await openemail.domains.create({ domain: 'example.com' }) for (const record of domain.records) { console.log(record.type, record.name, record.value, record.priority ?? '', record.status ?? 'not checked') } ``` **Notes** - How many domains you can add is set by the plan of the workspace, counted within that workspace. Past it the call is refused with 403 `domain_allowance_reached`, and the message says which plan includes more. - A domain you already added is 409 `domain_already_added`, one somebody else added is 409 `domain_claimed`, one whose parent or subdomain belongs to somebody else is 409 `related_domain_owned`, and one that belongs to OpenEmail is 409 `operator_domain`. Anything that is not a hostname is 422 `invalid_parameter` on `domain`. - Adding a domain reaches the whole workspace, so a key or app limited to particular addresses or domains is refused with 422 `capability_unsupported` on `domainAllowlist`. Use a key with no address or domain restriction. - The SDK does not retry a create after a network failure. A second attempt after a lost response is refused with 409 `domain_already_added`, which means the first one worked: read the domain with `list`. Also available in: API [`POST /domains`](https://openemail.uk/docs/api/reference/domains#post-domains); CLI [`openemail domains create`](https://openemail.uk/docs/cli/reference/domains#domains-create). ### `domains.verify()` Check a domain's DNS now ```ts verify(id: string, options?: RequestScope): Promise ``` Checks the DNS of the domain straight away and returns it in the same shape as `get`. On an unverified domain it looks for the records that verify it, and `receiving.verified` comes back true when they are found. On a verified domain it checks the signing and return path records again and asks whether mail from the domain can be sent, so `sending` is fresh. When the last check ran less than 10 seconds ago, nothing new is checked and the domain comes back as it stands, so calling it faster than that gains nothing. A record published a moment ago can take a few minutes to show up in public DNS. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainDetailResource` as the check left it. **Example** ```ts let domain = await openemail.domains.verify('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') while (!domain.receiving.verified) { const waiting = domain.records.filter((record) => record.status !== 'found') console.log(domain.receiving.error, waiting.map((record) => `${record.type} ${record.name}`)) await new Promise((resolve) => setTimeout(resolve, 30_000)) domain = await openemail.domains.verify(domain.id) } ``` **Notes** - Reading an unverified domain with `get` also checks it again when its last check is more than 20 seconds old, so either call works for polling. `verify` needs `domains:write` and `get` needs only `domains:read`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - A domain id from another workspace is a 404, the same as an id that does not exist. - Retried automatically on network failure and retryable statuses, since a repeated check changes nothing but the time of the check. Also available in: API [`POST /domains/{id}/verify`](https://openemail.uk/docs/api/reference/domains#post-domains-id-verify); CLI [`openemail domains verify`](https://openemail.uk/docs/cli/reference/domains#domains-verify). ### `domains.update()` Turn the catch-all on or off, set or remove the tracking and files domains, and set the DMARC policy ```ts update(id: string, patch: DomainPatch, options?: RequestScope): Promise ``` `catchAll` true accepts mail to any address on the domain that nobody created, and the address shows up in `listAddresses` from its first message on. False refuses mail to every address that was not created by hand, including the ones the catch-all picked up before. It applies to the whole domain, so only a key that holds the whole domain may change it. `trackingHost` and `storageHost` set the two custom names a domain can carry once it is verified or its `_openemail-challenge` TXT record is published, each of them a subdomain of it. `trackingHost`, such as `links.example.com`, is the name tracked links and the open pixel use. `storageHost`, such as `files.example.com`, is the name the download links for files sent from the domain use. All four fields are optional and independent: a field left out is left alone, and for either host `null` or an empty string removes that name and a string sets it. A patch carrying none of them changes nothing and answers with the domain as it stands. Each value is trimmed and lower cased, and a leading `https://` or `http://`, any path, query or fragment and any trailing dots are stripped. A new host is validated, saved and checked in the same call, so the response already carries the result of that first check. `trackingHost` reports into the `tracking` block and `storageHost` into `storage`, and the two blocks carry the same fields. The check asks the host over HTTPS for an answer signed by OpenEmail, on `/t/v/` for a tracking domain and `/f/v/` for a files domain, so the host needs a CNAME record named `record.name` with the value `record.value`, with any proxying turned off. That value, also reported as `target`, is an address prepared for this host alone. When it could not be prepared during the call, `record` is null, `target` is an empty string and `error` says so, and it is finished within a few minutes without another call. Until a check passes, `status` is `pending` and new mail keeps using the default OpenEmail host. Once one passes, `status` is `active` and new mail from the domain uses the host. Sending a host the domain already has runs the check again, unless the last check was less than 30 seconds ago, in which case the stored state comes back unchanged. A different host replaces the current one at once, so new mail uses the default host until the new one passes a check. `null` or an empty string removes that name, and its block then reports `status` as `none` with `host` and `record` null. `dmarcPolicy` is what the domain's DMARC record tells receivers to do with mail that fails its checks: `none` only monitors, `quarantine` sends it to spam and `reject` refuses it. Inboxes show the domain logo only at `quarantine` or `reject`, and where OpenEmail writes the DNS for the domain the record is updated during the call, keeping its other tags such as `rua`, while elsewhere you publish the DMARC record `records` lists. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list`, a UUID. - `patch.catchAll` (`boolean`): True accepts mail to any address on the domain that nobody created, false refuses it. Leaving the field out leaves the catch-all alone. - `patch.trackingHost` (`string | null`): A subdomain of the domain of at most 512 characters, such as `links.example.com`. Null or an empty string removes the tracking domain, and leaving the field out leaves it alone. - `patch.storageHost` (`string | null`): A subdomain of the domain of at most 512 characters, such as `files.example.com`. Null or an empty string removes the files domain, and leaving the field out leaves it alone. - `patch.dmarcPolicy` (`DomainDmarcPolicy`): `none`, `quarantine` or `reject`. A policy stricter than `none` needs mail from the domain to be signed first. Leaving the field out leaves the policy alone. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainDetailResource`, the same body as `get`, with `receiving.catchAll`, `tracking`, `storage` and `dmarcPolicy` as they stand after the call. **Example** ```ts const domain = await openemail.domains.update('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', { trackingHost: 'links.example.com', storageHost: 'files.example.com' }) const { status, record, error } = domain.tracking console.log(status, record?.name, record?.value, error) console.log(domain.storage.status, domain.storage.record?.name, domain.storage.record?.value) ``` **Notes** - The host is refused with 422 `invalid_tracking_host`, or `invalid_storage_host` for the files domain, when it is not a hostname, is not a strict subdomain of the domain, is the return path host `bounce.`, belongs to OpenEmail or is a domain set up to receive mail. A new host on a domain whose `receiving.verified` is false and whose `_openemail-challenge` TXT record is not published yet gets 409 `domain_not_verified`. The domain does not have to be receiving mail for a host to be accepted. A host another domain already uses gets 409 `tracking_host_in_use` or `storage_host_in_use`, and so does a host already in use for the other feature, since one name cannot be both. A `dmarcPolicy` stricter than `none` while `sending.status` is not `verified` gets 409 `domain_not_sendable`, since unsigned mail from the domain would then go to spam. Every refusal names the field it came from in `param`, and a refused field changes nothing. The fields are applied in order, `catchAll` first, then `trackingHost`, then `storageHost`, then `dmarcPolicy`, so a patch carrying more than one can have an earlier change saved before a later field is refused. Send them in separate calls when any of them has to stand on its own. - Every call on a domain whose tracking domain is managed by a different OpenEmail server, removal included, gets 409 `tracking_host_in_use` until it is removed on that server. A files domain behaves the same way under `storage_host_in_use`. - A tracking domain and a files domain each apply to every address on the domain, so only a key that holds the whole domain may set one. A key whose `domainAllowlist` contains this domain is allowed through, and any other narrowed key gets 422 `capability_unsupported` on `domainAllowlist`. The catch-all and the DMARC policy need the whole domain the same way. A body key other than `catchAll`, `trackingHost`, `storageHost` and `dmarcPolicy` is a 422 `unknown_parameter`, and a `catchAll` that is not a boolean, a `dmarcPolicy` that is not one of the three policies, or a host field that is present but is neither a string nor null, or runs past 512 characters, is a 422 `invalid_parameter`. A body carrying none of the fields is not an error: it changes nothing and comes back 200. - OpenEmail keeps checking on its own. A host that has not passed a check yet is checked every 2 minutes in its first hour, every 10 minutes in its first day, hourly in its first week and every 6 hours after that. An active host is checked every 10 minutes, and a failed check on it is retried after 1 minute and then 2. From the third failure in a row the wait starts at 4 minutes and doubles each time, up to an hour. - An active host that fails one or two checks in a row still reads `active`, with the reason in `error`. It stops being used after the third, or once its last successful check is 2 hours old. New mail then goes back to the default host, and `status` reads `failed` until a check passes again. - A tracking domain serves only tracking paths and a files domain serves only download paths, and each answers only for mail sent by the workspace that owns it. - Links in mail already sent keep the host they were sent with, and that covers the download link on a file as much as a tracked link. After removing or changing a name, those links work only for as long as the old CNAME record stays in place. Setting a host up again can give it a different `record.value`, so publish the one the response reports. - Retried automatically on network failure and retryable statuses, since repeating a call that already went through finds the catch-all, the DMARC policy and the hosts already set, or already removed, and at most checks a host again. Also available in: API [`PATCH /domains/{id}`](https://openemail.uk/docs/api/reference/domains#patch-domains-id); CLI [`openemail domains update`](https://openemail.uk/docs/cli/reference/domains#domains-update). ### `domains.delete()` Remove a domain from the workspace ```ts delete(id: string, options?: RequestScope): Promise ``` Removes the domain. Mail to it stops being accepted and nothing can be sent from it. Every address on it goes with it, their password sign-ins are revoked, its signing key is released, its tracking and files domains are retired, and the `domain.deleted` webhook fires. Mail already received stays in the mailbox. Where OpenEmail wrote the DNS for this domain itself, it takes those records back, and any it could not take back are listed in `leftBehind` for you to remove at your DNS provider. Records you published yourself are never touched, so remove them too once the domain is gone. There is no undo. Adding the domain again starts it from scratch. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DeletedDomainResource`, `{ object: 'domain', id, domain, deleted: true, leftBehind }`, where `leftBehind` lists the DNS records that have to be removed by hand, one line each. **Example** ```ts const removed = await openemail.domains.delete('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') for (const line of removed.leftBehind) console.log('remove by hand:', line) ``` **Notes** - The last domain in a workspace cannot be removed here, because in the app removing it deletes the whole mailbox with it. The call is refused with 409 `last_domain`. Remove it in the app, where that is confirmed first. - A domain that holds reserved account addresses is refused with 409 `domain_holds_reserved_addresses`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - An access token acting for a member also needs `workspace:manage` in that member's role, as removing one in the app does. It is console-only, so no approval can give it to an app, and without it the call is refused with 403 `insufficient_authority`. - The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked. Also available in: API [`DELETE /domains/{id}`](https://openemail.uk/docs/api/reference/domains#delete-domains-id); CLI [`openemail domains delete`](https://openemail.uk/docs/cli/reference/domains#domains-delete). ### `domains.getLogo()` Read the brand logo of a domain and what public DNS publishes for it ```ts getLogo(id: string, options?: RequestScope): Promise ``` Returns the logo inboxes show next to mail from the domain through BIMI, with its mark certificate and DMARC policy, and asks public DNS what `default._bimi.` holds right now: `published.ours` turns true once the record pointing at the logo is live. For a subdomain, `parentDmarc` reports the DMARC record of the domain it belongs to, because inboxes show the logo only when its `p=` and `sp=` both quarantine or reject at 100 percent. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainLogoStatusResource`: `url`, `record`, `certificate`, `matchesCertificate` and `dmarcPolicy`, plus `published` as `{ found, ours, value }` and `parentDmarc`, which is null unless the domain is a subdomain. **Example** ```ts const logo = await openemail.domains.getLogo('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') console.log(logo.url, logo.published.ours, logo.parentDmarc?.enforced) ``` **Notes** - `get` and `list` carry the same `url`, `record`, `certificate` and `matchesCertificate` in each domain's `logo`, but only `getLogo` asks public DNS what is published. - A domain id from another workspace is a 404, the same as an id that does not exist. Also available in: API [`GET /domains/{id}/logo`](https://openemail.uk/docs/api/reference/domains#get-domains-id-logo); CLI [`openemail domains get-logo`](https://openemail.uk/docs/cli/reference/domains#domains-get-logo). ### `domains.setLogo()` Upload the brand logo inboxes show for a domain ```ts setLogo(id: string, body: DomainLogoSet, options?: RequestScope): Promise ``` Converts the SVG to the SVG Tiny PS format inboxes require, replaces any logo the domain had, and publishes the BIMI record where OpenEmail writes the DNS for the domain. Inboxes show the logo once `dmarcPolicy` is `quarantine` or `reject`, which `update` sets, and Gmail also needs a mark certificate from `setLogoCertificate`. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `body.svg` (`string`, required): The logo as SVG markup, up to 1 MB. A file that is SVG Tiny PS already is kept byte for byte, so it stays the same as the copy inside a mark certificate. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainLogoChangeResource`, the logo as it stands. `records` is `published` once the BIMI record is in place, `manual` when you publish `record` yourself, `blocked` when a record you published is in the way, and `busy` or `failed` when calling again may help. **Example** ```ts const svg = await Bun.file('logo.svg').text() const logo = await openemail.domains.setLogo('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', { svg }) console.log(logo.url, logo.records, logo.record?.name, logo.record?.value) ``` **Notes** - A domain that is not verified is refused with 409 `domain_not_verified`. An `svg` that is not SVG, is over 1 MB or uses something inboxes do not draw, such as a bitmap image, a filter or a link to another file, is a 422 `invalid_parameter` whose message says which. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. Safe to replay, so the SDK retries it after a network failure. Also available in: API [`PUT /domains/{id}/logo`](https://openemail.uk/docs/api/reference/domains#put-domains-id-logo); CLI [`openemail domains set-logo`](https://openemail.uk/docs/cli/reference/domains#domains-set-logo). ### `domains.removeLogo()` Remove the brand logo of a domain ```ts removeLogo(id: string, options?: RequestScope): Promise ``` Removes the logo and deletes the stored file, and takes the BIMI record down where OpenEmail writes the DNS for the domain. Elsewhere remove the record yourself. Any mark certificate stays, ready for the next logo. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainLogoChangeResource` with `url` and `record` null, and `records` saying what happened to the BIMI record. **Example** ```ts const logo = await openemail.domains.removeLogo('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') console.log(logo.url, logo.records) ``` **Notes** - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - Removing a logo from a domain that has none changes nothing, so the SDK retries it after a network failure. Also available in: API [`DELETE /domains/{id}/logo`](https://openemail.uk/docs/api/reference/domains#delete-domains-id-logo); CLI [`openemail domains remove-logo`](https://openemail.uk/docs/cli/reference/domains#domains-remove-logo). ### `domains.setLogoCertificate()` Upload the mark certificate for a domain logo ```ts setLogoCertificate(id: string, body: DomainLogoCertificateSet, options?: RequestScope): Promise ``` Stores the Verified Mark Certificate (VMC) or Common Mark Certificate (CMC) a certificate authority issued for the domain, replacing any there was, and points the BIMI record at it. Gmail shows the logo only with one and Apple Mail only with a VMC, and when the logo inside the certificate differs from the published one, it becomes the published one and `logoFromCertificate` is true. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `body.certificate` (`string`, required): The file the certificate authority sent, up to 128 KB: PEM text as it came, which can hold the whole chain, or a DER or PKCS #7 file encoded as base64. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainLogoChangeResource` with `certificate` as `{ url, mark, expiresAt, domains, issuer }`, `matchesCertificate`, `records` and `logoFromCertificate`. **Example** ```ts const certificate = await Bun.file('vmc.pem').text() const logo = await openemail.domains.setLogoCertificate('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', { certificate }) console.log(logo.certificate?.mark, logo.certificate?.expiresAt, logo.logoFromCertificate) ``` **Notes** - A domain that is not verified is refused with 409 `domain_not_verified`. A file that cannot be read, is over 128 KB, holds no VMC or CMC, was issued for a different domain or has expired is a 422 `invalid_parameter` on `certificate` whose message says which. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. Safe to replay, so the SDK retries it after a network failure. Also available in: API [`PUT /domains/{id}/logo/certificate`](https://openemail.uk/docs/api/reference/domains#put-domains-id-logo-certificate); CLI [`openemail domains set-logo-certificate`](https://openemail.uk/docs/cli/reference/domains#domains-set-logo-certificate). ### `domains.removeLogoCertificate()` Remove the mark certificate of a domain logo ```ts removeLogoCertificate(id: string, options?: RequestScope): Promise ``` Removes the mark certificate and deletes the stored file, while the logo stays. The BIMI record no longer points at a certificate, so Gmail and Apple Mail stop showing the logo. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainLogoChangeResource` with `certificate` and `matchesCertificate` null. **Example** ```ts const logo = await openemail.domains.removeLogoCertificate('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') console.log(logo.url, logo.certificate) ``` **Notes** - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - Removing a certificate from a domain that has none changes nothing, so the SDK retries it after a network failure. Also available in: API [`DELETE /domains/{id}/logo/certificate`](https://openemail.uk/docs/api/reference/domains#delete-domains-id-logo-certificate); CLI [`openemail domains remove-logo-certificate`](https://openemail.uk/docs/cli/reference/domains#domains-remove-logo-certificate). ### `domains.listAddresses()` List one page of the addresses on a domain ```ts listAddresses(id: string, options?: ListOptions): Promise> ``` Returns one page of the addresses on the domain, alphabetically by address, with each one's `id`, `label`, `enabled` and `lastReceivedAt`. That covers the addresses created by hand or through the API and the ones the catch-all picked up when mail first arrived for them. Disabled addresses are listed. Removed addresses and the catch-all itself are not: the catch-all is `receiving.catchAll` on the domain. `listAllAddresses` collects every page and `iterateAddresses` walks them lazily. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.limit` (`number`): Page size, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): The `nextCursor` of the previous page. Leave it out for the first page. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `Page` with `items`, `hasMore` and `nextCursor`. **Example** ```ts const page = await openemail.domains.listAddresses('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', { limit: 100 }) for (const address of page.items) console.log(address.address, address.enabled, address.label ?? '') ``` **Notes** - A narrowed key still sees every address on the domain, the same as `get`. - A domain id from another workspace is a 404, the same as an id that does not exist. - The cursor is opaque. A cursor this list did not hand out is a 400 `invalid_cursor`. Also available in: API [`GET /domains/{id}/addresses`](https://openemail.uk/docs/api/reference/domains#get-domains-id-addresses); CLI [`openemail domains list-addresses`](https://openemail.uk/docs/cli/reference/domains#domains-list-addresses). ### `domains.listAllAddresses()` Collect every address on a domain into one array ```ts listAllAddresses(id: string, options?: ListOptions): Promise> ``` Walks every page of `listAddresses` and resolves with all the addresses on the domain, alphabetically by address. One request per page. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `Array` holding every address on the domain. **Example** ```ts const addresses = await openemail.domains.listAllAddresses('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') const disabled = addresses.filter((address) => !address.enabled) console.log(disabled.map((address) => address.address)) ``` **Notes** - If any page fails the promise rejects and the addresses already fetched are discarded. Also available in: API [`GET /domains/{id}/addresses`](https://openemail.uk/docs/api/reference/domains#get-domains-id-addresses). ### `domains.iterateAddresses()` Stream the addresses on a domain one at a time ```ts iterateAddresses(id: string, options?: ListOptions): AsyncGenerator ``` Returns an async generator that yields the addresses on the domain individually, alphabetically by address, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `AsyncGenerator` yielding one address per step. **Example** ```ts for await (const address of openemail.domains.iterateAddresses('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f')) { console.log(address.address, address.lastReceivedAt) } ``` **Notes** - The generator is lazy, so an abandoned loop costs only the pages you consumed. Also available in: API [`GET /domains/{id}/addresses`](https://openemail.uk/docs/api/reference/domains#get-domains-id-addresses). ### `domains.createAddress()` Create an address on a domain ```ts createAddress(id: string, body: DomainAddressCreate, options?: RequestScope): Promise ``` Creates an address on the domain, enabled, and returns it. The domain does not have to be verified yet, but the address receives nothing until it is. When the domain has its catch-all on, the new address starts with the per-address settings of the catch-all, such as its signature and tracking, apart from the privacy settings. They are copied once, not kept in step. Creating an address that already exists, or one that was removed, is not an error: it comes back enabled, with the `label` you sent or none, and keeps its id. An address the catch-all picked up becomes one created by hand, so it keeps receiving when the catch-all is turned off. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `body.localPart` (`string`, required): The part in front of the @, 1 to 64 characters once trimmed, lower cased. Letters, digits, the backtick and ! # $ % & ' * + / = ? ^ _ { | } ~ - are allowed, and so are dots between them. `*` on its own is how the catch-all is written and is refused. - `body.label` (`string | null`): A name for the address shown in the app, trimmed, up to 120 characters. Leave it out, or send null or an empty string, for none. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainAddressResource` with its `id`, `address`, `label` and `enabled` true. **Example** ```ts const address = await openemail.domains.createAddress('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', { localPart: 'support', label: 'Support' }) console.log(address.id, address.address) ``` **Notes** - An address reserved as somebody's account address is refused with 409 `address_reserved` on `localPart`. Past the workspace limit on addresses the call is refused with 422 `workspace_limit_reached`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - A domain id from another workspace is a 404, the same as an id that does not exist. - Retried automatically on network failure and retryable statuses, since creating the same address twice leaves one address with the same id. Also available in: API [`POST /domains/{id}/addresses`](https://openemail.uk/docs/api/reference/domains#post-domains-id-addresses); CLI [`openemail domains create-address`](https://openemail.uk/docs/cli/reference/domains#domains-create-address). ### `domains.getAddress()` Read one address on a domain ```ts getAddress(id: string, addressId: string, options?: RequestScope): Promise ``` Returns one address on the domain with its `label`, `enabled`, `lastReceivedAt` and timestamps. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainAddressResource`. **Example** ```ts const address = await openemail.domains.getAddress('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70') console.log(address.address, address.enabled, address.lastReceivedAt) ``` **Notes** - An address id that is not on this domain, or an address that was removed, is a 404 `resource_not_found`, and so is a domain from another workspace. Also available in: API [`GET /domains/{id}/addresses/{addressId}`](https://openemail.uk/docs/api/reference/domains#get-domains-id-addresses-addressid); CLI [`openemail domains get-address`](https://openemail.uk/docs/cli/reference/domains#domains-get-address). ### `domains.updateAddress()` Rename an address, turn it off and on, or choose where its mail goes ```ts updateAddress(id: string, addressId: string, patch: DomainAddressPatch, options?: RequestScope): Promise ``` Changes the fields you send and leaves the rest alone. `label` renames the address, and null or an empty string removes the name. `enabled` false stops the address taking mail: mail to it is refused while the sending server is still connected, so the sender gets a bounce, and nothing can be sent from it. It keeps its mail, its settings and the people who can reach it, so `enabled` true picks up where it left off. That is the difference from `deleteAddress`. `destination` chooses where the mail of the address goes: `mailbox` keeps a copy here, as an address does by default, and `forward` only sends it on to the destinations from `addAddressForwards`, keeping nothing here. `forward` needs at least one destination that is switched on. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `patch.label` (`string | null`): A new name, trimmed, up to 120 characters. Null or an empty string removes it. - `patch.enabled` (`boolean`): False stops the address taking mail, true takes mail again. - `patch.destination` (`DomainAddressDestination`): `mailbox` keeps a copy of the mail here, `forward` only forwards it. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainAddressResource` as it stands after the change. **Example** ```ts const address = await openemail.domains.updateAddress('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70', { enabled: false }) console.log(address.address, address.enabled) ``` **Notes** - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - A body key other than `label`, `enabled` and `destination` is a 422 `unknown_parameter`. - `destination: 'forward'` on an address with no destination switched on is refused with 409 `forward_required` on `destination`. - Sending `destination` with an OAuth access token needs a verification code, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An access token acting for a member can only change where the mail of an address goes when that member reaches it, or it is refused with 403 `insufficient_authority`. An API key is never asked for a code. - Retried automatically on network failure and retryable statuses, since the same patch sent twice leaves the same address. Also available in: API [`PATCH /domains/{id}/addresses/{addressId}`](https://openemail.uk/docs/api/reference/domains#patch-domains-id-addresses-addressid); CLI [`openemail domains update-address`](https://openemail.uk/docs/cli/reference/domains#domains-update-address). ### `domains.setAddressPhoto()` Upload the photo shown for an address ```ts setAddressPhoto(id: string, addressId: string, data: RawBody, options?: DomainAddressPhotoOptions): Promise ``` Sends the image bytes as the request body, replacing any photo the address had: PNG, JPEG, WebP or GIF up to 5 MB, cropped to a 512 pixel square, stored as JPEG or PNG and shown for the address in OpenEmail in place of the domain logo. The type is read from `options.contentType`, or from a `Blob`'s own type when that is left out, and without either the server refuses the bytes with 422 `invalid_image`. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `data` (`RawBody`, required): The image: a `Blob`, `ArrayBuffer` or `Uint8Array`. - `options.contentType` (`ContactPhotoType`): `image/png`, `image/jpeg`, `image/webp` or `image/gif`. Required unless `data` is a `Blob` with a type. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainAddressResource` with the new `photoUrl`. **Example** ```ts const file = Bun.file('support.jpg') const address = await openemail.domains.setAddressPhoto('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70', await file.arrayBuffer(), { contentType: 'image/jpeg' }) console.log(address.photoUrl) ``` **Notes** - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - A busy image service answers 503 `image_busy` and a failed save 502 `image_not_stored`, which the SDK retries like any other retryable status. Also available in: API [`PUT /domains/{id}/addresses/{addressId}/photo`](https://openemail.uk/docs/api/reference/domains#put-domains-id-addresses-addressid-photo); CLI [`openemail domains set-address-photo`](https://openemail.uk/docs/cli/reference/domains#domains-set-address-photo). ### `domains.removeAddressPhoto()` Remove the photo of an address ```ts removeAddressPhoto(id: string, addressId: string, options?: RequestScope): Promise ``` Removes the photo of the address and deletes the stored image, so the domain logo is shown for it again. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainAddressResource` with `photoUrl` null. **Example** ```ts await openemail.domains.removeAddressPhoto('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70') ``` **Notes** - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - Removing a photo from an address that has none changes nothing, so the SDK retries it after a network failure. Also available in: API [`DELETE /domains/{id}/addresses/{addressId}/photo`](https://openemail.uk/docs/api/reference/domains#delete-domains-id-addresses-addressid-photo); CLI [`openemail domains remove-address-photo`](https://openemail.uk/docs/cli/reference/domains#domains-remove-address-photo). ### `domains.deleteAddress()` Remove an address from a domain ```ts deleteAddress(id: string, addressId: string, options?: RequestScope): Promise ``` Removes the address. Mail to it is refused from then on, even when the catch-all on the domain is on. Its forwarding stops, its settings are deleted, the people who were given access to it lose that access, and its password sign-in is revoked. Mail it already received stays in the mailbox. Creating the same address again with `createAddress` brings it back with the same id, enabled, but without its old settings or access. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DeletedDomainAddressResource`, `{ object: 'address', id, address, deleted: true }`. **Example** ```ts const removed = await openemail.domains.deleteAddress('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70') console.log(removed.address, removed.deleted) ``` **Notes** - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - An access token acting for a member also needs `workspace:manage` in that member's role, as removing one in the app does. It is console-only, so no approval can give it to an app, and without it the call is refused with 403 `insufficient_authority`. - The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked. Also available in: API [`DELETE /domains/{id}/addresses/{addressId}`](https://openemail.uk/docs/api/reference/domains#delete-domains-id-addresses-addressid); CLI [`openemail domains delete-address`](https://openemail.uk/docs/cli/reference/domains#domains-delete-address). ### `domains.listAddressForwards()` List where the mail of an address is forwarded ```ts listAddressForwards(id: string, addressId: string, options?: RequestScope): Promise ``` Returns every place the mail of the address is forwarded to, oldest first, as the Forwarding section of the address in the app lists them. Each destination says whether it is switched on (`enabled`) and where it stands (`status`): only a `live` destination, one that confirmed by email that it wants this mail, receives anything. `destination` on the list says whether the address also keeps a copy of its mail here (`mailbox`) or only forwards it (`forward`), and `max` is how many destinations one address may have. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `AddressForwardListResource`: `address`, `destination`, `max` and the destinations in `data`. **Example** ```ts const forwards = await openemail.domains.listAddressForwards('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70') for (const forward of forwards.data) console.log(forward.email, forward.status) ``` **Notes** - An address id that is not on this domain, or an address that was removed, is a 404 `resource_not_found`, and so is a domain from another workspace. - A GET is retried automatically on network failure and on 408, 429 and 5xx responses, up to the client `maxRetries`. Also available in: API [`GET /domains/{id}/addresses/{addressId}/forwards`](https://openemail.uk/docs/api/reference/domains#get-domains-id-addresses-addressid-forwards); CLI [`openemail domains list-address-forwards`](https://openemail.uk/docs/cli/reference/domains#domains-list-address-forwards). ### `domains.addAddressForwards()` Forward the mail of an address to more places ```ts addAddressForwards(id: string, addressId: string, body: AddressForwardsAdd, options?: RequestScope): Promise ``` Adds places the mail of the address goes to, as adding a destination in the app does. Each new destination is sent an email asking it to confirm, and receives nothing until it does, so it comes back `pending` and turns `live` once its owner confirms. An address hosted here, one already on the list, one that would make a loop, one past the limit of 10 and one that refused mail from this workspace before are not added. Each is named in `skipped` with the reason, and the rest are still added. The address keeps a copy of its mail here as before. To stop keeping one, set `destination` to `forward` with `updateAddress` once a destination is switched on. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `body.emails` (`Array`, required): The addresses to forward to, 1 to 10 of them. Each is trimmed and lowercased. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `AddressForwardsAddedResource`: the destinations added in `added`, and every address that was not, with the reason, in `skipped`. **Example** ```ts const result = await openemail.domains.addAddressForwards('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70', { emails: ['ops@partner.example'] }) console.log(result.added.map((forward) => forward.status), result.skipped) ``` **Notes** - An address that is switched off is refused with 409 `address_disabled`. Switch it on with `updateAddress` first. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. An access token acting for a member can only change the forwarding of an address that member reaches, or it is refused with 403 `insufficient_authority`. - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - Not retried automatically by the SDK, since a lost attempt may already have asked a destination to confirm. Also available in: API [`POST /domains/{id}/addresses/{addressId}/forwards`](https://openemail.uk/docs/api/reference/domains#post-domains-id-addresses-addressid-forwards); CLI [`openemail domains add-address-forwards`](https://openemail.uk/docs/cli/reference/domains#domains-add-address-forwards). ### `domains.updateAddressForward()` Pause a forwarding destination or switch it back on ```ts updateAddressForward(id: string, addressId: string, forwardId: string, patch: AddressForwardPatch, options?: RequestScope): Promise ``` `enabled` false pauses the destination: nothing is forwarded to it until it is switched on again. It keeps its confirmation, so switching it back on needs no new one, and switching it on clears the failures recorded against it. When the last destination that is on is paused, the address goes back to keeping its mail here. `destination` in the result says where the mail of the address goes now. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `forwardId` (`string`, required): A destination id from `listAddressForwards` or `addAddressForwards`. It has to be a destination of the address named by `addressId`. - `patch.enabled` (`boolean`, required): False pauses the destination, true switches it back on. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `AddressForwardChangeResource`: the destination as it is now, with `destination` for the address. **Example** ```ts const forward = await openemail.domains.updateAddressForward('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70', '5e8f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b', { enabled: false }) console.log(forward.status, forward.destination) ``` **Notes** - A destination id that is not on this address is a 404 `resource_not_found`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. An access token acting for a member can only change the forwarding of an address that member reaches, or it is refused with 403 `insufficient_authority`. - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - Retried automatically on network failure, since the same patch sent twice leaves the same destination. Also available in: API [`PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId}`](https://openemail.uk/docs/api/reference/domains#patch-domains-id-addresses-addressid-forwards-forwardid); CLI [`openemail domains update-address-forward`](https://openemail.uk/docs/cli/reference/domains#domains-update-address-forward). ### `domains.deleteAddressForward()` Stop forwarding to a destination ```ts deleteAddressForward(id: string, addressId: string, forwardId: string, options?: RequestScope): Promise ``` Removes the destination, so nothing more is forwarded to it. When it was the last destination that was on, the address goes back to keeping its mail here, and `destination` in the result says where the mail of the address goes now. To stop forwarding for a while instead, pause the destination with `updateAddressForward`, which keeps its confirmation. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `forwardId` (`string`, required): A destination id from `listAddressForwards` or `addAddressForwards`. It has to be a destination of the address named by `addressId`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DeletedAddressForwardResource`, `{ object: 'address_forward', id, addressId, email, deleted: true, destination }`. **Example** ```ts const removed = await openemail.domains.deleteAddressForward('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70', '5e8f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b') console.log(removed.email, removed.destination) ``` **Notes** - A destination id that is not on this address is a 404 `resource_not_found`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. An access token acting for a member can only change the forwarding of an address that member reaches, or it is refused with 403 `insufficient_authority`. - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - Not retried by the SDK. Repeating a delete that succeeded is a 404. Also available in: API [`DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId}`](https://openemail.uk/docs/api/reference/domains#delete-domains-id-addresses-addressid-forwards-forwardid); CLI [`openemail domains delete-address-forward`](https://openemail.uk/docs/cli/reference/domains#domains-delete-address-forward). ### `domains.resendAddressForwardConsent()` Ask a forwarding destination to confirm again ```ts resendAddressForwardConsent(id: string, addressId: string, forwardId: string, options?: RequestScope): Promise ``` Sends the confirmation email to the destination once more, for when the first one was lost or ignored. `status` says what became of the request: `sent`, `already-confirmed` when the destination has confirmed and needs nothing, `too-soon` when the last email went out moments ago, `revoked` when the destination refused mail from this workspace, and `send-failed` when the email could not be sent. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `forwardId` (`string`, required): A destination id from `listAddressForwards` or `addAddressForwards`. It has to be a destination of the address named by `addressId`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `AddressForwardConsentResource` with the `status` of the request. **Example** ```ts const asked = await openemail.domains.resendAddressForwardConsent('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70', '5e8f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b') if (asked.status === 'too-soon') console.log('Wait a moment before asking again.') ``` **Notes** - A destination id that is not on this address is a 404 `resource_not_found`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. An access token acting for a member can only change the forwarding of an address that member reaches, or it is refused with 403 `insufficient_authority`. - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - Not retried automatically by the SDK, since every attempt can send an email. Also available in: API [`POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resend`](https://openemail.uk/docs/api/reference/domains#post-domains-id-addresses-addressid-forwards-forwardid-resend); CLI [`openemail domains resend-address-forward-consent`](https://openemail.uk/docs/cli/reference/domains#domains-resend-address-forward-consent). ### `domains.listAddressMembers()` List who can reach an address ```ts listAddressMembers(id: string, addressId: string, options?: RequestScope): Promise ``` Returns everybody who can read the mail of the address and how each one reaches it, in `via`: `owner` for the owner of the workspace, `every-address` for a role that reaches every address, `whole-domain` for a grant of the whole domain named in `viaDomain`, and `direct` for a grant of the address itself. Each person appears once. `access` is `member` for somebody who reads and sends from the address and `viewer` for somebody who only reads it. `removable` is true for a grant of the address itself, which `members.revokeAddress` takes back. The others come from the role or a domain grant, and change there. Scopes: `members:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `AddressMemberListResource`, with the people in `data`. **Example** ```ts const reach = await openemail.domains.listAddressMembers('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70') for (const person of reach.data) console.log(person.email, person.access, person.via) ``` **Notes** - An address id that is not on this domain, or an address that was removed, is a 404 `resource_not_found`, and so is a domain from another workspace. - A GET is retried automatically on network failure and on 408, 429 and 5xx responses, up to the client `maxRetries`. Also available in: API [`GET /domains/{id}/addresses/{addressId}/members`](https://openemail.uk/docs/api/reference/domains#get-domains-id-addresses-addressid-members); CLI [`openemail domains list-address-members`](https://openemail.uk/docs/cli/reference/domains#domains-list-address-members). ### `domains.getAddressLogin()` Read the password sign-in of an address ```ts getAddressLogin(id: string, addressId: string, options?: RequestScope): Promise ``` Says whether the address has a password of its own, which lets somebody sign in to OpenEmail as that address alone and read and send only its mail. `login` is null when it has none, and otherwise says who set the password and when, and when it was last used to sign in. Scopes: `members:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `AddressLoginResource`, with `login` null when the address has no password. **Example** ```ts const { login } = await openemail.domains.getAddressLogin('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70') console.log(login ? login.lastSignedInAt : 'no password') ``` **Notes** - It needs `members:write`, the scope that sets a password, as the app does, rather than a read scope. - An address id that is not on this domain, or an address that was removed, is a 404 `resource_not_found`, and so is a domain from another workspace. - A key limited to particular addresses or domains is refused with 422 `capability_unsupported`. An access token acting for a member can only reach the sign-in of an address that member reaches, or it is refused with 403 `insufficient_authority`. - A GET is retried automatically on network failure and on 408, 429 and 5xx responses, up to the client `maxRetries`. Also available in: API [`GET /domains/{id}/addresses/{addressId}/login`](https://openemail.uk/docs/api/reference/domains#get-domains-id-addresses-addressid-login); CLI [`openemail domains get-address-login`](https://openemail.uk/docs/cli/reference/domains#domains-get-address-login). ### `domains.setAddressLogin()` Give an address a password, or replace it ```ts setAddressLogin(id: string, addressId: string, body: AddressLoginSet, options?: RequestScope): Promise ``` Sets the password somebody uses to sign in to OpenEmail as this address alone. Whoever holds it reads and sends only the mail of the address and reaches nothing else in the workspace. OpenEmail sends the password to nobody, so hand it over yourself. Calling it again replaces the password, signs out everybody who signed in with the old one and removes the forwarding destinations they added. `created` says whether the sign-in is new. Scopes: `members:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `body.password` (`string`, required): At least 8 characters, with a lowercase letter, an uppercase letter, a number and a special character. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `AddressLoginResource` as it stands after the change, with `created`. **Example** ```ts const result = await openemail.domains.setAddressLogin('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70', { password: process.env.SUPPORT_INBOX_PASSWORD ?? '' }) console.log(result.created ? 'Sign-in created' : 'Password replaced') ``` **Notes** - A password that misses a rule is a 422 `invalid_parameter` on `password`. An address an OpenEmail account already signs in as is refused with 409 `account_exists`, so invite that account to the workspace instead, and an address that is switched off is refused with 409 `address_unavailable`. - The first password on a workspace whose plan has no team access is refused with 403 `plan_required`. - A key or an access token has to hold every scope a sign-in for one address may use, or it is refused with 403 `insufficient_authority`. A key limited to particular addresses or domains is refused with 422 `capability_unsupported`, and an access token acting for a member can only set the password of an address that member reaches with `member` access. - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - Not retried automatically by the SDK. Also available in: API [`PUT /domains/{id}/addresses/{addressId}/login`](https://openemail.uk/docs/api/reference/domains#put-domains-id-addresses-addressid-login); CLI [`openemail domains set-address-login`](https://openemail.uk/docs/cli/reference/domains#domains-set-address-login). ### `domains.deleteAddressLogin()` Remove the password sign-in of an address ```ts deleteAddressLogin(id: string, addressId: string, options?: RequestScope): Promise ``` Takes the password away and signs out everybody who signed in with it. The address, its mail and the people who reach it otherwise stay as they are, and the forwarding destinations added by whoever signed in as the address are removed with it. Scopes: `members:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `addressId` (`string`, required): Address id from `listAddresses` or `createAddress`, a UUID. It has to be an address on the domain named by `id`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DeletedAddressLoginResource`, `{ object: 'address_login', addressId, address, deleted: true }`. **Example** ```ts const removed = await openemail.domains.deleteAddressLogin('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', '7c9d2e41-0b8f-4a63-9e25-1f4d6a8b3c70') console.log(removed.address, removed.deleted) ``` **Notes** - An address with no password is a 404. - A key limited to particular addresses or domains is refused with 422 `capability_unsupported`. An access token acting for a member can only reach the sign-in of an address that member reaches, or it is refused with 403 `insufficient_authority`. - Not retried by the SDK. Repeating a delete that succeeded is a 404. Also available in: API [`DELETE /domains/{id}/addresses/{addressId}/login`](https://openemail.uk/docs/api/reference/domains#delete-domains-id-addresses-addressid-login); CLI [`openemail domains delete-address-login`](https://openemail.uk/docs/cli/reference/domains#domains-delete-address-login). ### `domains.getDns()` Read how the DNS of a domain is set up ```ts getDns(id: string, options?: DomainDnsOptions): Promise ``` Returns whether OpenEmail writes the records of the domain itself (`managing`), through which connection and zone, where each kind of record stands in `steps`, and the records left behind to delete by hand. `zone` says which connected zone answers for the domain: one is `resolved`, several are `ambiguous` and need `setDnsZone`, `none` holds it, with the reason, or the connections could not be asked (`unusable`). The answer is kept for a few minutes, and `refresh` asks the providers again. Scopes: `domains:read`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `options.refresh` (`boolean`): True asks the providers again which zone answers for the domain. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainDnsResource`. **Example** ```ts const dns = await openemail.domains.getDns('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', { refresh: true }) console.log(dns.managing, dns.state, dns.zone.kind) ``` **Notes** - A domain id that is not in this workspace is a 404 `resource_not_found`. - A GET is retried automatically on network failure and on 408, 429 and 5xx responses, up to the client `maxRetries`. Also available in: API [`GET /domains/{id}/dns`](https://openemail.uk/docs/api/reference/domains#get-domains-id-dns); CLI [`openemail domains get-dns`](https://openemail.uk/docs/cli/reference/domains#domains-get-dns). ### `domains.setDnsZone()` Choose the zone a domain is set up through ```ts setDnsZone(id: string, body: DomainDnsZoneSet, options?: RequestScope): Promise ``` Attaches the domain to a zone of a connection, when several connected zones could answer for it. The zone has to cover the domain, be active at the provider and take a test record. Nothing is written yet: call `syncDns` to write the records. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `body.connectionId` (`string`, required): The connection that holds the zone, from `dnsConnections.list`. - `body.zoneId` (`string`, required): The zone, as `zone.candidates` of `getDns` lists it. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainDnsResource` as it stands after the change. **Example** ```ts const dns = await openemail.domains.getDns('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') const [choice] = dns.zone.candidates if (choice) await openemail.domains.setDnsZone('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f', { connectionId: choice.connectionId, zoneId: choice.zone.id }) ``` **Notes** - A zone that does not cover the domain is a 422 `invalid_parameter` on `zoneId`. A domain already set up through another zone is refused with 409 `dns_zone_conflict`, a zone that is not active or refuses the test record with 409 `dns_zone_unusable`, and a connection that was disconnected with 409 `dns_connection_unusable`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - Not retried by the SDK. Also available in: API [`PUT /domains/{id}/dns`](https://openemail.uk/docs/api/reference/domains#put-domains-id-dns); CLI [`openemail domains set-dns-zone`](https://openemail.uk/docs/cli/reference/domains#domains-set-dns-zone). ### `domains.syncDns()` Write the DNS records of a domain ```ts syncDns(id: string, body?: DomainDnsSync, options?: RequestScope): Promise ``` Writes or repairs every record the domain needs through the connected zone that answers for it, as Sync does in the app. When exactly one zone answers it is attached first, and `attached` says so. With `purpose`, only that kind of record is written. A domain that was waiting for its records is verified once they are in place. When no single zone answers, nothing is written: `outcome` is `refused`, `message` says why and `zone` shows the zones to choose from with `setDnsZone`. Scopes: `domains:write`. **Parameters** - `id` (`string`, required): Domain id from `list` or `create`, a UUID. - `body.purpose` (`DnsSyncPurpose`): Only this kind of record: `dmarc`, `tracking`, `storage`, `bimi` or `app-host`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainDnsSyncResource` with `outcome`, the `provision` that ran and the DNS setup as it is now in `dns`. **Example** ```ts const sync = await openemail.domains.syncDns('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') if (sync.outcome === 'refused') console.log(sync.message) else console.log(sync.provision?.written) ``` **Notes** - A sync already running on the domain is refused with 409 `dns_busy`. A provider that refuses the request is a 502 `dns_provider_error`. - A key limited to particular addresses or domains has to hold this whole domain in its `domainAllowlist`, or the call is refused with 422 `capability_unsupported` on `domainAllowlist`. - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - Not retried by the SDK. Also available in: API [`POST /domains/{id}/dns/sync`](https://openemail.uk/docs/api/reference/domains#post-domains-id-dns-sync); CLI [`openemail domains sync-dns`](https://openemail.uk/docs/cli/reference/domains#domains-sync-dns).