Test code with real emails addresses.

Create ephemeral inboxes via REST. Then send and receive from them.

Code examples

Add MailSlurp to your test-suite.

Test email dependent apps.

Complete end-to-end testing.

MailSlurp is easy to integrate and will extend your test coverage to every crucial function.


// 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)
})