# MailSlurp API reference Search MailSlurp REST endpoints, inspect request and response schemas, copy HTTP snippets, and jump to SDK guides. Canonical URL: https://www.mailslurp.com/docs/api/ OpenAPI JSON: https://api.mailslurp.com/v2/api-docs/ Base URL: https://api.mailslurp.com ## API key Send your MailSlurp API key in the `x-api-key` header. Create and rotate keys from the dashboard, then use REST endpoints or official SDKs. ## Tools - [OpenAPI JSON](https://api.mailslurp.com/v2/api-docs/) - [Swagger UI](https://swagger.mailslurp.com/) - [Postman collection](https://www.postman.com/mailslurp-api) - [SDKs](/docs/sdks/) - [SMTP and IMAP](/docs/imap-smtp/) ## SDKs - [JavaScript guide](/docs/js/) - [method reference](https://js.mailslurp.com/) - [Java guide](/docs/java/) - [method reference](https://java.mailslurp.com/) - [Python guide](/docs/python/) - [method reference](https://python.mailslurp.com/) - [C# guide](/docs/csharp/) - [method reference](https://csharp.mailslurp.com/) - [PHP guide](/docs/php/) - [method reference](https://php.mailslurp.com/) - [Ruby guide](/docs/ruby/) - [method reference](https://ruby.mailslurp.com/) - [Go guide](/docs/go/) - [method reference](https://pkg.go.dev/github.com/mailslurp/mailslurp-client-go) - [Swift guide](/docs/swift/) - [method reference](https://github.com/mailslurp/mailslurp-client-swift/tree/master/docs) - [Dart guide](/docs/dart/) - [method reference](https://github.com/mailslurp/mailslurp-client-dart/tree/master/doc) ## Guides - [Authentication](/docs/authentication/) - Send `x-api-key` securely and rotate API keys from the dashboard. - [Inboxes](/docs/inboxes/) - Create inboxes, set addresses, and manage mailbox lifecycle from code. - [Emails](/docs/emails/) - Send, receive, inspect, and match email content through the API. - [Wait for messages](/docs/wait-for/) - Poll for new email or SMS messages in tests and automation flows. - [Webhooks](/docs/webhooks/) - Receive event callbacks for new email, SMS, attachments, and AI results. - [SMS and phone numbers](/docs/txt-sms/) - Use phone numbers for OTP, verification, and inbound SMS workflows. - [Custom domains](/docs/custom-domains/) - Verify domains, configure DNS, and create custom email addresses. - [SMTP and IMAP](/docs/imap-smtp/) - Connect standard mail clients and libraries to MailSlurp inboxes. - [Attachments](/docs/attachments/) - Upload, download, inspect, and send files with API-managed email. - [SDKs](/docs/sdks/) - Install MailSlurp SDKs and call the same endpoints from typed clients. ## Controller groups - [Inbox](https://www.mailslurp.com/docs/api/#Inbox-Controller) - 67 operations - [Email](https://www.mailslurp.com/docs/api/#Email-Controller) - 51 operations - [Wait For](https://www.mailslurp.com/docs/api/#Wait-For-Controller) - 8 operations - [SMS](https://www.mailslurp.com/docs/api/#Sms-Controller) - 22 operations - [Phone](https://www.mailslurp.com/docs/api/#Phone-Controller) - 60 operations - [Webhook](https://www.mailslurp.com/docs/api/#Webhook-Controller) - 40 operations - [Domain](https://www.mailslurp.com/docs/api/#Domain-Controller) - 12 operations - [Alias](https://www.mailslurp.com/docs/api/#Alias-Controller) - 11 operations - [AI](https://www.mailslurp.com/docs/api/#AIController) - 21 operations - [Attachment](https://www.mailslurp.com/docs/api/#Attachment-Controller) - 11 operations - [Audit Log](https://www.mailslurp.com/docs/api/#api-audit-log-controller) - 3 operations - [Bounce](https://www.mailslurp.com/docs/api/#Bounce-Controller) - 12 operations - [Bulk Actions](https://www.mailslurp.com/docs/api/#Bulk-Actions-Controller) - 3 operations - [Campaign Probe](https://www.mailslurp.com/docs/api/#Campaign-Probe-Controller) - 12 operations - [Common Actions](https://www.mailslurp.com/docs/api/#Common-Actions-Controller) - 6 operations - [Connector](https://www.mailslurp.com/docs/api/#Connector-Controller) - 31 operations - [Consent](https://www.mailslurp.com/docs/api/#Consent-Controller) - 4 operations - [Contact](https://www.mailslurp.com/docs/api/#Contact-Controller) - 6 operations - [Deliverability Test](https://www.mailslurp.com/docs/api/#Deliverability-Test-Controller) - 22 operations - [Device Previews](https://www.mailslurp.com/docs/api/#Device-Previews-Controller) - 42 operations - [Domain Monitor](https://www.mailslurp.com/docs/api/#Domain-Monitor-Controller) - 22 operations - [Domain Monitor Postmaster](https://www.mailslurp.com/docs/api/#Domain-Monitor-Postmaster-Controller) - 8 operations - [Email Audit](https://www.mailslurp.com/docs/api/#Email-Audit-Controller) - 5 operations - [Email Verification](https://www.mailslurp.com/docs/api/#Email-Verification-Controller) - 6 operations - [Expired](https://www.mailslurp.com/docs/api/#Expired-Controller) - 4 operations - [Export](https://www.mailslurp.com/docs/api/#Export-Controller) - 2 operations - [Form](https://www.mailslurp.com/docs/api/#Form-Controller) - 1 operations - [Group](https://www.mailslurp.com/docs/api/#Group-Controller) - 9 operations - [Guest Portal](https://www.mailslurp.com/docs/api/#Guest-Portal-Controller) - 8 operations - [IMAP](https://www.mailslurp.com/docs/api/#Imap-Controller) - 7 operations - [Inbox Forwarder](https://www.mailslurp.com/docs/api/#Inbox-Forwarder-Controller) - 13 operations - [Inbox Placement Test](https://www.mailslurp.com/docs/api/#api-inbox-placement-test-controller) - 10 operations - [Inbox Replier](https://www.mailslurp.com/docs/api/#Inbox-Replier-Controller) - 8 operations - [Mail Server](https://www.mailslurp.com/docs/api/#Mail-Server-Controller) - 5 operations - [MFA](https://www.mailslurp.com/docs/api/#MFAController) - 9 operations - [Missed Email](https://www.mailslurp.com/docs/api/#Missed-Email-Controller) - 5 operations - [Missed SMS](https://www.mailslurp.com/docs/api/#Missed-Sms-Controller) - 3 operations - [Ruleset](https://www.mailslurp.com/docs/api/#Ruleset-Controller) - 10 operations - [Sent Emails](https://www.mailslurp.com/docs/api/#Sent-Emails-Controller) - 16 operations - [Spam Email](https://www.mailslurp.com/docs/api/#Spam-Email-Controller) - 1 operations - [Template](https://www.mailslurp.com/docs/api/#Template-Controller) - 8 operations - [Tools](https://www.mailslurp.com/docs/api/#Tools-Controller) - 35 operations - [Tracking](https://www.mailslurp.com/docs/api/#Tracking-Controller) - 3 operations - [User](https://www.mailslurp.com/docs/api/#User-Controller) - 11 operations ## Schemas 642 schemas are available on the API reference page and in the OpenAPI definition.