PHPackages                             johnatannvmd/codeception-mailchecker-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. johnatannvmd/codeception-mailchecker-module

Abandoned → [captbaritone/mailcatcher-codeception-module](/?search=captbaritone%2Fmailcatcher-codeception-module)ArchivedLibrary[Mail & Notifications](/categories/mail)

johnatannvmd/codeception-mailchecker-module
===========================================

Test emails in your Codeception acceptance tests

21.3kPHP

Pushed 8y ago1 watchersCompare

[ Source](https://github.com/johnatannvmd/codeception-mailchecker-module)[ Packagist](https://packagist.org/packages/johnatannvmd/codeception-mailchecker-module)[ RSS](/packages/johnatannvmd-codeception-mailchecker-module/feed)WikiDiscussions master Synced yesterday

READMEChangelog (6)DependenciesVersionsUsed By (0)

Codeception MailChecker Module
==============================

[](#codeception-mailchecker-module)

This repo is abandoned. Please use  instead or any other similar project.

[![Build Status](https://camo.githubusercontent.com/245231a9f166efc30e42adf0e7ded4183ed7e5b1dfb4b3e6c64e5c78b5830578/68747470733a2f2f7472617669732d63692e6f72672f6a6f686e6174616e6e766d642f636f646563657074696f6e2d6d61696c636865636b65722d6d6f64756c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/johnatannvmd/codeception-mailchecker-module)[![Coverage Status](https://camo.githubusercontent.com/049ea71785e8ec5461228684c533ba5b2b23caebd6fd52c74e52355d2157102f/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6a6f686e6174616e6e766d642f636f646563657074696f6e2d6d61696c636865636b65722d6d6f64756c652f62616467652e7376673f6272616e63683d6d617374657226736572766963653d676974687562)](https://coveralls.io/github/johnatannvmd/codeception-mailchecker-module?branch=master)

This module will let you test emails that are sent during your Codeception acceptance tests.

It was inspired by the  and .

It supports several mail testing tools:

- [MailCatcher](http://mailcatcher.me/)
- [MailDump](https://github.com/ThiefMaster/maildump)
- [ZendMail](https://github.com/zendframework/zend-mail)
- [LatherMail](https://github.com/reclosedev/lathermail)
- [MailHog](https://github.com/mailhog/MailHog)
- [Mailtrap](https://mailtrap.io)
- \[Imap Server\] included

Installation
------------

[](#installation)

Add the packages into your `composer.json`. For example we add Guzzle lib for MailCatcher for MailDump provider:

```
{
    "require-dev": {
        "codeception/codeception": "*",
        "johnatannvmd/mailchecker-codeception-module": "1.*"
    }
}

```

Tell Composer to download the package:

```
php composer.phar update

```

Then enable it in your `acceptance.suite.yml` configuration and set the url and port of your site's MailCatcher installation:

```
class_name: WebGuy
modules:
    enabled:
        - MailChecker
    config:
        MailChecker:
            provider: MailCatcher
            options:
                url: 'http://project.dev'
                port: '1080'

```

Optional Configuration
----------------------

[](#optional-configuration)

If you need to specify some special options (e.g. SSL verification or authentication headers), you can set all of the allowed [Guzzle request options](http://docs.guzzlephp.org/en/latest/request-options.html):

```
class_name: WebGuy
modules:
    enabled:
        - MailChecker
    config:
        MailChecker:
            provider: MailDump
            options:
                url: 'http://project.dev'
                port: '1080'
                guzzleOptions:
                    auth: ['yo', 'yo']

```

Example Usage
-------------

[](#example-usage)

```