Official MailSlurp documentation

MailSlurp is an email and SMS application programming interface for integrating email and TXT messages into your application. Find the developer portal and documentation for guides and reference documents.

Usage

The easiest way to get started with MailSlurp is by using the NPM node package.

npm install --save mailslurp-client

Create an inbox within your application to send and receive emails.

const inbox = await mailslurp.createInbox();
expect(inbox.emailAddress).toContain("@mailslurp");

Guides

• Getting started
• Creating inboxes
• Example projects

Common language integrations

MailSlurp has SDK libraries for most common programming frameworks.

Csharp (.NET)

• Documentation
• SMTP setup
• DotNet Core example

Golang

• Documentation
• Golang sample project

Java

• Documentation
• Java SMTP setup
• Spring Boot example

NodeJS / Javascript / Typescript

• Getting started
• Documentation
• Node SMTP setup
• Cypress email testing

PHP

• Documentation

Python

• Documentation

Ruby

• Documentation

For more clients see the developer documentation.

Production implementation paths

Use the docs with intent-specific implementation pages to ship faster:

• Build and validate message behavior in an Email Sandbox.
• Start with the canonical Email API capability guide.
• Implement receive flows with the Inbound Email API.
• Add parsing and extraction using Email Parser API workflows.
• Run release checks from the Email Testing tools hub.
• Verify sender and inbox performance with an Email Deliverability Test.