dmoen/mailtrap-test-helper

Test helper library for testing email submissions through Mailtrap, based on PHPUnit

v1.2.0 2017-10-06 20:07 UTC

Requires

• php: >=5.5
• guzzlehttp/guzzle: ^6.3
• phpunit/phpunit: ^6.3

Requires (Dev)

• phpmailer/phpmailer: ^6.0
• vlucas/phpdotenv: ^2.4

MIT

• Daniel Moen

README

Test helper library for testing email submissions through Mailtrap, based on PHPUnit.

Installation

This package can be installed via Composer:

composer require dmoen/mailtrap-test-helper --dev

Usage

Create an instance of MailTrapInbox with api key and id of the inbox:

$inbox = new MailTrapInbox('api_key', 'inbox_id');  

Example using a PHPUnit test case. Before each test the inbox should be cleaned:

private $inbox;

public function setUp()
{
    parent::setUp();

    $this->inbox = new MailTrapInbox('api_key', 'inbox_id'));
    $this->inbox->deleteAllMessages();
}

Simple inbox testing

Test if the inbox has any messages:

$inbox->assertHasMails();  

Test if the inbox has any messages from a specific address:

$inbox->assertHasMailFrom("[e-mail]");

With name:

$inbox->assertHasMailFrom("[e-mail]", "Sender Sendersson");

Test if the inbox has any messages to a specific address:

$inbox->assertHasMailFor("[e-mail]");

With name:

$inbox->assertHasMailFor("[e-mail]", "Receiver Receiversson");

Test if inbox has a message with a subject:

$inbox->assertHasMailWithSubject('Lorem subject');

Test if inbox has a message with a specific body:

$inbox->assertHasMailWithHtmlContent('<b>Lorem ipsum sit amet</b>');
$inbox->assertHasMailWithTextContent('Lorem ipsum sit amet');

A bit more advanced testing for specific emails

To retrieve a specific message in the inbox:

$inbox->getLastMessage()
$inbox->getFirstMessage()

Or if you know the specific index in the inbox:

$message = $inbox->getMessage(2);

You can also search the inbox for a specific unique message using a condition:

$message = $inbox->findUnique(function($message){
    return $message->to_email == "[e-mail]";
});

Or retrieve an array of all messages or by condition:

$messages = $inbox->fetchAllMessages();

$messages = $inbox->findMessages(function($message){
    return $message->to_email == "[e-mail]";
});

The message instance passed to the closure has all the properties retrieved from the Mailtrap API: http://docs.mailtrap.apiary.io/#reference/message/apiv1inboxesinboxidmessagesid/get

The message(s) can then be tested with a combination of tests:

$message->assertIsFrom("[e-mail]", "Private Person")
    ->assertIsFor("[e-mail]", "A Test User")
    ->assertHasSubject("SMTP e-mail test")
    ->assertHasTextContent("This is a test e-mail message")
    ->assertHasHtmlContent("<b>Lorem ipsum sit amet.</b>");