fn listDomains()
List every domain the credential can see (GET /domains). The
fn getDomain(name: string)
Fetch one domain (GET /domains/{name}). Read-only.
| Argument | Type | Required | Description |
|---|
| name | string | yes | |
fn getDomainRecords(name: string)
Fetch a domain's DNS/MX records (GET /domains/{name}/records).
| Argument | Type | Required | Description |
|---|
| name | string | yes | |
fn getDomainDiagnostics(name: string)
Fetch a domain's diagnostics (GET /domains/{name}/diagnostics).
| Argument | Type | Required | Description |
|---|
| name | string | yes | |
fn getDomainUsage(name: string)
Fetch a domain's usage (GET /domains/{name}/usage). Read-only.
| Argument | Type | Required | Description |
|---|
| name | string | yes | |
fn createDomain(items: array, dryRun?: boolean)
Fan out: create every domain in `items` (POST /domains).
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn updateDomain(items: array, dryRun?: boolean)
Fan out: update every domain in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn activateDomain(items: array, dryRun?: boolean)
Fan out: activate every domain in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn listMailboxes()
Fan out over every configured (or self-discovered) domain and list
fn getMailbox(domain: string, localPart: string)
Fetch one mailbox (GET /domains/{domain}/mailboxes/{localPart}). Read-only.
| Argument | Type | Required | Description |
|---|
| domain | string | yes | |
| localPart | string | yes | |
fn listAliases()
Fan out over every configured (or self-discovered) domain and list
fn listRewrites()
Fan out over every configured (or self-discovered) domain and list
fn listIdentities(domain: string, localPart: string)
Fan out over an explicit {domain, localPart}[] mailbox selection
| Argument | Type | Required | Description |
|---|
| domain | string | yes | |
| localPart | string | yes | |
fn listForwardings(domain: string, localPart: string)
Fan out over an explicit {domain, localPart}[] mailbox selection
| Argument | Type | Required | Description |
|---|
| domain | string | yes | |
| localPart | string | yes | |
fn getIdentity(domain: string, mailboxLocalPart: string, identityLocalPart: string)
Fetch one send-as identity
| Argument | Type | Required | Description |
|---|
| domain | string | yes | |
| mailboxLocalPart | string | yes | |
| identityLocalPart | string | yes | |
fn getAlias(domain: string, localPart: string)
Fetch one domain alias (GET /domains/{domain}/aliases/{localPart}).
| Argument | Type | Required | Description |
|---|
| domain | string | yes | |
| localPart | string | yes | The alias's local part |
fn getForwarding(domain: string, localPart: string, address: string)
Fetch one forwarding
| Argument | Type | Required | Description |
|---|
| domain | string | yes | |
| localPart | string | yes | |
| address | string | yes | The forwarding's target address |
fn getRewrite(domain: string, name: string)
Fetch one rewrite rule (GET /domains/{domain}/rewrites/{name}).
| Argument | Type | Required | Description |
|---|
| domain | string | yes | |
| name | string | yes | The rewrite rule's name |
fn upsertMailbox(items: array, dryRun?: boolean)
Fan out: create-or-update every mailbox in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn deleteMailbox(items: array, dryRun?: boolean)
Fan out: delete every mailbox in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn upsertIdentity(items: array, dryRun?: boolean)
Fan out: create-or-update every send-as identity in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn deleteIdentity(items: array, dryRun?: boolean)
Fan out: delete every send-as identity in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn upsertAlias(items: array, dryRun?: boolean)
Fan out: create-or-update every domain alias in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn deleteAlias(items: array, dryRun?: boolean)
Fan out: delete every domain alias in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn upsertForwarding(items: array, dryRun?: boolean)
Fan out: create-or-update every forwarding in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn deleteForwarding(items: array, dryRun?: boolean)
Fan out: delete every forwarding in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn upsertRewrite(items: array, dryRun?: boolean)
Fan out: create-or-update every rewrite rule in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn deleteRewrite(items: array, dryRun?: boolean)
Fan out: delete every rewrite rule in `items`
| Argument | Type | Required | Description |
|---|
| items | array | yes | |
| dryRun? | boolean | no | |
fn reconcileForwardings(dryRun?: boolean)
Read the declarative `desiredForwardings` global argument
| Argument | Type | Required | Description |
|---|
| dryRun? | boolean | no | |
Resources
domains(infinite)— The account's domain index (GET /domains)
domain(infinite)— One domain (GET /domains/{name})
domainRecords(infinite)— A domain's DNS/MX records (GET /domains/{name}/records)
domainDiagnostics(infinite)— A domain's diagnostics (GET /domains/{name}/diagnostics)
domainUsage(infinite)— A domain's usage (GET /domains/{name}/usage)
mailboxes(infinite)— A domain's mailboxes (GET /domains/{domain}/mailboxes)
mailbox(infinite)— One mailbox (GET /domains/{domain}/mailboxes/{localPart})
identity(infinite)— One send-as identity (GET .../mailboxes/{localPart}/identities/{identityLocalPart})
alias(infinite)— One domain alias (GET /domains/{domain}/aliases/{localPart})
forwarding(infinite)— One forwarding (GET .../mailboxes/{localPart}/forwardings/{address})
rewrite(infinite)— One rewrite rule (GET /domains/{domain}/rewrites/{name})
identities(infinite)— One mailbox's send-as identities (GET .../mailboxes/{localPart}/identities)
forwardings(infinite)— One mailbox's forwardings (GET .../mailboxes/{localPart}/forwardings)
aliases(infinite)— A domain's aliases (GET /domains/{domain}/aliases)
rewrites(infinite)— A domain's rewrite rules (GET /domains/{domain}/rewrites)
wouldAffect(infinite)— A dryRun=true preview of a gated write method's effect; NO mutation performed
applied(infinite)— The result of a gated write method executed with dryRun=false
reconcilePreview(infinite)— A dryRun=true diff of desiredForwardings vs. live forwardings; NO mutation performed
reconcileApplied(infinite)— The result of reconcileForwardings executed with dryRun=false