This module will let you test emails that are sent during your Codeception acceptance tests. It depends upon you having MailCatcher installed on your development server.
It was inspired by the Codeception blog post: Testing Email in PHP. It is currently very simple. Send a pull request or file an issue if you have ideas for more features.
-
Add the package to your
composer.json:composer require --dev captbaritone/mailcatcher-codeception-module -
Configure your project to actually send emails through
smtp://127.0.0.1:1025in the test environment -
Enable the module in your
acceptance.suite.yml:modules: enabled: - MailCatcher config: MailCatcher: url: 'http://127.0.0.1' port: '1080'
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:
- MailCatcher
config:
MailCatcher:
url: 'http://127.0.0.1'
port: '1080'
guzzleRequestOptions:
verify: false
debug: true
version: 1.0
<?php
$I->wantTo('Get a password reset email');
// Clear old emails from MailCatcher
$I->resetEmails();
// Reset password
$I->amOnPage('forgotPassword.php');
$I->fillField("input[name='email']", '[email protected]');
$I->click('Submit');
$I->see('Please check your inbox');
$I->seeInLastEmail('Please click this link to reset your password');Clears the emails in MailCatcher's list. This prevents seeing emails sent during a previous test. You probably want to do this before you trigger any emails to be sent
Example:
<?php
// Clears all emails
$I->resetEmails();
?>
Checks expected count of attachments in last email.
Example:
<?php
$I->seeEmailAttachmentCount(1);
?>
- Param $expectCount
Checks that last email contains an attachment with filename.
Example:
<?php
$I->seeAttachmentInLastEmail('image.jpg');
?>
- Param $filename
Checks that an email contains a value. It searches the full raw text of the email: headers, subject line, and body.
Example:
<?php
$I->seeInLastEmail('Thanks for signing up!');
?>
- Param $text
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:
<?php
$I->seeInLastEmailTo('[email protected]', 'Thanks for signing up!');
$I->seeInLastEmailTo('[email protected]', 'A new user has signed up!');
?>
- Param $email
- Param $text
Checks that an email does NOT contain a value. It searches the full raw text of the email: headers, subject line, and body.
Example:
<?php
$I->dontSeeInLastEmail('Hit me with those laser beams');
?>
- Param $text
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:
<?php
$I->dontSeeInLastEmailTo('[email protected]', 'But shoot it in the right direction');
?>
- Param $email
- Param $text
Grab Attachments From Email
Returns array with the format [ [filename1 => bytes1], [filename2 => bytes2], ...]
Example:
<?php
$attachments = $I->grabAttachmentsFromLastEmail();
?>
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:
<?php
$matches = $I->grabMatchesFromLastEmail('@<strong>(.*)</strong>@');
?>
- Param $regex
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:
<?php
$match = $I->grabFromLastEmail('@<strong>(.*)</strong>@');
?>
- Param $regex
Extracts an array of urls from the last email. It searches the full raw body of the email. The return value is an array of strings.
Example:
<?php
$urls = $I->grabUrlsFromLastEmail();
?>
Grab the full email object sent to an address.
Example:
<?php
$email = $I->lastMessageFrom('[email protected]');
$I->assertNotEmpty($email['attachments']);
?>
Grab the full email object from the last email.
Example:
<?php
$email = $I->grabLastEmail();
$I->assertNotEmpty($email['attachments']);
?>
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:
<?php
$matchs = $I->grabMatchesFromLastEmailTo('[email protected]', '@<strong>(.*)</strong>@');
?>
- Param $email
- Param $regex
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:
<?php
$match = $I->grabFromLastEmailTo('[email protected]', '@<strong>(.*)</strong>@');
?>
- Param $email
- Param $regex
Asserts that a certain number of emails have been sent since the last time
resetEmails() was called.
Example:
<?php
$match = $I->seeEmailCount(2);
?>
- Param $count
Released under the same license as Codeception: MIT
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent