Getting Started with PHP

Learn how to automate email testing in PHP

Testing email in PHP

Learn how to automate email testing in PHP.

Before you start

If you don’t already have one, create a Mailosaur account.

Make sure you know how to send email to Mailosaur first. Once you have this working, you’re ready to start testing!

Installing Mailosaur

Mailosaur provides an official PHP client library to make testing email in PHP a lot easier.

Install via composer:

You can install the bindings via Composer. Run the following command:

composer require mailosaur/mailosaur

To use the client library, use Composer’s autoload:


Authenticating with Mailosaur

In order to connect to Mailosaur, you need to add your API key to your tests. You access your API key via the account settings screen.

Retrieving an email

Once you have sent an email to test, for example by emailing something@{SERVER_ID}, you can now use the code below to retrieve the message in PHP:

# 1. Import Mailosaur and create an instance of the MailosaurClient, using your API key
use Mailosaur\MailosaurClient;
use Mailosaur\SearchCriteria;

$mailosaur = new MailosaurClient('YOUR_API_KEY');

// 2. Build search criteria to find the email you have sent
$criteria = new SearchCriteria();
$criteria->sentTo = 'something@{SERVER_ID}';

// 3. Wait for the message (by default only looks for messages received in the last hour)
$message = $mailosaur->messages->get('{SERVER_ID}', criteria);

// 4. Assert that the email subject is what we expect
$this->assertEquals('Reset your password', $email->subject);

Mailosaur extracts any links found within both the HTML and text content of an email. These are then made available via $message->html->links and $message->text->links.

You can use these links for many scenarios, such as completing a password reset process:

# Wait for the message
$message = $mailosaur->messages->get('{SERVER_ID}', $criteria);

# Check that we have the password reset email
$this->assertEquals('Reset your password', $email->subject);

# Store the password reset link (e.g. to use in a test that completes the process)
$passwordResetLink = $message->text->links[0]->href;

Extracting content from email HTML

If you need to extract content from the body of an email, such as a verification code, then you can use a library in your tests.

Let’s imagine that message->html->body contains:

  <h1>To activate your account, enter this code:</h1>
  <p class="verify-code">542163</p>

To work with the email’s HTML, you can use DomDocument and DomXPath:

# Wait for the message
$message = $mailosaur->messages->get('{SERVER_ID}', $criteria);

# Extract the verification code from HTML
$doc = new DOMDocument();

$cssClass = 'verify-code';
$xpath = new DomXPath($doc);
$matches = $xpath->query("//*[contains(concat(' ', normalize-space(@class), ' '), ' $cssClass ')]");

$verificationCode = $matches[0]->textContent;