Organization API: Org Mail: Mail

Part of Org Mail.

GET /api/v1/orgs/{org_slug}/mail/overview

The Email tiles, counted over the tenants the list shows: tenants, sending_frozen, under_review, domains_pending and kinds (hosting and relay), whatever the list is filtered by.

GET /api/v1/orgs/{org_slug}/mail/tenants

The organization's mail tenants but the terminated ones, newest first.

Every filter runs in SQL before the page is cut, so total is how many tenants match them all, however many pages that is. counts are the state filter's numbers for the other filters (all, frozen, review and one per status) and kinds the product filter's (one per kind), so each select can say how many rows each choice holds.

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases

application/json (required)

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/aliases/{account_id}

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/category

application/json (required)

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials

application/json (required)

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}/enabled

application/json (required)

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/credentials/{account_id}/rotate

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains

application/json (required)

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/dmarc

application/json (required)

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/records

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/domains/{domain_id}/verify

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/events

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/limits/increase-request

application/json (required)

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes

application/json (required)

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords

application/json (required)

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/app-passwords/{credential_id}

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/enabled

application/json (required)

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports

application/json (required)

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/oauth

application/json (required)

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/upload

multipart/form-data (required)

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/imports/{import_id}/{action}

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/password

application/json (required)

PATCH /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/quota

application/json (required)

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/sessions/{session_id}

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/totp

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/mailboxes/{account_id}/totp

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/messages

application/json (required)

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/migrations

List the service's migrations.

The last 20, newest first, each with every mailbox's latest import and the totals.

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/migrations/cpanel

Move a cPanel account's mail here.

Nothing changes until every check holds: the account answers, the plan has room for the new mailboxes and their quotas, the old server's IMAP answers over TLS on port 993, and each old mailbox password given signs in. Then each new mailbox is made with a new password, returned once in passwords; forwarders to mailboxes here become aliases; and an import starts into each mailbox from the old server. With reset_passwords, an old mailbox given no password gets a new one on the old server, so mail apps signed in there stop working. Answers 422 with migration_invalid, plan_full, plan_storage, imap_unreachable or source_refused and changes nothing, and 429 after 10 migrations or syncs in a day.

application/json (required)

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/migrations/cpanel/discover

Find what a cPanel account holds and what moving it here would do.

Signs in to the account's cPanel API and changes nothing: each email account, with how much it holds and whether it becomes a new mailbox, goes into one already here, or cannot move yet and why; each forwarder and whether it becomes an alias; each domain's default address; the autoresponders; and whether the plan has room. Sign in with an API token, or with the cPanel password when the account has no two-factor sign-in. Answers 422 with cpanel_refused, cpanel_unreachable or cpanel_empty when the account cannot be read, and 429 after 30 tries in an hour.

application/json (required)

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/migrations/{migration_id}

Get one migration and how far each of its mailboxes has got.

Where its mail came from, each mailbox with its latest import, the aliases made and what did not move, and whether it still keeps the old mailboxes' passwords for another pass.

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/migrations/{migration_id}/finish

Finish a migration and forget the old mailboxes' passwords.

The migration keeps them for another pass until then. Imports under way go on to the end. We forget them 30 days after the migration started in any case.

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/migrations/{migration_id}/sync

Bring in what reached the old mailboxes since the migration started.

Run it once the domain's MX records point here. A paused import goes on, one under way is left alone, and any other starts again from the kept password. Messages already brought are not brought twice. Answers 409 migration_finished once the passwords are forgotten.

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/reputation

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions

application/json (required)

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/suppressions/{suppression_id}

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/usage