# InboxSpec

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

## API and agent resources

- [OpenAPI](https://api.inboxspec.com/openapi.json): Request and response schemas from this environment's API.

- [API reference](https://api.inboxspec.com/docs): Endpoint documentation.

- [Docs catalog](https://www.inboxspec.com/docs.json): Machine-readable index of the public guides.

- [Markdown catalog](https://www.inboxspec.com/docs/markdown): Individual guides in Markdown.

- [Full documentation](https://www.inboxspec.com/llms-full.txt): All public guides in one text download.

- [API catalog](https://www.inboxspec.com/.well-known/api-catalog): API discovery in RFC 9727 Linkset format.

## Getting started

- [Introduction](https://www.inboxspec.com/docs/markdown/index.md): Receive real email in your tests and give agents a predictable way to wait for it.
- [Your first email](https://www.inboxspec.com/docs/markdown/first-email.md): Receive your first verification code with JavaScript/TypeScript, Python, Java or Bash/curl.
- [How it works](https://www.inboxspec.com/docs/markdown/how-it-works.md): Understand projects, inboxes and the two ways email reaches InboxSpec.

## Receiving email

- [Inboxes](https://www.inboxspec.com/docs/markdown/inboxes.md): Create a deterministic address and keep each test run separate.
- [Capture SMTP](https://www.inboxspec.com/docs/markdown/capture-smtp.md): Capture outgoing application mail over authenticated SMTP with STARTTLS.
- [Inspecting messages](https://www.inboxspec.com/docs/markdown/message-bodies.md): Read text, HTML, links and attachments after a matching email arrives.

## Testing

- [Waiting for email](https://www.inboxspec.com/docs/markdown/waits.md): Distinguish a match, a timeout and an error within one test deadline.
- [OTP and link assertions](https://www.inboxspec.com/docs/markdown/otp-tests.md): Correlate verification codes and reset links with the exact application journey.
- [Fixtures](https://www.inboxspec.com/docs/markdown/fixtures.md): Provision repeatable test inboxes and detect configuration drift.
- [CI email tests](https://www.inboxspec.com/docs/markdown/ci.md): Connect setup, application delivery, assertions and scoped cleanup.
- [GitHub and Vercel](https://www.inboxspec.com/docs/markdown/workloads.md): Use trusted workload identity for short-lived project access.
- [Cleaning up](https://www.inboxspec.com/docs/markdown/cleanup.md): Remove only your test run after producers and waits have finished.

## Developer tools

- [REST API](https://www.inboxspec.com/docs/markdown/rest.md): Choose JavaScript, Python, Go, Java, C#, PHP or curl examples for the hosted API.
- [Client installation](https://www.inboxspec.com/docs/markdown/installation.md): Install the reviewed private SDK and CLI release archives.
- [TypeScript SDK](https://www.inboxspec.com/docs/markdown/sdk.md): Register an inbox and wait for email from Node.js or Bun.
- [Command line](https://www.inboxspec.com/docs/markdown/cli.md): Use the InboxSpec CLI in a terminal or test runner.
- [MCP](https://www.inboxspec.com/docs/markdown/mcp.md): Use Connect agent in your project to set up Claude Code, Codex or another MCP client with a project key.

## Reference & help

- [API reference](https://www.inboxspec.com/docs/markdown/api-reference.md): Find request schemas, management operations and the OpenAPI document.
- [Limits and credentials](https://www.inboxspec.com/docs/markdown/limits.md): Understand project access, quotas, key lifetimes and replacement.
- [Troubleshooting](https://www.inboxspec.com/docs/markdown/troubleshooting.md): Diagnose API configuration, environment and permission errors.
- [Service health](https://www.inboxspec.com/docs/markdown/service-health.md): Interpret fixture diagnostics and regional mail delivery observations.

## Operators

- [Self-hosted MCP](https://www.inboxspec.com/docs/markdown/mcp-self-hosting.md): Run the MCP server for your own InboxSpec installation and check the connection.