Quick start
MailSlurp gives your team real inboxes, phone numbers, testing tools, monitoring workflows, and automation primitives in one platform. The fastest way to get an "aha" moment is to create a fresh inbox, run one real message flow, and then branch into the workflow that matches your job.
Choose your starting point
Developers
Create inboxes, domains, and numbers in code so product workflows stop depending on shared mailboxes.
QA and release
Test sign-up, OTP, notifications, and message quality using deterministic waits and delivery checks.
Marketers
Preview campaigns, audit email quality, and monitor sender or campaign health before and after launch.
Data and ops
Capture inbound messages, extract structured content, and route events into downstream systems.
1. Create an account and API key
Before you run any workflow:
- Create a MailSlurp account.
- Generate an API key in developer settings.
- Decide whether you want to start with an SDK or direct REST calls.
- Sign up: app.mailslurp.com/sign-up
- API keys: app.mailslurp.com/settings/developers
- SDK libraries: /sdks/
- API reference: /api/
2. Run your first real workflow
Create a fresh inbox for a test, app flow, or operational automation. This is the core MailSlurp pattern: isolate the address, run the workflow, then inspect or wait for the resulting message.
MailSlurp supports JavaScript, Java, C#, PHP, Python, Ruby, and Go SDKs. The same workflows are also available over REST.
- Javascript
- Java
- C#
- PHP
- Python
- Ruby
- Go
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Once you have an inbox, your next move is usually one of these:
- Send from your app or MailSlurp: /emails/
- Wait for a real email or SMS deterministically: /wait-for/
- Add production sender identity: /custom-domains/
- Provision phone numbers for OTP and SMS flows: /txt-sms/
3. Pick the platform track you actually need
Messaging
Core inboxes, email, SMS, custom domains, attachments, and external mailbox connectors.
Testing
End-to-end release confidence with waits, device previews, email audit, compatibility checks, and deliverability tests.
Monitoring
Monitor domains, live campaigns, and sender health so issues are visible before customers notice them.
Automation
Use webhooks, forwarding, routing rules, alias proxy, and AI transformers to turn messages into events and data pipelines.
Governance
Share access safely with organizations, custom roles, environment isolation, SAML SSO, and storage controls.
4. Best next docs by team
- Developers and platform teams: Solutions, Inboxes, Custom domains, Webhooks
- QA and release teams: Solutions, Deliverability tests, Device previews, Email audit
- Marketers and lifecycle teams: Solutions, Email audit, Device previews, Domain Monitor
- Data and operations teams: Solutions, Forwarding, Routing rules, Monitoring
5. Production readiness checklist
- Use environment-specific API keys instead of one shared key across every workflow.
- Give production sender domains their own validation and monitoring path.
- Create roles or per-user permissions before expanding team access.
- Use deliverability checks and campaign monitoring before large sends.
- Keep testing inboxes and production inboxes separated by environment or organization policy.