Guides
Guides
Use this page when you know what you are trying to achieve but do not yet know which MailSlurp docs path gets you there fastest. The guide surface is organized for four kinds of discovery:
- Product-based entry points in Features
- Test and release playbooks in Testing
- Product capabilities in Features
- Language and framework setup through SDK, API, and framework-specific guides
How to navigate this section
- New to MailSlurp: start with Quick start, then continue with Features for product-level docs.
- Building product messaging flows: prioritize Inboxes, Emails, TXT/SMS, and Webhooks.
- Shipping campaigns or release checks: start with Testing and Monitoring.
- Setting up access and production controls: go to Team accounts, Roles and permissions, and Environments.
Choose your team
Start with the workflow that matches your job instead of reading the whole docs set front to back.
Data and operations teams
Capture inbound messages, extract structured data, and route them into downstream systems.
Developers and platform teams
Provision inboxes, domains, numbers, and shared environments without manual mailbox ops.
Marketers and lifecycle teams
Preview campaigns, run audits, and monitor sender or campaign quality without replacing your ESP.
QA and release teams
Test auth flows, notifications, and message delivery with auditable proof.
Framework Guides
Use MailSlurp inside the browser automation and no-code tools your team already runs.
Release Confidence
Everything needed to validate rendering, deliverability, content quality, and asynchronous flows.
Testing overview
Design inbox and phone workflows for CI, staging, and release gates.
Wait for conditions
Replace fixed sleeps with deterministic message waits.
Deliverability tests
Run expectation-based pass/fail checks across inbox or phone cohorts.
Email audit
Review links, images, and quality signals before launch.
Device previews
Preview client rendering for stakeholder sign-off and release review.
Email compatibility
Check email HTML and CSS support across clients.
Automation and APIs
Build event-driven workflows, start with SDKs, and connect MailSlurp into your systems.
API reference
Jump into REST endpoints and generated SDK methods.
Examples
Browse runnable projects and end-to-end implementation patterns.
Webhooks
Push events into your own services in real time.
AI transformers
Extract structured data from messages and attachments.
Campaign Probe
Capture production campaign output for ongoing QA and alerting.
Domain Monitor
Track DNS posture and sender-health drift over time.
New Feature Guides
Explore recently added monitoring and quality tooling that should be easy to miss otherwise.
Campaign Probe
Watch live campaign output through controlled capture addresses and automated checks.
Device previews
Review rendering in the clients and devices your stakeholders actually care about.
Domain Monitor
Track sender-health posture and DNS drift before it becomes a delivery incident.
Email audit
Check links, images, authentication, and content quality in one review pass.
Team and Governance
Plan environments, permissions, SSO, storage, and shared access before production rollout.
Environments
Isolate staging, production, and workflow-specific resources inside one org.
Guest portals
Create branded access experiences for external or customer users.
Roles and permissions
Design least-privilege access using custom roles and per-user permissions.
SAML SSO
Control sign-in with your identity provider and organization policy.
Storage
Understand retention, deletion, and storage behavior across resources.
Team accounts
Share inboxes, users, and organization controls safely across teams.
Developer Starting Points
Reference material for engineers wiring MailSlurp into app code, tests, and services.
API reference
Browse the MailSlurp REST API and endpoint groups.
Authentication
Configure API keys and safe auth patterns across environments.
Examples
Browse runnable examples and end-to-end reference projects.
IMAP / SMTP
Use protocol access when you need real mailbox credentials.
Pagination
Handle long-running list workflows safely and predictably.
SDK libraries
Jump into JavaScript, Java, Python, Go, C#, PHP, Ruby, and more.