Playwright MailSlurp testing

MailSlurp integrates easily with existing Playwright projects. Simple add the NodeJS, Java, CSharp or Python MailSlurp package to your test environment and you can create email addresses, send and receive emails, and send and receive TXT messages.

Examples

Resources

• Test SMS OTP
• Email magic links
• Email testing example project
• Get free API KEY

Tutorial

Get started

In order to use MailSlurp in your Playwright tests you need to do two things:

• Obtain and configure an API KEY
• Install the MailSlurp client library for your language

Javascript

npm install --save mailslurp-client

CSharp

dotnet add package mailslurp

Java

For Maven add:

<!-- place inside the <dependencies> block -->
<dependency>
  <groupId>com.mailslurp</groupId>
  <artifactId>mailslurp-client-java</artifactId>
  <version>LATEST</version>
  <type>pom</type>
</dependency>

For gradle add:

dependencies {
    implementation("com.mailslurp:mailslurp-client-java")
}

Python

pip install mailslurp-client

Use MailSlurp within your tests

You can now use MailSlurp to create email addresses, send and receive emails, and send and receive TXT messages. Here is an example of how to use MailSlurp in a Playwright test:

import { test, expect, Page } from '@playwright/test';
import MailSlurp from "mailslurp-client";

test.describe('test email login with playwright', () => {
  test('can login and verify email address with mailslurp', async ({ page }) => {
    const apiKey = process.env.API_KEY;
    expect(apiKey).toBeDefined();

    // load playground app
    await page.goto("https://playground.mailslurp.com");
    await page.click('[data-test="sign-in-create-account-link"]');

    // create a new inbox
    const mailslurp = new MailSlurp({ apiKey })
    const password = "test-password"
    const { id, emailAddress } = await mailslurp.createInbox()

    // fill sign up form
    await page.fill('input[name=email]', emailAddress);
    await page.fill('input[name=password]', password);
    await page.click('[data-test="sign-up-create-account-button"]');

    // wait for verification code
    const email = await mailslurp.waitForLatestEmail(id)

    // extract the confirmation code (so we can confirm the user)
    const code = /([0-9]{6})$/.exec(email.body)[1];

    // enter confirmation code
    await page.fill('[data-test="confirm-sign-up-confirmation-code-input"]', code);
    await page.click('[data-test="confirm-sign-up-confirm-button"]');

    // fill out username (email) and password
    await page.fill('[data-test="username-input"]', emailAddress);
    await page.fill('[data-test="sign-in-password-input"]', password);
    // submit
    await page.click('[data-test="sign-in-sign-in-button"]');
    await page.waitForSelector("[data-test='greetings-nav']")
  });

});

Example projects

For more examples see the [MailSlurp examples repository] or the following:

• Playwright JS email example
• Playwright JS sms testing