Hosting e-mail through the API: mailboxes, passwords, quotas, forwarders and the default address

The short answer: the API manages the e-mail of the active hosting plans in your account: mailboxes, passwords, quotas, forwarders, autoresponders and the default address, and it shows the status of SPF, DKIM and DMARC. You read with email:read and change with email:write. Everything runs on the hosting given in {id}, which you find with GET /v1/services.

Mailboxes

curl https://api.mozout.com/v1/services/123/email/mailboxes -X POST \
-H "Authorization: Bearer $RLX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"address": "info@yourcompany.com", "password": "...", "quota_mb": 1024}'

The password must be 12 to 128 characters, with at least 3 kinds among lowercase, uppercase, digits and symbols, and without the account or mailbox name. The API never stores or returns it. The quota runs from 1 MB up to the plan's disk space; unlimited is not accepted. Server system names, such as _mainaccount, are not accepted.

Forwarders, autoresponders and the default address

For the default address, action can be fail (bounce), forward, discard or main_account (deliver to the hosting's main account). We recommend fail, to receive less spam.

The domain of the account e-mail

Whoever controls the e-mail used to sign in to the account can take the account over, because that is where password resets and sign-in codes arrive. So, on that e-mail's domain, and on the domain of each account user's e-mail, the API does not create, delete or change mailboxes, does not create or delete forwarders and does not change the default address. It answers 409 account_email_domain, in Sandbox too. Reads and autoresponders keep working. Make those changes in My MozOut.

Limits and what is not there yet

Changes are limited to 20 per minute, per hosting account, and passwords to 10 per minute. E-mail filters and the delivery log are handled in cPanel. A service that is not active answers 409, as with hosting.