Authentication#

All /api/v1 endpoints require an InboxTron API token.

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Mailboxes#

GET  /api/v1/mailboxes
POST /api/v1/mailboxes

Creating through the REST API creates a hosted InboxTron mailbox. The request can include name and localPart.

Messages#

GET    /api/v1/mailboxes/:mailboxId/messages
GET    /api/v1/mailboxes/:mailboxId/messages/:messageId
POST   /api/v1/mailboxes/:mailboxId/messages
POST   /api/v1/mailboxes/:mailboxId/messages/:messageId/reply
PATCH  /api/v1/mailboxes/:mailboxId/messages/:messageId/read
DELETE /api/v1/mailboxes/:mailboxId/messages/:messageId

List messages accepts page, limit, and q query parameters. q searches subject, body, sender and recipient.

Send#

{"to":"person@example.com","subject":"Supplier update","text":"The order is confirmed."}

Reply#

{"text":"Thanks. Please send the updated quote."}

Trash and restore#

GET  /api/v1/mailboxes/:mailboxId/trash
POST /api/v1/mailboxes/:mailboxId/messages/:messageId/restore

Deleting a message moves it to Trash rather than immediately destroying it.