That’s My Mail — Docs
Reference for the That’s My Mail transactional email API and the @thatsmymail/sdk. (UI/usage guides come later.)
Reading this with an agent?
Fetch /llms.txt for the index, or /llms-full.txt for every doc in a single file.
- Overview
What That's My Mail is, the API path shape, the products (console/admin/auth), and how to read these docs.
- Authentication
The TMM-HMAC-SHA256 signing scheme, the credential types (project key, account token, organization token, god-key), and scopes.
- API reference
Every endpoint: the shared product-agnostic layer /v1/* (data /v1/<table>/<verb> + shared services /v1/services/<action> e.g. /v1/services/sendEmail) and the product layers /console/v1/* (organizations, projects), /auth/v1/*, /admin/v1/*.
- Inbound mail & inboxes
Bring-your-own-domain (BYOD) for receiving: claim a domain, add a receiving (MX) capability, create inboxes, then read/send from the webmail app.
- SDK reference
@thatsmymail/sdk — install, construct a client, the full path-mirrored surface, and examples.
- Errors
The error envelope, the error codes, and how to use requestId when reporting issues.