Documentation
Looking in the wrong place costs more time than reading. This page says what each corpus holds, who it is written for and what language it is written in, so that you open one tab.
The corpora
One lives here, two live on a domain of their own. The boundary is not cosmetic: it follows the reader, and this page is the only place it is stated.
For whoever uses the product
Creating an inbox, reading a message, understanding a quota, inviting a colleague, wiring up SSO, recovering a lost second factor. What is done in the application, screen by screen.
Written inFREN
Open the help centreFor whoever calls the API
Every route under /v1: its fields, the key scope it requires, its error codes, and the refusals no scope lifts. The OpenAPI document behind it is checked by the test suite on every change to the API.
Written inEN
Open the referenceFor whoever wires up a test suite
The path to a first call: a key, an inbox, a message, an assertion. Then authentication, the shape of errors, the wait that replaces the retry loop, and picking up a suite written for Mailosaur.
Written inEN
Start hereBy need
The same map, entered by the question rather than by the document. If a line is missing here, a page is missing: write to us rather than search.
| I want to… | It is written |
|---|---|
| receive a message in my tests and read the code inside it | Integration guides |
| install a package into Playwright or Cypress rather than call the API | Integrations |
| know the exact fields of a response, or what an error code means | API reference |
| create an API key and know what it can reach | Integration guides |
| understand a quota I have hit, or change an inbox retention | Product help |
| invite a colleague, partition a workspace, wire up SSO | Product help |
| pick up a test suite written for another provider | Migration guide |
| know what it costs, and from what volume | Pricing |
| know where my data sits and what the DPA commits to | Sovereignty and GDPR |
| know whether the service is answering right now | Service status |
Languages
The product help exists in both languages, and not out of goodwill: an article existing in one language only fails the test suite. It is written for the customer of a product sold in France.
The reference and the guides are English only. They are written for somebody already reading an Authorization header, and a bilingual corpus we cannot afford to keep current on both sides becomes a corpus half of which is wrong.
The API error messages are in French today. The reference says so rather than hiding it: the contract is the error.code field, never the sentence beside it.
A key, an inbox and a first message: the free plan asks for no card, and the quickstart takes five minutes.