在開發過程中，我們經常需要驗證應用是否正確發送了郵件，例如注冊確認郵件、密碼重置郵件等。手動檢查這些郵件既耗時又容易出錯。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): 獲取發送到指定郵箱的完整郵件對象。
優勢和實際應用
captbaritone/mailcatcher-codeception-module 具有以下優勢：
- 自動化: 簡化了郵件測試流程，減少了手動操作。
- 可靠性: 確保郵件發送功能的正確性，避免了潛在的問題。
- 易于使用: 提供了簡單易用的 API，方便集成到 Codeception 測試中。
- 可配置性: 可以通過配置選項來滿足不同的測試需求。
在實際應用中，你可以使用該模塊來測試以下場景：
- 用戶注冊：驗證注冊確認郵件是否正確發送，并包含正確的鏈接。
- 密碼重置：驗證密碼重置郵件是否正確發送，并包含正確的鏈接。
- 訂單確認：驗證訂單確認郵件是否包含正確的訂單信息。
- 通知郵件：驗證各種通知郵件是否正確發送，并包含正確的內容。
通過使用 captbaritone/mailcatcher-codeception-module，你可以有效地提高 Web 應用的質量，并確保郵件發送功能的穩定性和可靠性。
