kuzjka/codeceptjs-remote-maildev repository overview

⁠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.

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

⁠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⁠