Skip to content

Overview

Receive email in your test suite, and read it back without a sleep loop.

Facteur gives every test suite its own inboxes, accepts mail for them over SMTP, parses it, and hands it back over HTTP — including the one-time codes and links your tests actually assert on.

The base URL is https://api.facteur.eu. Every route below authenticates with an API key; see the Authentication guide for how to mint one.

On error messages. Every failure carries a machine-readable code and a human-readable message. The code is the contract — it is stable, and it is what your test suite should branch on. The message is written for a person reading a red pipeline, and it is in French today. Do not parse it.

Information

  • License: Proprietary
  • OpenAPI version: 3.1.0

Authorization: Bearer fk_… — the form to prefer.

Security scheme type: http

Authorization: Basic base64(fk_…:), the key as the username and an empty password. Accepted because the Mailosaur SDK authenticates that way, and a migration that only needed a base URL and a key would otherwise be false in the one place it is measurable.

Security scheme type: http