Skip to content

Commit 035af67

Browse files
committed
Added installation instructions
1 parent 4646647 commit 035af67

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

Diff for: README.md

+21
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
This Codeception Module implements the required methods to test emails using the [Codeception Email Testing Framework][CodeceptionEmailTestingFramework] with [MailHog]
44

5+
### Installation
6+
Through composer, require the package:
7+
```
8+
"require-dev": {
9+
"ericmartel/codeception-email-mailhog": "^1.0"
10+
}
11+
```
12+
Then turn it on in your Codeception suite yaml file
13+
```
14+
class_name: FunctionalTester
15+
modules:
16+
enabled:
17+
- MailHog
18+
config:
19+
MailHog:
20+
url: 'http://mailhog.dev'
21+
port: '8025'
22+
```
23+
Additional parameters can be fed directly to the Guzzle connection using the `guzzleRequestOptions` variable.
24+
25+
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.
526
### Added Methods
627
This Module adds a few public methods for the user, such as:
728
```

0 commit comments

Comments
 (0)