API keys

This page is for whoever connects another program to a mailbox — a script, a web form, or another system you run — not for day-to-day email use. Each mailbox can have its own key for sending mail from outside this app this way. Your account owner, or a domain manager for that mailbox's domain, can generate or rotate these.

Creating a key

In the admin panel, open API Script Generator, pick a mailbox and a script format (cURL or Python), and a ready-to-use script is shown using that mailbox's current key. If the mailbox has no key yet, select Create a new key to generate one.

The full key is shown to you once, right when it's created or rotated — copy it then. After that this app only shows a short prefix of it; the key itself is stored hashed and can't be displayed again.

Rotating a key

Select Create a new key again at any time. This immediately replaces the mailbox's current key — anything still using the old one stops working right away, so update whatever's using it with the new key before (or right after) you rotate.

Using a key

Send mail as that mailbox with a POST request to /api/emails/send, with the key in an X-API-Key header (or as a Bearer token in Authorization), and to, subject and body in the request (cc and bcc are optional). The generated script for each mailbox shows the exact request. Sending is limited to 120 messages per minute per key.