使用MailCatcher和Codeception模块，轻松解决邮件测试难题-composer-PHP中文网

使用MailCatcher和Codeception模块，轻松解决邮件测试难题

PHPz

发布： 2025-06-16 10:55:32

原创

441人浏览过

Composer在线学习地址：学习地址

在开发过程中，我们经常需要验证应用是否正确发送了邮件，例如注册确认邮件、密码重置邮件等。手动检查这些邮件既耗时又容易出错。captbaritone/mailcatcher-codeception-module 通过集成 mailcatcher，提供了一种自动化的邮件测试方案。

MailCatcher 是一个简单的 SMTP 服务器，它会捕获所有发送给它的邮件，并将它们存储在一个 Web 界面中。这意味着你无需配置真实的邮件服务器，就可以轻松查看和验证你的应用发送的邮件。

Codeception 是一个 PHP 测试框架，它可以让你编写各种类型的测试，包括单元测试、功能测试和验收测试。captbaritone/mailcatcher-codeception-module 作为一个 Codeception 模块，提供了一系列方便的方法来与 MailCatcher 交互，从而实现邮件测试的自动化。

安装和配置

首先，使用 Composer 安装该模块：

composer require --dev captbaritone/mailcatcher-codeception-module

登录后复制

然后，在你的 acceptance.suite.yml 文件中启用该模块：

modules:
    enabled:
        - MailCatcher
    config:
        MailCatcher:
            url: 'http://127.0.0.1'
            port: '1080'

登录后复制

确保你的应用配置为通过 smtp://127.0.0.1:1025 发送邮件。

使用示例

以下是一个简单的示例，展示如何使用该模块来测试密码重置邮件：

<?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']", 'user@example.com');
$I->click('Submit');
$I->see('Please check your inbox');

$I->seeInLastEmail('Please click this link to reset your password');

登录后复制

在这个例子中，$I->resetEmails() 清空了 MailCatcher 中的所有邮件，$I->seeInLastEmail() 验证了最后一封邮件中是否包含指定的文本。

主要功能

resetEmails(): 清空 MailCatcher 中的所有邮件。
seeInLastEmail($text): 验证最后一封邮件中是否包含指定的文本。
seeInLastEmailTo($email, $text): 验证发送给指定邮箱的最后一封邮件中是否包含指定的文本。
dontSeeInLastEmail($text): 验证最后一封邮件中是否不包含指定的文本。
grabFromLastEmail($regex): 使用正则表达式从最后一封邮件中提取字符串。
grabUrlsFromLastEmail(): 从最后一封邮件中提取所有 URL。
seeEmailCount($count): 验证发送的邮件数量是否符合预期。 seeEmailAttachmentCount($expectCount): 验证最后一封邮件附件数量是否符合预期。 seeAttachmentInLastEmail($filename): 验证最后一封邮件是否包含某个文件名的附件。 grabAttachmentsFromLastEmail(): 获取最后一封邮件的所有附件。 grabLastEmail(): 获取最后一封邮件的完整邮件对象。 lastMessageFrom($email): 获取发送到指定邮箱的完整邮件对象。