## domains connect Get Domain Connect setup. Discovers whether the domain’s DNS provider supports Domain Connect (TXT _domainconnect. and the provider’s /v2//settings) and has onboarded the MachineMail template (machinemail.dev/email). When it has, apply_url is a signed synchronous-flow link (RS256, key=_dck1, sig last) that opens the provider with the outstanding MX, SPF, DKIM and DMARC records prefilled. Discovery is cached on the domain (6 h; provider errors 10 min) and re-run by Verify Domain. Requires the domain_read permission. ```shell machinemail domains connect [flags] ``` ### Arguments | Field | Description | |--------------|------------------------------| | ``| `string` Required ID of the domain. | ### Flags | Field | Description | |------------------------|-----------------------------------------------------------------------------| | `--pod ` | `string` Only this pod. | ### Examples ```shell machinemail domains connect dom_01m4fz9w5k0000h3n8c2q7t4ra machinemail domains connect dom_01m4fz9w5k0000h3n8c2q7t4ra --pod pod_01m4fykg210000x6z8b6wc2rdx ``` ### API - [`GET /v0/domains/{domain_id}/domain-connect`](/content/docs/reference/api/domains#get-domain-connect-setup/index.html) - [`GET /v0/pods/{pod_id}/domains/{domain_id}/domain-connect`](/content/docs/reference/api/domains#get-domain-connect-setup-in-pod/index.html) with `--pod` ## domains create Create domain. Registers the domain and returns the DNS records to publish (status: NOT_STARTED). Publish them, then call Verify Domain. A background worker re-checks PENDING, INVALID and VERIFYING domains about every 5 minutes until 7 days after creation; a NOT_STARTED domain is only checked by Verify Domain. A domain that is never verified is removed 14 days after it was added, together with its inboxes and the mail in them; owners and admins of the organization are emailed at least 3 days before. A domain that was verified once is never removed this way. A domain can be registered by one organization only (409), and the shared domain cannot be added (409). Inbox-scoped credentials cannot add domains (403). allow_conflicting_provider, subdomains_enabled and tracking_enabled are not supported. 502 upstream_error when the email provider cannot register the domain (for example its domain capacity is reached, or it is rate limiting registrations): nothing is created. Requires the domain_create permission. ```shell machinemail domains create [flags] ``` ### Flags | Field | Description | |---------------------------|-----------------------------------------------------------------------------------------------------| | `--pod ` | `string` Create it in this pod. | | `--domain ` | `string` The domain name, for example example.com. Cannot be the shared domain or a domain another organization registered. | | `--feedback-enabled` | `boolean` Stored and returned; has no effect. Default false. | | `--inbound-enabled` | `boolean` Receive email for this domain. Default true. false makes it send-only (the inbound MX record is not required). | | `--client-id ` | `string` Idempotency key: a create with a --client-id already used in the organization returns that domain with 200, or 409 when that domain is outside the pod of the API key or route. | | `--catch-all` | `boolean` Create an inbox for any address at the domain that receives mail. Default false. | | `--catch-all-ttl-seconds `| `integer | null` Make inboxes created by catch-all ephemeral with this TTL. null or absent: permanent. | | `-d, --data `| `string` Request body as JSON, @file or - for stdin; field flags override its keys. | ### Examples ```shell machinemail domains create --domain mail.example.com machinemail domains zone-file mail.example.com > zone.txt machinemail domains create --domain mail.example.com --pod pod_01m4fykg210000x6z8b6wc2rdx machinemail domains create --data @body.json ``` ### API - [`POST /v0/domains`](/content/docs/reference/api/domains#create-domain/index.html) - [`POST /v0/pods/{pod_id}/domains`](/content/docs/reference/api/domains#create-domain-in-pod/index.html) with `--pod` ## domains delete Delete domain. Also: `machinemail domains rm`. Inboxes on the domain are not deleted. Requires the domain_delete permission. ```shell machinemail domains delete [flags] ``` ### Arguments | Field | Description | |--------------|-------------------------------| | ``| `string` Required ID of the domain. | ### Flags | Field | Description | |---------------------------|--------------------------------------------------| | `--pod ` | `string` Use this pod's scoped route. | ### Examples ```shell machinemail domains delete dom_01m4fz9w5k0000h3n8c2q7t4ra machinemail domains delete dom_01m4fz9w5k0000h3n8c2q7t4ra --pod pod_01m4fykg210000x6z8b6wc2rdx ``` ### API - [`DELETE /v0/domains/{domain_id}`](/content/docs/reference/api/domains#delete-domain/index.html) - [`DELETE /v0/pods/{pod_id}/domains/{domain_id}`](/content/docs/reference/api/domains#delete-domain-in-pod/index.html) with `--pod` ## domains get Get domain. Requires the domain_read permission. ```shell machinemail domains get [flags] ``` ### Arguments | Field | Description | |--------------|-------------------------------| | ``| `string` Required ID of the domain. | ### Flags | Field | Description | |---------------------------|--------------------------------------------------| | `--pod ` | `string` Only this pod. | ### Examples ```shell machinemail domains get dom_01m4fz9w5k0000h3n8c2q7t4ra machinemail domains get dom_01m4fz9w5k0000h3n8c2q7t4ra --pod pod_01m4fykg210000x6z8b6wc2rdx ``` ### API - [`GET /v0/domains/{domain_id}`](/content/docs/reference/api/domains#get-domain/index.html) - [`GET /v0/pods/{pod_id}/domains/{domain_id}`](/content/docs/reference/api/domains#get-domain-in-pod/index.html) with `--pod` ## domains list List domains. Also: `machinemail domains ls`. Requires the domain_read permission. ```shell machinemail domains list [flags] ``` ### Flags | Field | Description | |---------------------------|-------------------------------------------------| | `--pod ` | `string` Only this pod. | | `--limit ` | `integer` Maximum number of items to return. Default 50, maximum 500; larger values are capped. | | `--page-token ` | `string` next_page_token from the previous page. | | `--ascending` | `boolean` Sort oldest first. | | `--all` | `boolean` Follow next_page_token and return every page. | ### Examples ```shell machinemail domains list machinemail domains list --pod pod_01m4fykg210000x6z8b6wc2rdx machinemail domains list --all --json | jq '.domains | length' ``` ### API - [`GET /v0/domains`](/content/docs/reference/api/domains#list-domains/index.html) - [`GET /v0/pods/{pod_id}/domains`](/content/docs/reference/api/domains#list-domains-in-pod/index.html) with `--pod` ## domains update Update domain. Fields you omit are unchanged. subdomains_enabled and tracking_enabled are not supported. Requires the domain_update permission. ```shell machinemail domains update [flags] ``` ### Arguments | Field | Description | |--------------|-------------------------------| | ``| `string` Required ID of the domain. | ### Flags | Field | Description | |---------------------------|-----------------------------------------------| | `--pod ` | `string` Use this pod's scoped route. | | `--feedback-enabled` | `boolean` Stored and returned; has no effect. | | `--inbound-enabled` | `boolean` Receive email for this domain. false makes the inbound MX record optional and re-evaluates the status. | | `--catch-all` | `boolean` Create an inbox for any address at the domain that receives mail. | | `--catch-all-ttl-seconds `| `integer | null` TTL of inboxes created by catch-all from now on. null makes them permanent. null clears the value. | | `-d, --data `| `string` Request body as JSON, @file or - for stdin; field flags override its keys. | ### Examples ```shell machinemail domains update dom_01m4fz9w5k0000h3n8c2q7t4ra machinemail domains update dom_01m4fz9w5k0000h3n8c2q7t4ra --pod pod_01m4fykg210000x6z8b6wc2rdx machinemail domains update dom_01m4fz9w5k0000h3n8c2q7t4ra --data @body.json machinemail domains update dom_01m4fz9w5k0000h3n8c2q7t4ra --catch-all-ttl-seconds null # clears catch-all-ttl-seconds ``` ### API - [`PATCH /v0/domains/{domain_id}`](/content/docs/reference/api/domains#update-domain/index.html) - [`PATCH /v0/pods/{pod_id}/domains/{domain_id}`](/content/docs/reference/api/domains#update-domain-in-pod/index.html) with `--pod` ## domains verify Verify domain. Checks every DNS record now, updates records[].status and status, and re-runs Domain Connect discovery. A domain.verified event is emitted when the domain becomes VERIFIED. Requires the domain_update permission. ```shell machinemail domains verify [flags] ``` ### Arguments | Field | Description | |--------------|-------------------------------| | ``| `string` Required ID of the domain. | ### Flags | Field | Description | |---------------------------|-----------------------------------------------| | `--pod ` | `string` Use this pod's scoped route. | ### Examples ```shell machinemail domains verify dom_01m4fz9w5k0000h3n8c2q7t4ra machinemail domains verify dom_01m4fz9w5k0000h3n8c2q7t4ra --pod pod_01m4fykg210000x6z8b6wc2rdx ``` ### API - [`POST /v0/domains/{domain_id}/verify`](/content/docs/reference/api/domains#verify-domain/index.html) - [`POST /v0/pods/{pod_id}/domains/{domain_id}/verify`](/content/docs/reference/api/domains#verify-domain-in-pod/index.html) with `--pod` ## domains zone-file Get zone file. Requires the domain_read permission. ```shell machinemail domains zone-file [flags] ``` ### Arguments | Field | Description | |--------------|-------------------------------| | ``| `string` Required ID of the domain. | ### Flags | Field | Description | |---------------------------|-----------------------------------| | `--pod ` | `string` Only this pod. | | `-o, --output `| `string` Write the body to this file (a directory keeps the server's filename; - is stdout) and report the path. | ### Examples ```shell machinemail domains zone-file dom_01m4fz9w5k0000h3n8c2q7t4ra machinemail domains zone-file dom_01m4fz9w5k0000h3n8c2q7t4ra --pod pod_01m4fykg210000x6z8b6wc2rdx ``` ### API - [`GET /v0/domains/{domain_id}/zone-file`](/content/docs/reference/api/domains#get-zone-file/index.html) - [`GET /v0/pods/{pod_id}/domains/{domain_id}/zone-file`](/content/docs/reference/api/domains#get-zone-file-in-pod/index.html) with `--pod`