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.

<div data-component="DocsQuickStartFeatureCards" class="docs-card-grid">
<a class="docs-card" href="/docs/inboxes/"><span class="docs-card-title">Programmable email addresses</span><span class="docs-card-description">Create real inboxes on demand, receive messages, inspect content, manage attachments, and isolate each workflow.</span></a>
<a class="docs-card" href="/docs/txt-sms/"><span class="docs-card-title">Programmable phone numbers</span><span class="docs-card-description">Provision phone numbers for SMS, OTP, and transactional messaging flows without relying on shared devices.</span></a>
<a class="docs-card" href="/docs/testing/"><span class="docs-card-title">Testing functionality</span><span class="docs-card-description">Validate email, SMS, authentication, and notification behavior with deterministic waits and message assertions.</span></a>
<a class="docs-card" href="/docs/wait-for/"><span class="docs-card-title">End-to-end testing functionality</span><span class="docs-card-description">Run browser and API tests against real inboxes and phone numbers so release checks match production behavior.</span></a>
<a class="docs-card" href="/docs/device-renders/"><span class="docs-card-title">Device renders and previews</span><span class="docs-card-description">Preview email output across clients and devices to catch layout, content, and compatibility issues before launch.</span></a>
<a class="docs-card" href="/docs/domain-monitor/"><span class="docs-card-title">Domain monitoring</span><span class="docs-card-description">Watch sender domains, DNS posture, campaign output, and deliverability signals before problems reach customers.</span></a>
<a class="docs-card" href="/docs/ai-transformers/"><span class="docs-card-title">AI data extraction</span><span class="docs-card-description">Use AI transformers to extract structured fields from inbound messages, documents, and attachments.</span></a>
<a class="docs-card" href="/docs/webhooks/"><span class="docs-card-title">Automations and webhooks</span><span class="docs-card-description">Route inbound events into your systems with webhooks, forwarding, routing rules, and downstream automations.</span></a>
<a class="docs-card" href="/docs/verification/"><span class="docs-card-title">Identity, verification, and lookup</span><span class="docs-card-description">Verify addresses, test identity flows, manage API authentication, and support sign-in or compliance checks.</span></a>
</div>

## 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.

<div data-component="DocsQuickStartAccessCards" class="docs-card-grid">
<a class="docs-card" href="https://app.mailslurp.com/" target="_blank" rel="noopener noreferrer"><span class="docs-card-title">Create resources in the app</span><span class="docs-card-description">Use the dashboard to create inboxes, phone numbers, domains, rules, monitors, and automations without code.</span></a>
<a class="docs-card" href="https://app.mailslurp.com/settings/developers/" target="_blank" rel="noopener noreferrer"><span class="docs-card-title">Get an API key</span><span class="docs-card-description">Generate a developer API key, then authenticate SDK clients or REST calls with the same account resources.</span></a>
<a class="docs-card" href="/docs/sdks/"><span class="docs-card-title">Install SDKs and plugins</span><span class="docs-card-description">Use generated clients and framework guides for JavaScript, Java, C#, Python, PHP, Ruby, Go, and more.</span></a>
</div>

<a data-component="DocsButton" class="docs-button docs-button-secondary" href="https://app.mailslurp.com/sign-up/" target="_blank" rel="noopener noreferrer">Create account</a>

## Example workflows

Expand a scenario to plan the kind of workflow you want to build; detailed steps can be added to each section.

<div data-component="DocsQuickStartWorkflowList" class="docs-workflow-list">
<details class="docs-workflow-item"><summary>Write automated email/SMS tests</summary><p><a href="/docs/testing/">View the documentation here</a>.</p></details>
<details class="docs-workflow-item"><summary>Control phone numbers and email accounts in code</summary><p><a href="/docs/sdks/">View the documentation here</a>.</p></details>
<details class="docs-workflow-item"><summary>Render emails on different devices</summary><p><a href="/docs/device-renders/">View the documentation here</a>.</p></details>
<details class="docs-workflow-item"><summary>Improve inbox placement and domain reputation</summary><p><a href="/docs/domain-monitor/">View the documentation here</a>.</p></details>
<details class="docs-workflow-item"><summary>Analyze email quality and compatibility</summary><p><a href="/docs/email-audit/">View the documentation here</a>.</p></details>
<details class="docs-workflow-item"><summary>Extract data from emails and attachments using AI</summary><p><a href="/docs/ai-transformers/">View the documentation here</a>.</p></details>
<details class="docs-workflow-item"><summary>Create automations and routing</summary><p><a href="/docs/webhooks/">View the documentation here</a>.</p></details>
<details class="docs-workflow-item"><summary>More scenarios</summary><p><a href="/docs/guides/">View the documentation here</a>.</p></details>
</div>

## Learning resources and references

Use these resources when you are ready for runnable examples, endpoint details, SDK setup, or deeper tutorials.

<div data-component="DocsQuickStartResourceCards" class="docs-card-grid">
<a class="docs-card" href="/docs/examples/"><span class="docs-card-title">Example repositories</span><span class="docs-card-description">Start from runnable projects for Playwright, Selenium, Cypress, SDKs, API clients, and automation workflows.</span></a>
<a class="docs-card" href="/docs/api/"><span class="docs-card-title">REST API documentation</span><span class="docs-card-description">Browse endpoints, request models, response schemas, authentication details, and generated request examples.</span></a>
<a class="docs-card" href="/docs/sdks/"><span class="docs-card-title">Developer SDKs</span><span class="docs-card-description">Find generated clients and language-specific setup docs for the main MailSlurp developer workflows.</span></a>
<a class="docs-card" href="https://youtube.com/@mailslurp" target="_blank" rel="noopener noreferrer"><span class="docs-card-title">YouTube videos</span><span class="docs-card-description">Watch walkthroughs for common testing, automation, inbox, phone number, and API workflows.</span></a>
<a class="docs-card" href="/docs/guides/"><span class="docs-card-title">Guides and tutorials</span><span class="docs-card-description">Use longer-form guides when you need a full implementation pattern or framework-specific walkthrough.</span></a>
</div>

### Video walkthroughs

Check out our extensive video tutorials and learning resources.

<p data-component="DocsVideoPlaylistLink" class="docs-video-playlist-link">
<a href="https://youtube.com/@mailslurp" target="_blank" rel="noopener noreferrer">
Browse MailSlurp video guides on YouTube
</a>
</p>

