# Outbox

> Open source email API and dashboard — a self-hostable Resend. Outbox implements the Resend API surface (same paths, request bodies, response shapes, and error envelope), so any Resend SDK works against it by changing only the base URL. Built on Bun, Atlas, and PostgreSQL. MIT licensed.

The complete documentation in one file: [llms-full.txt](https://wess.io/outbox/llms-full.txt)

## Getting started

- [Quickstart](https://wess.io/outbox/quickstart.md): Get Outbox running locally and send your first email in about five minutes.
- [Concepts](https://wess.io/outbox/concepts.md): How teams, domains, contacts, topics, and the job queue fit together.
- [Self-hosting](https://wess.io/outbox/self-hosting.md): Transports, configuration, deployment, and the operational realities of running your own mail.

## Tutorials

- [Send your first email](https://wess.io/outbox/tutorials/send-your-first-email.md): From a running instance to a delivered message, with the state machine explained.
- [Verify a domain](https://wess.io/outbox/tutorials/verify-a-domain.md): Publish SPF, DKIM, and DMARC records so your mail authenticates and arrives.
- [Migrate from Resend](https://wess.io/outbox/tutorials/migrate-from-resend.md): What changes, what doesn't, and how to cut over without dropping mail.
- [Transactional email with templates](https://wess.io/outbox/tutorials/transactional-with-templates.md): Move email content out of your codebase and into versioned, publishable templates.
- [Broadcast to a segment](https://wess.io/outbox/tutorials/broadcast-to-a-segment.md): Build an audience, personalise a message, and send it to everyone who should get it.
- [Build a welcome automation](https://wess.io/outbox/tutorials/welcome-automation.md): A branching, multi-day onboarding sequence triggered by an event from your app.
- [Handle webhooks](https://wess.io/outbox/tutorials/handle-webhooks.md): Receive events, verify signatures correctly, and react to bounces and complaints.
- [Handle bounces](https://wess.io/outbox/tutorials/handle-bounces.md): Process delivery failures and spam complaints that arrive after a message was accepted.
- [Receive inbound email](https://wess.io/outbox/tutorials/receive-inbound-email.md): Accept mail on your own domain, parse it, and act on it in your application.
- [Deploy to production](https://wess.io/outbox/tutorials/deploy-to-production.md): Docker, systemd, TLS, scaling, and a pre-flight checklist.
- [Connect Inkling](https://wess.io/outbox/tutorials/connect-inkling.md): Pair Outbox with the Inkling CMS in one paste each direction — publish a post, subscribers get it.

## API reference

- [Introduction](https://wess.io/outbox/api/introduction.md): Base URL, authentication, required headers, response codes, and rate limits.
- [Emails](https://wess.io/outbox/api/emails.md): Send, retrieve, schedule, cancel, and list emails, plus attachments and inbound mail.
- [Domains](https://wess.io/outbox/api/domains.md): Add, verify, configure, and delete sending domains.
- [API keys](https://wess.io/outbox/api/api-keys.md): Create, list, and delete API keys, with permission and domain scoping.
- [Contacts](https://wess.io/outbox/api/contacts.md): Create, update, and list contacts, with properties, segment membership, and topic subscriptions.
- [Segments](https://wess.io/outbox/api/segments.md): Group contacts for broadcasts. Includes the legacy audiences alias.
- [Topics](https://wess.io/outbox/api/topics.md): Subscription categories that let recipients opt out of one kind of mail without opting out of everything.
- [Contact properties](https://wess.io/outbox/api/contact-properties.md): Define typed custom fields on contacts for use as template variables.
- [Broadcasts](https://wess.io/outbox/api/broadcasts.md): Send one personalised message to every contact in a segment, with per-broadcast metrics.
- [Templates](https://wess.io/outbox/api/templates.md): Versioned email content with typed variables and a draft/publish workflow.
- [Suppressions](https://wess.io/outbox/api/suppressions.md): The team do-not-send list that bounces and complaints feed automatically.
- [Webhooks](https://wess.io/outbox/api/webhooks.md): Event types, Svix-compatible signatures, delivery history, and retries.
- [Automations](https://wess.io/outbox/api/automations.md): Event-triggered workflows built as a step graph, with branching, delays, and waits.
- [Metrics](https://wess.io/outbox/api/metrics.md): Aggregate email and segment metrics with configurable granularity and dimensions.
- [Logs](https://wess.io/outbox/api/logs.md): Every API request, with its body and response, for debugging integrations.
- [Pagination](https://wess.io/outbox/api/pagination.md): Cursor pagination, the list envelope, and how to walk a full result set.
- [Errors](https://wess.io/outbox/api/errors.md): The error envelope and every error name Outbox returns.

## Reference

- [SDKs](https://wess.io/outbox/sdk.md): Use the official Resend SDKs against Outbox, or the bundled zero-dependency client.

## Source

- [Repository](https://github.com/wess/outbox): source, issues, and releases