InboxSpecDocumentation

Getting started

Build with InboxSpec

Receive real email in your tests and give agents a predictable way to wait for it.

InboxSpec gives your automated tests and agents real email addresses. Receive a message, wait for the code or link you need, and continue your application flow.

Start with one real email

The first-email guide takes you from an empty project to a matched message in your preferred language.

Follow the quickstart

Choose your path

One workflow, your choice of client

Use REST, the TypeScript SDK or the CLI to register an inbox and wait for a matching message. A wait returns a match or an explicit timeout. Authentication, quota and service failures remain errors you can act on.

Already integrating? Open the API reference for request schemas and permissions.