Selenium test email plugins: send and receive email in tests (Java tutorial)
Receive emails in Java test suites using MailSlurp, Junit, and Selenium.
Selenium is a powerful browser testing framework. This article will show you how to use real email addresses in Selenium tests - no mail server required.
Introduction
Many web applications rely on email: for user sign-up, password reset, newsletters, support responses and more.
This presents a challenge for QA testers using Selenium: how do we test email related processes? Well with free test email account APIs like MailSlurp we can create email addresses within tests and control them from code.
Let's see an example.
The source code for this example is available on GitHub. See the docs for a Java language guide.
Example usage
For this example let's write a Selenium test to sign a user up to a dummy web application.
The test app
We'll test against playground.mailslurp.com for this example, a simple React application with a user sign-up process.
Sign up process
The playground allows a user to sign-up with an email address and password. The app then sends them the user an email containing a confirmation code. The user must copy the code and submit it to the app to confirm their account.
Once confirmed the user can access a picture of a dog by logging in!
We will test this process end to end.
Test process
We use Selenium to load the playground login form in Firefox. Then we use MailSlurp to generate an email address. Then we enter the email address into the sign up form, receive the welcome email with MailSlurp, extract the verification code and confirm the user. We'll go over each step with examples.
First let's setup the project to include Junit, Selenium, and the MailSlurp Java SDK.
Maven setup
MailSlurp is now published to Maven central
Create a pom.xml
like so:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>java-maven-selenium</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>com.mailslurp</groupId>
<artifactId>mailslurp-client-java</artifactId>
<version>LATEST</version>
</dependency>
<dependency>
<groupId>org.seleniumhq.selenium</groupId>
<artifactId>selenium-java</artifactId>
<version>3.4.0</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
Gradle setup
Or if you use Gradle create a build.gradle
like so:
plugins {
id 'java'
}
group 'org.example'
version '1.0-SNAPSHOT'
sourceCompatibility = 1.8
repositories {
mavenCentral()
}
dependencies {
testCompile 'junit:junit:4.12'
testCompile 'org.seleniumhq.selenium:selenium-java:3.4.0'
// mailslurp client
testCompile 'com.mailslurp:mailslurp-client-java:11.5.10'
}
Import classes
You can import MailSlurp under com.mailslurp.*
import com.mailslurp.apis.*;
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.models.*;
Download WebDriver
Next you need to download webdriver for your platform. We prefer GeckoDriver for automating Firefox but you can use ChromeDriver with Chrome or any other if you prefer.
Configure Selenium
Now we can create a test and configure Selenium and MailSlurp. You need an API Key to use MailSlurp but it is free for personal use. Get an API Key here then create a test like this:
public class ExampleUsageTest {
private static final String YOUR_API_KEY = "your_mailslurp_api_key_here";
// set a timeout as fetching emails might take time
private static final Long TIMEOUT_MILLIS = 30000L;
private static final String WEBDRIVER_PATH = "/path/to/your/webdriver";
private static ApiClient mailslurpClient;
private static WebDriver driver;
@BeforeClass
public static void beforeAll() {
// setup mailslurp
mailslurpClient = com.mailslurp.client.Configuration.getDefaultApiClient();
mailslurpClient.setApiKey(YOUR_API_KEY);
mailslurpClient.setConnectTimeout(TIMEOUT_MILLIS.intValue());
// setup webdriver
System.setProperty("webdriver.gecko.driver", WEBDRIVER_PATH);
driver = new FirefoxDriver();
driver.manage().timeouts().implicitlyWait(TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
}
}
The test
Now we can write some tests.
Load the application
Let's load the application and assert that the title is as we expect.
private static final String PLAYGROUND_URL = "https://playground.mailslurp.com";
@Test
public void test1_canLoadAuthenticationPlayground() {
driver.get(PLAYGROUND_URL);
assertEquals(driver.getTitle(), "React App");
}
To run the test run mvn install test
. The result looks like this:
Start sign-up
Now let's click the sign-up button and load the sign-up page.
@Test
public void test2_canClickSignUpButton() {
driver.findElement(By.cssSelector("[data-test=sign-in-create-account-link]")).click();
}
Create the an email address
Next we will create a new email address using the MailSlurp client.
private static Inbox inbox;
@Test
public void test3_canCreateEmailAddressAndSignUp() throws ApiException {
// create a real, randomized email address with MailSlurp to represent a user
InboxControllerApi inboxControllerApi = new InboxControllerApi(mailslurpClient);
inbox = inboxControllerApi.createInbox(null,null,null,null, null, null);
// check the inbox was created
assertNotNull(inbox.getId());
assertTrue(inbox.getEmailAddress().contains("@mailslurp.com"));
// fill the playground app's sign-up form with the MailSlurp
// email address and a random password
driver.findElement(By.name("email")).sendKeys(inbox.getEmailAddress());
driver.findElement(By.name("password")).sendKeys(TEST_PASSWORD);
// submit the form to trigger the playground's email confirmation process
// we will need to receive the confirmation email and extract a code
driver.findElement(By.cssSelector("[data-test=sign-up-create-account-button]")).click();
}
The result should look like this:
Receive confirmation email
Now we can use MailSlurp to receive the confirmation email that is sent by playground.
private static Email email;
@Test
public void test4_canReceiveConfirmationEmail() throws ApiException {
// receive a verification email from playground using mailslurp
WaitForControllerApi waitForControllerApi = new WaitForControllerApi(mailslurpClient);
email = waitForControllerApi.waitForLatestEmail(inbox.getId(), TIMEOUT_MILLIS, UNREAD_ONLY);
// verify the contents
assertTrue(email.getSubject().contains("Please confirm your email address"));
}
Then we can extract the confirmation code from email body using regex pattern:
private static String confirmationCode;
@Test
public void test5_canExtractConfirmationCodeFromEmail() {
// create a regex for matching the code we expect in the email body
Pattern p = Pattern.compile(".*verification code is (\\d+).*");
Matcher matcher = p.matcher(email.getBody());
// find first occurrence and extract
assertTrue(matcher.find());
confirmationCode = matcher.group(1);
assertTrue(confirmationCode.length() == 6);
}
Confirm the user and login
Now that we have the confirmation code we can submit the code to the Playground and then login with a confirmed account. If successful we can verfiy the welcome message.
/**
* Submit the confirmation code to the playground to confirm the user
*/
@Test
public void test6_canSubmitVerificationCodeToPlayground() {
driver.findElement(By.name("code")).sendKeys(confirmationCode);
driver.findElement(By.cssSelector("[data-test=confirm-sign-up-confirm-button]")).click();
}
/**
* Test sign-in as confirmed user
*/
@Test
public void test7_canLoginWithConfirmedUser() {
// load the main playground login page
driver.get(PLAYGROUND_URL);
// login with now confirmed email address
driver.findElement(By.name("username")).sendKeys(inbox.getEmailAddress());
driver.findElement(By.name("password")).sendKeys(TEST_PASSWORD);
driver.findElement(By.cssSelector("[data-test=sign-in-sign-in-button]")).click();
// verify that user can see authenticated content
assertTrue(driver.findElement(By.tagName("h1")).getText().contains("Welcome"));
}
/**
* After tests close selenium
*/
@AfterClass
public static void afterAll() {
driver.close();
}
Next steps
This article showed how to test email related processes like user sign-up in Selenium with Java and MailSlurp. In this test we used them to create a new test email account with a unique email address. we then used the email address to sign-up a user and receive a confirmation code. MailSlurp is free for personal use and has bindings for several popular languages. You can use it to create email addresses on demand then send and receive emails and attachments in code. Check it out.
Related content
Golang email library
Golang Email Library for sending and receiving emails in Go over SMTP or HTTP/S.
Java email client: send and receive emails and attachments i...
MailSlurp Java SDK for sending and receive email and attachments on the JVM.
Email for testing
Test email accounts for email testing. Alternatives to Mailinator, MailTrap, Mailosaur and more.
How to wait for Selenium to start during Codeception tests
Example tutorial for how to wait until webdriver and Selenium have started during Codeception PHP tests
Using Email APIs to send and receive emails
Generate dynamic email addresses on demand with MailSlurp - a modern email API.
Email API for email marketing and more
APIs for email marketing and social campaign testing. Send, receive, validate and test emails in code and online.
How to test an email address
Test email accounts for testing email addresses in code or online. Create fake email accounts for testing.
How to start selenium in a background process and wait for i...
Spawn Selenium server process before tests start for easier acceptance testing.
Stripe get all customers list (example)
Stripe get all customers list (example)
Send and receive email in Cypress JS tests with MailSlurp
Test email sign-up. password verification and more with Cypress JS and MailSlurp.
Cypress Email Plugin - Test email accounts in Javascript (an...
Use real email accounts in CypressJS to test user sign-up, email verification, and more.
Golang mail Library (SMTP)
How to send and receive emails in Go (test email addresses).
Email APIs for Java and Kotlin projects
Test email sending and receive emails without a mail server.
Java TestNG Selenium user sign up testing with real email ad...
Testing user sign up in Java using TestNG and MailSlurp test email accounts
Codeception PHP acceptance testing using real email address ...
Write acceptance tests in PHP with real email addresses using Codeception and MailSlurp
PHP Email Test Plugins: send and receive email in PHPUnit (e...
How to send and receive emails in PHPUnit tests.
PyTest email testing
Send and receive email in Pytest Python tests.
Selenium test email plugins: send and receive email in tests...
Receive emails in Java test suites using MailSlurp, Junit, and Selenium.
Receive email in PHP: using MailSlurp to send and receive em...
Test email in PHP using real email addresses
Robotframework Python Testing using real email addresses
Python automation email testing Robotframework plugin
Testing authentication using real email addresses in Ruby wi...
Cucumber example project using Capybara to test user authentication using real email addresses.
Test applications with real emails using Serenity BDD, JBeha...
Email acceptance testing with Serenity and MailSlurp. Test applications with real email addresses.
.NET SpecFlow testing using MailSlurp email accounts and Sel...
How to test .NET authentication and sign-up using real email accounts with MailSlurp and SpecFlow.
Test email accounts with Jest and Puppeteer
Test email accounts in React with Jest and Puppeteer. Send and receive emails in Javascript.
Test Emails in Selenium with DotNet, CSharp and MailSlurp
Send and receive email in DotNET Nunit tests using Selenium and MailSlurp.
Test emails with Cucumber and Ruby
Generate test email accounts with Ruby and Cucumber. Test email sign-up, password verification and more.
Test user sign-up with NodeJS and WebDriver
Test email related processes like sign-up and verification using WDIO WebDriver and MailSlurp.
TestCafe end-to-end MFA testing for user sign-up and email v...
End-to-end testing with MailSlurp, NodeJS, and TestCafe.
How To Test Emails Before You Send
There are many free tools to test emails before sending. This can help prevent spam warnings and increase deliverability...
Testing OTP password link username and password for 2 factor...
Testing OTP password link username and password for 2 factor authentication (2FA)
Test email address
Free test email address for testing emails online with web dashboard or REST API.
Testing email-related functionality with MailSlurp
Use MailSlurp to test email related functionality using real email addresses.
Testing email with Cypress test email accounts
Test email accounts for CypressJS. End-to-end testing with real email addresses using MailSlurp Cypress plugin.
Testing Webhooks
How to test HTTP webhooks using MailSlurp test hooks.
Send SMTP email with Java
How to use Java SMTP client to send email with MailSlurp mail server on the JDK
Testing Email with Cypress JS and MailSlurp
Email testing with Cypress JS