Test your application with real email addresses.

An API for testing email functionality. Create unique email addresses during tests. Send and receive emails to test your application's email functionality.

Features

Create Unlimited Email Addresses

Create real inboxes on the fly via HTTP or SDK. Use them in your tests for clean-slate test environments.

Send Emails via REST

Compose and send emails from unique addresses. Test email your app's email response and parsing functionality.

Receive Inbound Email

Sign up a user with a randomized address. Test that your app sends verification codes, transactional mail, and much more.

Use cases

Test user sign up

Create a new email address for each test. Sign up with the unique address. Receive and extract verification codes from confirmation emails.

Test email notifications

If your app sends email alerts or transactional mail use MailSlurp email inboxes to capture and validate the messages.

Test automated responses

Test email-driven actions and automated responses. Create a new email address during a test, send email from the address, then verify your app's response.

Start Free More MailSlurp use cases

Found this awesome tool called @mailslurp. Definitely worth checking out! Their support is legendary too.
Trent, Developer, nib.com.au

Code Examples

MailSlurp has a simple REST API plus a range of official SDKs. Here are some Javascript code examples to demonstrate MailSlurp's key features. MailSlurp is an email testing tool so should be used in your integration or end-to-end tests to test the email related aspects of your application.


import { MailSlurp } from "mailslurp-client"
const api = new MailSlurp({ apiKey: "test" })

const newEmailInbox = await api.createInbox()

const email = { to: ['support@myapp.com'], body: 'hello!' }
await api.sendEmail(inbox.id, email)


// javascript jest example. other SDKs and REST APIs available
import { MailSlurp } from "mailslurp-client"
const api = new MailSlurp({ apiKey: "test" })

test('my app can receive and handle emails', async () => {
    // create a new email address for this test
    const inbox = await api.createInbox()

    // send an email from the address to your application
    await api.sendEmail(inbox.id, { to: [myAppAddress] })

    // assert that app has handled the email
    expect(myAppReceivedEmail()).resolves.toBe(true)
})


// can your app handle inbound emails
import { MailSlurp } from "mailslurp-client"
const api = new MailSlurp({ apiKey: "test" })

test('my app can send emails', async () => {
    // create a new email address for this test
    const inbox = await api.createInbox()

    // trigger an app action that sends an email
    await signUpForMyApp(inbox.emailAddress)

    // fetch welcome email from the inbox
    const emails = await api.getEmails(inbox.id, { minCount: 1 })

    // assert that the correct email was sent
    expect(emails[0].length).toBe(1)
    expect(emails[0].content).toBe(expectedContent)
})


// use mailslurp to fetch signup verification codes
import { MailSlurp } from "mailslurp-client"
const api = new MailSlurp({ apiKey: "test" })

test('user can sign up and verify account', async () => {
    // create a new email address for this test
    const inbox = await api.createInbox()

    // trigger an app action that sends an email
    signUpForMyApp(inbox.emailAddress)

    // fetch account verification email from the inbox
    const emails = await api.getEmails(inbox.id, { minCount: 1 })

    // parse the verification code from the email contents
    const verificationCode = /code = (.*)/.exec(emails[0].content)[1]

    // use verification code to finish sign up
    await verifyAccountInApp(inbox.emailAddress, verificationCode)

    // assert that app verified user account
    expect(userIsVerified(inbox.emailAddress)).resolves.toBe(true)
})

Documentation