dmoen/mailtrap-test-helper

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

Mailtrap test helper

Test helper library for testing email submissions through Mailtrap, based on PHPUnit., _(*1)

Installation

This package can be installed via Composer:, _(*2)

``` bash composer require dmoen/mailtrap-test-helper --dev, <sub>(*3)</sub>

## Usage

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

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

Example using a PHPUnit test case. Before each test the inbox should be cleaned:, <sub>(*4)</sub>

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:, <sub>(*5)</sub>

$inbox->assertHasMails();  

Test if the inbox has any messages from a specific address:, <sub>(*6)</sub>

$inbox->assertHasMailFrom("sender@example.com");

With name:, <sub>(*7)</sub>

$inbox->assertHasMailFrom("sender@example.com", "Sender Sendersson");

Test if the inbox has any messages to a specific address:, <sub>(*8)</sub>

$inbox->assertHasMailFor("reciever@example.com");

With name:, <sub>(*9)</sub>

$inbox->assertHasMailFor("reciever@example.com", "Receiver Receiversson");

Test if inbox has a message with a subject:, <sub>(*10)</sub>

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

Test if inbox has a message with a specific body:, <sub>(*11)</sub>

$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:, <sub>(*12)</sub>

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

Or if you know the specific index in the inbox:, <sub>(*13)</sub>

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

You can also search the inbox for a specific unique message using a condition:, <sub>(*14)</sub>

$message = $inbox->findUnique(function($message){
    return $message->to_email == "receiver@example.com";
});

Or retrieve an array of all messages or by condition:, <sub>(*15)</sub>

$messages = $inbox->fetchAllMessages();

$messages = $inbox->findMessages(function($message){
    return $message->to_email == "receiver@example.com";
});

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, <sub>(*16)</sub>

The message(s) can then be tested with a combination of tests:, <sub>(*17)</sub>

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