Email hosting
Mailboxes on your own domain, and the webmail that reads them.
Real mailboxes with IMAP, SMTP and webmail. Provision them for a domain with your organization API key; read and send their mail with a mailbox token, which acts as one person rather than as the organization.
If you have used Zoho Mail, Google Workspace or Microsoft 365, this is the part you know.
Guides
Start here. The reference tells you what the parameters are; these tell you what to do with them.
Reference110 endpoints
Provision mailboxes, aliases and forwarding for a domain.
- GETList email accounts
/api/v1/email-accounts - POSTCreate a mailbox
/api/v1/email-accounts - GETRetrieve a email account
/api/v1/email-accounts/{email_account} - POSTBulk Update (email account)
/api/v1/email-accounts/bulk-update - PUTUpdate a email account
/api/v1/email-accounts/{email_account} - All 12 mailboxes endpoints →
Operations for mailbox aliases & routing.
- GETList a mailbox's aliases
/api/v1/email-accounts/{account}/aliases - GETList forwarding rules
/api/v1/email-accounts/{account}/forwarding-rules - POSTAdd an alias
/api/v1/email-accounts/{account}/aliases - POSTCreate a forwarding rule
/api/v1/email-accounts/{account}/forwarding-rules - PUTUpdate a forwarding rule
/api/v1/email-accounts/{account}/forwarding-rules/{rule} - All 8 mailbox aliases & routing endpoints →
Everything the webmail does, for one mailbox. Takes a mailbox token, not an organization API key.
Operations for mailbox auth & security.
- GETRead security settings
/api/v1/mailbox/security - POSTGet a mailbox token
/api/v1/mailbox-auth/login - POSTSign out (revoke the token)
/api/v1/mailbox-auth/logout - GETList signed-in devices
/api/v1/mailbox/security/sessions - POSTChange the password
/api/v1/mailbox/security/password - All 9 mailbox auth & security endpoints →
Operations for mailbox messages.
Operations for mailbox folders.
Operations for mailbox contacts.
- GETSuggest recipients
/api/v1/mailbox/contacts - GETList address books
/api/v1/mailbox/address-book/books - GETList saved contacts
/api/v1/mailbox/address-book/contacts - POSTSave a contact
/api/v1/mailbox/address-book/contacts - GETRead a contact
/api/v1/mailbox/address-book/contacts/{card_id} - All 7 mailbox contacts endpoints →
Operations for mailbox calendars.
- GETList calendar subscription links
/api/v1/mailbox/calendar-subscriptions - GETList calendars
/api/v1/mailbox/calendars - POSTCreate a subscription link
/api/v1/mailbox/calendar-subscriptions - GETList invitations to answer
/api/v1/mailbox/calendar/invitations - GETList rooms and equipment
/api/v1/mailbox/calendar/rooms - All 13 mailbox calendars endpoints →
Operations for mailbox ai.
Operations for mailbox settings.
Organization-wide rules applied to mail in transit.