cypress-mailslurp
Advanced tools
Cypress email plugin for MailSlurp. Create test email accounts to send and receive emails in Cypress tests
Official MailSlurp email plugin for Cypress JS. Create real test email accounts. Send and receive emails and attachments in Cypress tests. For more advanced usage see the standard MailSlurp library.
npm install --save-dev cypress-mailslurp
Then include the plugin in your cypress/support/index.{js,ts} file.
import "cypress-mailslurp";
See the example project for setup help. Or run the example integration tests with CYPRESS_MAILSLURP_API_KEY=your-api-key npm run cypress.
MailSlurp is free but requires an API Key. Get yours by creating a free account.
Set the environment variable CYPRESS_MAILSLURP_API_KEY or use the cypress.json file env property:
For Mac/Linux set the CYPRESS_MAILSLURP_API_KEY environment variable:
CYPRESS_MAILSLURP_API_KEY=your-api-key cypress run
For Windows machines use the Powershell format $env:CYPRESS_MAILSLURP_API_KEY
$env:CYPRESS_MAILSLURP_API_KEY=your-api-key;
cypress run;
You can also configure Cypress using the config format.
{
"env": {
"MAILSLURP_API_KEY": "your-mailslurp-api-key"
}
}
MailSlurp requires timeouts to wait for inbound emails. Set timeouts in cypress.json:
{
"defaultCommandTimeout": 30000,
"responseTimeout": 30000,
"requestTimeout": 30000
}
MailSlurp adds the mailslurp command to the Cypress cy object. Include the type definition reference comment in your test file or support index.ts:
/// <reference types="cypress-mailslurp" />
Or define the type yourself like so:
import { MailSlurp } from "mailslurp-client";
declare global {
namespace Cypress {
interface Chainable {
mailslurp: () => Promise<MailSlurp>;
}
}
}
The Cypress MailSlurp plugin provide one simple command attached to the Cypress object: cy.mailslurp(). This method returns a MailSlurp client instance that has all the same methods and properties as the official MailSlurp client. Use the command with the then() method to access the instance:
cy.mailslurp().then(mailslurp => mailslurp.createInbox() /* etc */)
The client chained by the cy.mailslurp() has all the same methods and properties as the official MailSlurp client. See the Javascript documentation for a full API reference or see the examples below.
The MailSlurp client has a number of convenience methods and also exposes the full MailSlurp API as controllers. See the class reference for full method documentation.
You can create test email accounts with MailSlurp by creating inboxes. Inboxes have an id and an emailAddress. Save the id for later use when fetching or sending emails.
cy.mailslurp()
.then(mailslurp => mailslurp.createInbox())
.then(inbox => expect(inbox.emailAddress).to.contain("@mailslurp"));
Use the waitFor methods to wait for emails for an inbox. See the email object docs for full properties.
cy.mailslurp()
.then(mailslurp => mailslurp.waitForLatestEmail(undefined,undefined,inboxId,undefined,undefined, 30000, true))
.then(email => expect(email.subject).to.contain("My email"))
To send emails in Cypress tests first create an inbox then use the sendEmail method.
cy.mailslurp()
.then(mailslurp => mailslurp.sendEmail(inboxId, { to: ['test@example.com'], subject: 'test', body: '<html></html>', isHTML: true }))
To access all the MailSlurp methods available in the REST API and Javascript Client use the controllers on the mailslurp instance.
cy.mailslurp().then(mailslurp => mailslurp.attachmentController.uploadAttachment({
base64Contents: fileBase64Encoded,
contentType: 'text/plain',
filename: basename(pathToAttachment)
}))
Cypress has a unique async nature. To use MailSlurp effectively with Cypress chain your commands using then() or store results in wrapped aliases using wrap() and as().
before(function () {
return cy.mailslurp()
.then(mailslurp => mailslurp.createInbox())
.then(inbox => {
// save inbox id and email address to this (make sure you use function and not arrow syntax)
cy.wrap(inbox.id).as('inboxId')
cy.wrap(inbox.emailAddress).as('emailAddress')
})
});
it("01 - can load the demo application", function () {
// get wrapped email address and assert contains a mailslurp email address
expect(this.emailAddress).to.contain("@mailslurp");
// visit the demo application
cy.visit("https://playground.mailslurp.com")
cy.title().should('contain', 'React App');
});
Note: using
wrapto store values accross test methods requires you to usefunctionsyntax instead of() =>arrow syntax. This ensure thatthisis dynamically scoped and includes the aliased variables.
Here is an example of testing user sign up on a demo application hosted at playground.mailslurp.com.
It creates a new MailSlurp inbox before all tests and saves the inbox.id and inbox.emailAddress to a shared text context using the cy.wrap().as() methods.
It then loads the demo application, fills out a sign up form using the email address and receives a user confirmation code.
We wait for the email to arrive using the waitForLatestEmail method and then extract a confirmation code that can be submitted to the app to confirm the user.
/// <reference types="cypress-mailslurp" />
describe("user sign up test with mailslurp plugin", function () {
// use cypress-mailslurp plugin to create an email address before test
before(function () {
return cy.mailslurp()
.then(mailslurp => mailslurp.createInbox())
.then(inbox => {
// save inbox id and email address to this (make sure you use function and not arrow syntax)
cy.wrap(inbox.id).as('inboxId')
cy.wrap(inbox.emailAddress).as('emailAddress')
})
});
it("01 - can load the demo application", function () {
// get wrapped email address and assert contains a mailslurp email address
expect(this.emailAddress).to.contain("@mailslurp");
// visit the demo application
cy.visit("https://playground.mailslurp.com")
cy.title().should('contain', 'React App');
});
// use function instead of arrow syntax to access aliased values on this
it("02 - can sign up using email address", function () {
// click sign up and fill out the form
cy.get("[data-test=sign-in-create-account-link]").click()
// use the email address and a test password
cy.get("[name=email]").type(this.emailAddress).trigger('change');
cy.get("[name=password]").type('test-password').trigger('change');
// click the submit button
cy.get("[data-test=sign-up-create-account-button]").click();
});
it("03 - can receive confirmation code by email", function () {
// app will send user an email containing a code, use mailslurp to wait for the latest email
cy.mailslurp()
// use inbox id and a timeout of 30 seconds
.then(mailslurp => mailslurp.waitForLatestEmail(undefined,undefined,this.inboxId,undefined,undefined,30000, true))
// extract the confirmation code from the email body
.then(email => /.*verification code is (\d{6}).*/.exec(email.body!!)!![1])
// fill out the confirmation form and submit
.then(code => {
cy.get("[name=code]").type(code).trigger('change');
cy.get("[data-test=confirm-sign-up-confirm-button]").click();
})
});
// fill out sign in form
it("04 - can sign in with confirmed account", function () {
// use the email address and a test password
cy.get("[data-test=username-input]").type(this.emailAddress).trigger('change');
cy.get("[data-test=sign-in-password-input]").type('test-password').trigger('change');
// click the submit button
cy.get("[data-test=sign-in-sign-in-button]").click();
});
// can see authorized welcome screen
it("05 - can see welcome screen", function () {
// click sign up and fill out the form
cy.get("h1").should("contain", "Welcome");
});
});
See the Cypress example test suite for real tests that use this plugin.
FAQs
Cypress email and SMS plugin for MailSlurp. Create test email accounts to send and receive emails in Cypress tests. Read SMS and TXT messages too and test against fake mailservers.
The npm package cypress-mailslurp receives a total of 20,869 weekly downloads. As such, cypress-mailslurp popularity was classified as popular.
We found that cypress-mailslurp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.