alexandresalome/mailcatcher

A library to access MailCatcher

MailCatcher for PHP

, _(*1)

Integrates MailCatcher in your PHP application., _(*2)

• View CHANGELOG
• View CONTRIBUTORS

MailCatcher is a simple SMTP server with an HTTP API, and this library aims to integrate it to make it easy to use it with PHP., _(*3)

Behat extension

This library provides a Behat extension to help you test mails in your application., _(*4)

To use it, you first need to be sure MailCatcher is properly installed and running. You can use docker to execute it:, _(*5)

docker run -d -p 1080:1080 -p 1025:1025 --name mailcatcher schickling/mailcatcher

First, configure in your behat.yml:, _(*6)

default:
    extensions:
        Alex\MailCatcher\Behat\MailCatcherExtension\Extension:
            url: http://localhost:1080
            purge_before_scenario: true

Then, add the MailCatcherContext context in your FeatureContext file:, _(*7)

use Alex\MailCatcher\Behat\MailCatcherContext;
use Behat\Behat\Context\BehatContext;

class FeatureContext extends BehatContext
{
   public function __construct(array $parameters)
   {
      $this->useContext('mailcatcher', new MailCatcherContext());
   }
}

Available steps

This extension provides you mail context in your tests. To use assertions, you must first open a mail using criterias., _(*8)

Once it's opened, you can make assertions on it and click in it., _(*9)

Server manipulation, _(*10)

Deletes all messages on the server, _(*11)

• When I purge mails

Mail opening, _(*12)

• When I open mail from "foo@example.org"
• When I open mail containing "a message"
• When I open mail to "me@example.org"
• When I open mail with subject "Welcome, mister Bond!"

Assertion, _(*13)

Verify number of messages sent to the server:, _(*14)

• Then 1 mail should be sent
• Then 13 mails should be sent

Verify text presence in message:, _(*15)

• Then I should see "something" in mail
• Then I should see "something else" in mail

Verify text presence in mail without opening:, _(*16)

• Then I should see mail from "foo@example.org"
• Then I should see mail containing "a message"
• Then I should see mail to "me@example.org"
• Then I should see mail with subject "Welcome, mister Bond!"

Custom mailcatcher context

Only available from PHP 5.4, _(*17)

If you want to create a context class that relates to MailCatcher, you can use the MailCatcherTrait to get the mailcatcher client injected inside your class:, _(*18)

use Alex\MailCatcher\Behat\MailCatcherAwareInterface;
use Alex\MailCatcher\Behat\MailCatcherTrait;
use Alex\MailCatcher\Message;
use Behat\Behat\Context\Context;

class WelcomeContext implements Context, MailCatcherAwareInterface
{
    use MailCatcherTrait;

    /**
     * @Then /^a welcome mail should be sent$/
     */
    public function testTrait()
    {
        $this->findMail(Message::SUBJECT_CRITERIA, 'Welcome!');
    }
}

This trait offers the following methods:, _(*19)

• getMailCatcherClient(): returns the mailcatcher Client instance.
• findMail($criteria, $value): facility to search for a given message, or throws an exception if not found

Don't forget to implement the MailCatcherAwareInterface to get the mailcatcher client injected inside your context class., _(*20)

Client API

Browse easily your API with the integrated SDK:, _(*21)

$client = new Alex\MailCatcher\Client('http://localhost:1080');

// Returns all messages
$messages = $client->search();

// Count messages
$client->getMessageCount();

// Filter messages
$messages = $client->search(array(
    'from'        => 'bob@example.org',
    'to'          => 'alice@example.org',
    'subject'     => 'Bla',
    'contains'    => 'Hello',
    'attachments' => true,
    'format'      => 'html',
), $limit = 3);

// Search one message
$message = $client->searchOne(array('subject' => 'Welcome'));

Message API, _(*22)

// Message API, get the content of a message
$subject = $message->getSubject();
$plainTextBody = $message->getPart('text/plain')->getContent();
$htmlBody = $message->getPart('text/html')->getContent();

// Message API, return a Person object or an array of Person object
$person  = $message->getFrom();
$persons = $message->getRecipients();

// Person API
$person = $message->getFrom();

$name = $person->getName(); // null means not provided
$mail = $person->getMail();

// Attachments
$message->hasAttachments();
$message->getAttachments();

// Delete
$message->delete();

Attachment API, _(*23)

// Attachment API
$attachment->getFilename();
$attachment->getSize();
$attachment->getType();
$attachment->getContent();