Email as a service

Send and receive real emails from applications or tests.

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.

Validate invoices

If your app sends bills or legal documents you want to know they are correct. Trigger the actions in a test and use a MailSlurp email to receive and parse the response.

Test password reset

Test the reset password flow.

Test GDPR compliance

If your site is under GDPR regulations test the automatic data mailing with MailSlurp.

Create Account

Integrations

REST API

A simple HTTP API for creating inboxes, sending emails, and receiving messages.

Javascript Client

`npm install mailslurp-client` and call MailSlurp from Jest, Mocha or where ever you need it.

Swagger Docs

Create your own client or use pre-generated libraries in Java, Python, C#, Ruby or Go.

Documentation How it works

Code Examples


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

// create a new private email address
const { id, emailAddress } = await api.createNewEmailAddress()

// receive email
const receivedEmail = await api.waitForLatestEmail(emailAddress)

// send email 
const email = { to: ['support@myapp.com'], body: 'hello!' }
await api.sendEmailSimple(email)

// send from a known address
await api.sendEmail(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)
})