# OpenMail

## Docs

- [Authentication](https://docs.openmail.sh/api-reference/authentication.md): OpenMail uses API key authentication. Pass your secret key as a Bearer token in the Authorization header on every request to the REST API.
- [Create inbox](https://docs.openmail.sh/api-reference/create-inbox.md): Create a new email inbox. Optionally set a sender display name.
- [Delete inbox](https://docs.openmail.sh/api-reference/delete-inbox.md): Permanently delete an inbox and stop delivery to its address. This action cannot be undone.
- [Get attachment](https://docs.openmail.sh/api-reference/get-attachment.md): Returns a 302 redirect to a signed URL for the attachment.
- [Get inbox](https://docs.openmail.sh/api-reference/get-inbox.md): Retrieve a single inbox by its ID, including its address, display name, and creation time.
- [Get thread messages](https://docs.openmail.sh/api-reference/get-thread-messages.md): Retrieve a thread and all of its messages in order, with read status and full message content.
- [Introduction](https://docs.openmail.sh/api-reference/introduction.md): Complete reference for the OpenMail REST API — create and manage inboxes, send messages, read threads, handle attachments, and configure webhooks.
- [List inboxes](https://docs.openmail.sh/api-reference/list-inboxes.md): List all inboxes for your account. Supports pagination.
- [List messages](https://docs.openmail.sh/api-reference/list-messages.md): List all messages in an inbox, across every thread. Supports pagination for high-volume inboxes.
- [List threads](https://docs.openmail.sh/api-reference/list-threads.md): List threads for an inbox. Use is_read to filter by read status — for example, ?is_read=false returns only unread threads.
- [API Overview](https://docs.openmail.sh/api-reference/overview.md): OpenMail REST API reference overview — base URL, JSON request/response format, HTTP status codes, and standardized error payloads explained.
- [Send email](https://docs.openmail.sh/api-reference/send-email.md): Send an email from an inbox. Requires Idempotency-Key header. Use threadId to reply to an existing thread.
- [Update thread](https://docs.openmail.sh/api-reference/update-thread.md): Update a thread's read status. Use this to mark a thread as read after your agent has processed it, or as unread to re-queue it for later processing.
- [Email deliverability](https://docs.openmail.sh/best-practices/email-deliverability.md): Best practices for landing outbound emails in the inbox. Covers IP warming, SPF/DKIM/DMARC alignment, content tips, and suppression handling.
- [Idempotency](https://docs.openmail.sh/best-practices/idempotency.md): Use idempotency keys to safely retry failed send requests without creating duplicate emails. OpenMail rejects duplicate requests for 24 hours.
- [Attachments](https://docs.openmail.sh/concepts/attachments.md): Send files with outbound emails and access attachments on inbound messages. OpenMail parses and stores attachments, making them available via API.
- [Custom domains](https://docs.openmail.sh/concepts/custom-domains.md): Send and receive email from your own domain with OpenMail. Learn how to configure DNS records, verify ownership, and enable custom domain routing.
- [Inboxes](https://docs.openmail.sh/concepts/inboxes.md): Every OpenMail agent gets a dedicated email address and inbox. Learn how to create, configure, and manage inboxes via API or CLI.
- [Rate Limits](https://docs.openmail.sh/concepts/rate-limits.md): OpenMail enforces per-inbox send limits and cold-outreach throttling to protect deliverability. Learn how limits work and how to stay within them.
- [Sender rules](https://docs.openmail.sh/concepts/sender-rules.md): Control which senders can reach your inboxes using allow and block lists. OpenMail sender rules filter inbound messages before they trigger webhooks.
- [Suppressions](https://docs.openmail.sh/concepts/suppressions.md): OpenMail automatically suppresses sending to addresses that have bounced or unsubscribed. Learn how suppressions work and how to manage the list.
- [Threading](https://docs.openmail.sh/concepts/threading.md): OpenMail automatically groups emails into threads by subject and message headers. Learn how threading works and how to read or update thread state.
- [Overview](https://docs.openmail.sh/concepts/webhooks.md): OpenMail webhooks deliver inbound email events to your endpoint in real time. Learn about delivery semantics, headers, signature verification, and retries.
- [Overview](https://docs.openmail.sh/concepts/websockets.md): OpenMail WebSockets deliver email events in real time with sub-second latency. Learn how the persistent connection model works and when to use it.
- [API integration](https://docs.openmail.sh/guides/api-integration.md): Create and manage inboxes programmatically via the OpenMail REST API. Ideal for multi-tenant apps, agent orchestration frameworks, and CI pipelines.
- [Setup](https://docs.openmail.sh/guides/webhooks.md): Configure webhook endpoints to receive inbound email events from OpenMail in real time. Covers endpoint setup, payload format, and signature verification.
- [Quickstart](https://docs.openmail.sh/guides/websockets/quickstart.md): Connect to OpenMail's WebSocket endpoint and start receiving inbound email events in real time. Step-by-step guide with authentication and code examples.
- [Introduction](https://docs.openmail.sh/index.md): OpenMail is email infrastructure purpose-built for AI agents — dedicated inboxes, real-time delivery, two-way threading, and attachment parsing.
- [Agent frameworks](https://docs.openmail.sh/integrations/agent-frameworks.md): Integrate OpenMail with LangChain, Vercel AI SDK, or any tool-calling framework. Includes examples for inbox creation and inbound email handling.
- [Claude Code](https://docs.openmail.sh/integrations/claude-code.md): Give your Claude Code agent a real email address in three steps. Install the OpenMail skill, run setup, and start sending and receiving email right away.
- [OpenClaw](https://docs.openmail.sh/integrations/openclaw.md): Give your OpenClaw agent a real email address in three steps. Install the OpenMail skill, run setup, and your agent can send and receive email immediately.
- [Frequently Asked Questions](https://docs.openmail.sh/pages/resources/faq.md): Frequently asked questions about OpenMail — inboxes, pricing, custom domains, sending limits, authentication, and agent integrations answered.
- [SPF, DKIM, DMARC](https://docs.openmail.sh/pages/resources/security/email-protocols.md): How OpenMail implements SPF, DKIM, and DMARC to authenticate your emails and maximize inbox delivery rates for outbound agent messages.
- [Support](https://docs.openmail.sh/pages/resources/support.md): Get help with OpenMail via Discord, email support, or GitHub issues. Find answers to common questions, report bugs, and request new features.
- [Events](https://docs.openmail.sh/pages/webhooks/events.md): OpenMail webhook event reference — event types, full payload structure, and field descriptions for inbound email, thread updates, and delivery errors.
- [Verification](https://docs.openmail.sh/pages/webhooks/verification.md): Verify OpenMail webhook payloads using HMAC-SHA256 signatures. Step-by-step examples for checking signatures and preventing replay attacks.
- [Protocol reference](https://docs.openmail.sh/pages/websockets/protocol.md): OpenMail WebSocket protocol reference — message types, subscribe payloads, event replay options, and connection lifecycle management.
- [Welcome](https://docs.openmail.sh/pages/welcome.md): Welcome to OpenMail — email infrastructure for AI agents. Start with the quickstart, explore core concepts, or jump straight into the API reference.
- [Quickstart](https://docs.openmail.sh/quickstart.md): Get your AI agent its own email address in two commands. Install the CLI, run openmail setup, and start sending and receiving email in minutes.

## OpenAPI Specs

- [openapi](https://docs.openmail.sh/api-reference/openapi.json)