InboxSpecDocumentation

Getting started

How it works

Understand projects, inboxes and the two ways email reaches InboxSpec.

Projects and inboxes

A project owns inboxes, messages and API credentials. Console sign-in identifies a person; an API key authorizes access to one project. Create a separate project when you need to isolate local development from shared CI.

Two delivery paths

For incoming mail, register an inbox and send to its returned address through normal MX delivery. For outgoing application mail, configure Capture SMTP. Capture files messages into separate capture inboxes; it does not deliver into your MX test fixture.

Wait, inspect, continue

A blocking wait selects the oldest matching message in the chosen inbox. Read the result status before using ranked code candidates or links. Waits do not consume messages, so isolate each new test journey with a fresh run.

Try the complete first-email workflow →