From 3ad7bcc5265ef9499bc144b2261d5e1c0df65d05 Mon Sep 17 00:00:00 2001 From: Thomas Landauer Date: Wed, 11 Dec 2024 19:23:31 +0100 Subject: [PATCH 1/2] Update README.md: Minor updates --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ab8b6a5..da6c0e2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Mailpit Module for the Codeception Testing Framework -This codeception module can be used to run tests against your [Mailpit](https://github.com/axllent/mailpit) instance. +This [Codeception](https://codeception.com/) module can be used to run tests against your [Mailpit](https://github.com/axllent/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. @@ -10,19 +10,18 @@ This codeception module is based on [oqq/codeception-email-mailhog](https://gith brings nearly the same functionality for Mailpit as the mentioned modules did for MailHog. ## Installation -Through composer, require the package: +With Composer: ```shell -composer req koehnlein/codeception-email-mailpit --dev +composer require koehnlein/codeception-email-mailpit --dev ``` -Then turn it on in your Codeception suite yaml file +Then enable it in your `Functional.suire.yml`: ```yaml -class_name: FunctionalTester modules: enabled: - Mailpit config: Mailpit: - url: 'http://mailpit.dev' + url: 'http://localhost' port: '8025' ``` Additional parameters can be fed directly to the Guzzle connection using the `guzzleRequestOptions` variable. From b9174640cf6f6b966257d27b506d25b0d324b362 Mon Sep 17 00:00:00 2001 From: Thomas Landauer Date: Sat, 14 Dec 2024 18:00:55 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index da6c0e2..4cbb074 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ With Composer: ```shell composer require koehnlein/codeception-email-mailpit --dev ``` -Then enable it in your `Functional.suire.yml`: +Then enable it in your `Functional.suite.yml` or `Acceptance.suite.yml`: ```yaml modules: enabled: