Download the PHP package koehnlein/codeception-email-mailpit without Composer

Mailpit Module for the Codeception Testing Framework

This codeception module can be used to run tests against your Mailpit instance.

Mailpit was inspired by MailHog, which is not developed anymore. Because it is not a 1:1 replacement, the API changed and existing MailHog codeception modules cannot be used anymore.

This codeception module is based on oqq/codeception-email-mailhog (wich is a fork of ericmartel/codeception-email-mailhog) and brings nearly the same functionality for Mailpit as the mentioned modules did for MailHog.

Installation

Through composer, require the package:

Then turn it on in your Codeception suite yaml file

Additional parameters can be fed directly to the Guzzle connection using the guzzleRequestOptions variable.

The variable deleteEmailsAfterScenario can be set to true to ensure that all emails are deleted at the end of each scenario, but it is turned off by default.

Added Methods

This Module adds a few public methods for the user, such as:

Deletes all emails in Mailpit

Fetches all email headers from Mialpit, sorts them by timestamp and assigns them to the current and unread inboxes

Filters emails to only keep those that are received by the provided address

Pops the most recent unread email and assigns it as the email to conduct tests on

Pops the next attachment and assigns it as the attachment to conduct tests on

Example Test

Here is a simple scenario where we test the content of an email. For a detailed list of all available test methods, please refer to the [Codeception Email Testing Framework][CodeceptionEmailTestingFramework].

Migrate from MailHog Codeception Module

In case you want to switch from codeception-email-mailhog to this module, you need to follow these small steps:

Remove old MailHog module

Depending on which fork of codeception-email-mailhog you have installed, you can uninstall it with

or

or maybe any other package name of the fork, you use.

Add new Mailpit module instead

Update Codeception configuration:

Change module name in Codeception configuration file(s) from MailHog to Mailpit.

Refactor your Cests:

• Search for all $I->...EmailBody(...) occurrences and refactor to $I->...EmailTextBody(...) and/or $I->...EmailHtmlBody(...)
• The name in $I->canSeeInOpenedEmailSender is now encapsulated in double quotes. So if you used $I->canSeeInOpenedEmailSender('My Name <[email protected]>') before replace it with $I->canSeeInOpenedEmailSender('"My Name" <[email protected]>');