# Mailactor documentation

Public API: https://api.mailactor.com
OpenAPI: https://docs.mailactor.com/openapi.json
Full documentation: https://docs.mailactor.com/llms-full.txt

# Documentation


- **Get started**
- [Introduction](/docs): A real email identity for your agents and applications.
- [Your first conversation](/docs/quickstart): Create an inbox, send an email, and read a reply.
- [Authentication & access](/docs/authentication): Understand your organization, API key, and permissions.
- [Build with an AI agent](/docs/agents): Give your agent the contract, a scoped key, and a clear task.

- **Build with Mailactor**
- Inboxes
  - [Create an inbox](/docs/inboxes/create): Give your agent a persistent email address.
  - [Manage inboxes](/docs/inboxes/manage): List, inspect, export, and delete your inboxes.
- Messages
  - [Send messages](/docs/messages/send): Send email from your inbox and track the result.
  - [Receive messages](/docs/messages/receive): Read incoming email through polling or webhook notifications.
  - [Reply to a conversation](/docs/messages/reply): Answer an exact message while preserving the thread.
  - [Attachments & message deletion](/docs/messages/attachments): Understand attachment availability and remove mailbox content.
- Webhooks
  - [Receive webhook notifications](/docs/webhooks/overview): Let Mailactor notify your application when new email arrives.
  - [Verify webhook signatures](/docs/webhooks/verify): Authenticate the exact request bytes before processing an event.
- Custom domains
  - [Connect your own domain](/docs/domains/setup): Use an address on a domain you control.

- **Go further**
- Reliability
  - [Idempotency & retries](/docs/reliability/idempotency): Recover from interruptions without sending a duplicate.
  - [Pagination](/docs/reliability/pagination): Read complete inventories and conversations.
  - [Delivery status](/docs/reliability/delivery): Know whether your email was accepted, delivered, or needs attention.
  - [Errors & troubleshooting](/docs/reliability/errors): Find the next useful action when a request fails.
- [Validate email addresses](/docs/validation): Check address syntax and domain signals before sending.
- [Limits & capabilities](/docs/limits): Discover your effective limits instead of hard-coding assumptions.
- [Get help](/docs/support): What you can manage yourself, and when to reach the team.

- **Reference**
- API reference

  - **Your account**
  - [Account & access](/docs/api-reference/getTenantAccessProfile): Available to every valid tenant key without an additional scope. Returns effective policy metadata but never the key secret, hash, prefix, source fingerprint, or operator data.

  - **Inboxes**
  - [Get an inbox](/docs/api-reference/getInbox)
  - [Delete an inbox](/docs/api-reference/deleteInbox)
  - [Export an inbox](/docs/api-reference/exportInbox)
  - [Create an inbox](/docs/api-reference/createInbox): Omit domainId for a managed starter address, or supply a verified customer-domain ID.
  - [List inboxes](/docs/api-reference/listInboxes)
  - [Send a message](/docs/api-reference/sendInboxMessage): Managed addresses have a deployment-configured lifetime starter allowance. Customer-domain inboxes do not use it.
  - [List conversations](/docs/api-reference/listInboxThreads)

  - **Threads & replies**
  - [Get a conversation](/docs/api-reference/getThread)
  - [Reply to a message](/docs/api-reference/replyToThread)

  - **Messages & attachments**
  - [Download an attachment](/docs/api-reference/downloadAttachment)
  - [Delete a message](/docs/api-reference/deleteMessage)

  - **Webhooks**
  - [Delete a webhook](/docs/api-reference/deleteWebhook)
  - [Create a webhook](/docs/api-reference/createWebhook): Each endpoint URL must be unique within the organization. For replacement without a gap, create a distinct receiver URL before deleting the old endpoint. Exact retries can recover the signing secret until signingSecretReplayUntil; after expiry they return 409 webhook_secret_replay_expired.
  - [List webhooks](/docs/api-reference/listWebhooks)

  - **Domains**
  - [Get domain usage](/docs/api-reference/getDomainTraffic)
  - [Register a domain](/docs/api-reference/registerDomain): Returns TXT ownership, DKIM and MX instructions. Inbound and outbound capabilities verify independently.
  - [List domains](/docs/api-reference/listDomains)
  - [Get a domain](/docs/api-reference/getDomain)
  - [Verify domain DNS](/docs/api-reference/verifyDomain)

  - **Delivery status**
  - [List submissions](/docs/api-reference/listSubmissions)
  - [Get a submission](/docs/api-reference/getSubmission)
  - [List delivery events](/docs/api-reference/listSubmissionEvents)

  - **Direct sending**
  - [Submit a message](/docs/api-reference/submitEmail)

  - **Address validation**
  - [Validate an address](/docs/api-reference/validateEmail)
  - [Validate in bulk](/docs/api-reference/validateEmailsBulk)

  - **Metrics**
  - [Get delivery metrics](/docs/api-reference/getDeliveryMetrics)

  - **Suppressions**
  - [List suppressions](/docs/api-reference/listSuppressions)
  - [Suppress an address](/docs/api-reference/createSuppression)
  - [Remove a suppression](/docs/api-reference/deleteSuppression)

  - **Complaints**
  - [List complaints](/docs/api-reference/listComplaints)