Download the PHP package johnatannvmd/codeception-mailchecker-module without Composer

Codeception MailChecker Module

This repo is abandoned. Please use https://github.com/captbaritone/codeception-mailcatcher-module instead or any other similar project.

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

It was inspired by the https://github.com/captbaritone/codeception-mailcatcher-module and https://github.com/fetch/zend-mail-codeception-module/.

It supports several mail testing tools:

• MailCatcher
• MailDump
• ZendMail
• LatherMail
• MailHog
• Mailtrap
• [Imap Server] included

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

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:

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

Example Usage

seeInLastEmail

Checks that an email contains a value. It searches the full raw text of the email: headers, subject line, and body.

Example:

• Param $text

seeInLastEmailTo

Checks that the last email sent to an address contains a value. It searches the full raw text of the email: headers, subject line, and body.

This is useful if, for example a page triggers both an email to the new user, and to the administrator.

Example:

• Param $email
• Param $text

dontSeeInLastEmail

Checks that an email does NOT contain a value. It searches the full raw text of the email: headers, subject line, and body.

Example:

• Param $text

dontSeeInLastEmailTo

Checks that the last email sent to an address does NOT contain a value. It searches the full raw text of the email: headers, subject line, and body.

Example:

• Param $email
• Param $text

seeAttachmentFilenameInLastEmail

Checks that the last email have attachment with following filename.

Example:

• Param $expectedFilename

dontSeeAttachmentFilenameInLastEmail)

Checks that the last email does NOT have attachment with following filename.

Example:

• Param $unexpectedFilename

seeAttachmentFilenameInLastEmailTo

Checks that the last sent to an address have attachment with following filename.

Example:

• Param $address
• Param $expectedFilename

dontSeeAttachmentFilenameInLastEmailTo

Checks that the last sent to an address does NOT have attachment with following filename.

Example:

• Param $address
• Param $unexpectedFilename

seeAttachmentsCountInLastEmail

Asserts that a certain number of attachments found in the last email.

Example:

• Param $exected

seeAttachmentsCountInLastEmailTo

Asserts that a certain number of attachments found in the last email to a given address.

Example:

• Param $address
• Param $expected

seeCcInLastEmail

Look for the expected CC address in the last sent email.

Example:

• Param $expectedAddress

seeCcInLastEmailTo

Look for the expected CC address in the last sent email to a given address.

Example:

• Param $address
• Param $expectedAddress

grabMatchesFromLastEmail

Extracts an array of matches and sub-matches from the last email based on a regular expression. It searches the full raw text of the email: headers, subject line, and body. The return value is an array like that returned by preg_match().

Example:

• Param $regex

grabFromLastEmail

Extracts a string from the last email based on a regular expression. It searches the full raw text of the email: headers, subject line, and body.

Example:

• Param $regex

grabMatchesFromLastEmailTo

Extracts an array of matches and sub-matches from the last email to a given address based on a regular expression. It searches the full raw text of the email: headers, subject line, and body. The return value is an array like that returned by preg_match().

Example:

• Param $email
• Param $regex

grabFromLastEmailTo

Extracts a string from the last email to a given address based on a regular expression. It searches the full raw text of the email: headers, subject line, and body.

Example:

• Param $email
• Param $regex

seeEmailCount

Asserts that a certain number of emails have been sent since the last time clearMailbox() was called.

Example:

• Param $count

Docker

Now you can build all modules at once by:

License

Released under the same licence as Codeception: MIT