What is the base URL?
All requests go to one HTTPS base URL. Plain HTTP is not supported.
https://api.tuskmail.africa/v1Requests and responses are JSON, except attachment uploads (multipart/form-data) and attachment downloads (binary).
What can I do with the API?
- Send an email, or save it as a draft, with text, HTML, cc, bcc and attachments.
- Reply to an existing message so it is threaded correctly.
- List folders, list and search messages, and read a full message.
- Mark messages read or starred, move them between folders, and delete them.
- Upload attachments and download attachments from received mail.
Each API key is bound to one user mailbox, so everything you do happens as that mailbox, with the same footer, folders and storage as in the TuskMail web app.
How is the API secured?
Every request carries two credentials: an API key in X-API-Key and the mailbox email plus an app password as HTTP Basic auth. Both are created by the mailbox owner in the web app. Read Authentication for the details.
- Base URL
https://api.tuskmail.africa/v1- Auth
- API key + HTTP Basic (mailbox email : app password)
- Rate limit
- 60 requests per minute and 1,000 sent messages per day, per key
- Errors
- JSON with a code, a message and a request_id
What does a request look like?
This call returns the mailbox your credentials belong to. Replace the placeholders with your own values.
curl "https://api.tuskmail.africa/v1/me" \
-H "X-API-Key: $TK_API_KEY" \
-u "$MAILBOX_EMAIL:$APP_PASSWORD"Ready to build? Follow the quickstart to send your first message in a few minutes.