Quick start
Welcome to the MailSlurp quick start guide. Use this page to start your journey.
What is MailSlurp
MailSlurp is an email and phone number API service for testing, development, deliverability monitoring, and AI automations. It gives teams programmable inboxes, phone numbers, message inspection, wait logic, device previews, and event routing through both a dashboard and developer APIs.
Use this page as a map: start with the main platform features, choose how you want to use MailSlurp, then jump into the right reference or learning resource.
What are the main features of MailSlurp?
These are the core platform areas you can combine for testing, development, monitoring, and automation workflows.
Programmable email addresses
Create real inboxes on demand, receive messages, inspect content, manage attachments, and isolate each...
Programmable phone numbers
Provision phone numbers for SMS, OTP, and transactional messaging flows without relying on shared devices.
Testing functionality
Validate email, SMS, authentication, and notification behavior with deterministic waits and message...
End-to-end testing functionality
Run browser and API tests against real inboxes and phone numbers so release checks match production behavior.
Device renders and previews
Preview email output across clients and devices to catch layout, content, and compatibility issues before...
Domain monitoring
Watch sender domains, DNS posture, campaign output, and deliverability signals before problems reach...
AI data extraction
Use AI transformers to extract structured fields from inbound messages, documents, and attachments.
Automations and webhooks
Route inbound events into your systems with webhooks, forwarding, routing rules, and downstream automations.
Identity, verification, and lookup
Verify addresses, test identity flows, manage API authentication, and support sign-in or compliance checks.
How to use MailSlurp
MailSlurp is an API and dashboard platform. You can create resources manually in the app, call the REST API directly, or install an SDK for your language or test framework. The same resources are available across all access paths, so you can prototype without code and then automate the workflow in tests, scripts, CI jobs, or third-party integrations.
You can use MailSlurp manually for operations and debugging, or integrate it into code tests, automations, and plugins. Common workflows include generating disposable inboxes for sign-up tests, receiving OTP codes, checking email rendering before release, monitoring sender domains, extracting data from attachments, and routing inbound messages into downstream systems.
Main ways to get started
Choose the access path that matches how you want to try MailSlurp first: dashboard, API key, or SDK.
Create resources in the app
Use the dashboard to create inboxes, phone numbers, domains, rules, monitors, and automations without code.
Get an API key
Generate a developer API key, then authenticate SDK clients or REST calls with the same account resources.
Install SDKs and plugins
Use generated clients and framework guides for JavaScript, Java, C#, Python, PHP, Ruby, Go, and more.
Example workflows
Expand a scenario to plan the kind of workflow you want to build; detailed steps can be added to each section.
Write automated email/SMS tests
Control phone numbers and email accounts in code
Render emails on different devices
Improve inbox placement and domain reputation
Analyze email quality and compatibility
Extract data from emails and attachments using AI
Create automations and routing
More scenarios
Learning resources and references
Use these resources when you are ready for runnable examples, endpoint details, SDK setup, or deeper tutorials.
Example repositories
Start from runnable projects for Playwright, Selenium, Cypress, SDKs, API clients, and automation workflows.
REST API documentation
Browse endpoints, request models, response schemas, authentication details, and generated request examples.
Developer SDKs
Find generated clients and language-specific setup docs for the main MailSlurp developer workflows.
YouTube videos
Watch walkthroughs for common testing, automation, inbox, phone number, and API workflows.
Guides and tutorials
Use longer-form guides when you need a full implementation pattern or framework-specific walkthrough.
Video walkthroughs
Check out our extensive video tutorials and learning resources.
Video guides
0 videos