Connect your application

You do not need the API to use Emayler. For setup in the website, start with Set up your email.

1. Create an API key

Open API Keys in your dashboard and choose Generate key. Give the key a name you will recognise. Choose read for an integration that only retrieves information, or write if it needs to create or change anything. Copy the key and store it securely. See Create API keys.

2. Test your connection

Set EMAYLER_API_KEY in your server or terminal environment. Run this request to list your domains. Never put a key into a public website, screenshot or source repository.

curl https://api.emayler.com/v1/domains \
  -H "Authorization: Bearer $EMAYLER_API_KEY"

3. Choose a task

• Set up email through the API.
• Connect a domain and check its DNS.
• Create mailboxes and aliases.
• Read and send messages.
• Import an existing mailbox.
• Manage billing and account settings.

Retry a request safely

For requests that create or send something, include an Idempotency-Key header. Use a new unique value for each new action. If you retry the same action after a timeout, reuse its original value so the retry does not create another copy.

Retrieve more results

If a response includes next_cursor, pass that value as cursor in the next request. Repeat until no next cursor is returned.

If a request fails

For general account or email problems, see Troubleshooting.