Skip to main content

WebdriverIO email and OTP testing

MailSlurp works well with WebdriverIO when WebdriverIO drives the app and the MailSlurp JavaScript SDK handles inbox creation and message retrieval. That lets you test real email OTP, magic-link, reset-password, and notification flows inside the same suite.

Install​

npm install --save mailslurp-client

Create an inbox with the JavaScript SDK​

Loading...

Example WebdriverIO OTP flow​

import { MailSlurp } from "mailslurp-client";

const mailslurp = new MailSlurp({ apiKey: process.env.API_KEY });

describe("sign up flow", () => {
  it("verifies an email OTP", async () => {
    const inbox = await mailslurp.createInbox();

    await browser.url("https://your-app.example/sign-up");
    await $('input[name="email"]').setValue(inbox.emailAddress);
    await $('input[name="password"]').setValue("correct horse battery staple");
    await $('button[type="submit"]').click();

    const email = await mailslurp.waitController.waitForLatestEmail({
      inboxId: inbox.id,
      timeout: 120000,
      unreadOnly: true,
    });

    const match = await mailslurp.emailController.getEmailContentMatch({
      emailId: email.id,
      contentMatchOptions: {
        pattern: "(?:verification code|OTP|code)[:\\s-]*(\\d{6})",
      },
    });

    await $('input[name="verificationCode"]').setValue(match.matches[1]);
    await $('button[type="submit"]').click();

    await expect($('[data-test="dashboard"]')).toBeDisplayed();
  });
});

Example projects​

Loading examples...