README.md

codeceptjs-remote-maildev

Maildev instance for CodeceptJS remote Maildev helper Runs a MailDev instance and exposes simple REST API for E2E testing applications with email functions. See Helper documentation for details.

The server is designed for testing with single client only.

Usage

Install dependiencies:

npm install

then

npm run serve

or

node index.js

Default REST API and SMTP ports are 8080 and 25 and can be overriden with environment variables: WEB_PORT and SMTP_PORT.

Docker

You can use kuzjka/codeceptjs-remote-maildev docker image. It exposes REST interface on 8080 port and listens for SMTP on 25 by default.

REST API

The API is designed solely for helper purposes

POST /haveMailbox

request:

{ "address": "[email protected]" }

response: 200 OK

GET /grabNextUnreadMail

response:

{ "empty": "true" }

{ "empty": "false", "mail": [MailObject] }

POST /reset

request: empty

response: 200 OK or 200 Maildev not running

References

Powered by MailDev

License

MIT