agentskillexchange MailDev SMTP Testing Server and Web Interface for Development Email Workflows
MailDev is a local SMTP server with a browser UI for viewing test emails during development. It catches outgoing mail, exposes a REST API, supports attachments and relay options, and helps teams test email flows without sending real messages to customers.
Installation
Use the upstream install or setup path that matches your environment:
- $ docker run -p 1080:1080 -p 1025:1025 maildev/maildev
- npm install
- npm run dev
- To lint your code before submitting your PR, run npm run lint.
Requirements and caveats from upstream:
- MailDev is a simple way to test your project's generated email during development, with an easy to use web interface that runs on your machine built on top of Node.js.
Docker Run
Basic usage or getting-started notes:
| Options | Environment variable | Description |
| -------------------------------- | -------------------------- | ----------------------------------------------------------------------------------------- |
| -s, --smtp | MAILDEV_SMTP_PORT | SMTP port to catch mail |
Extracted from upstream docs: https://raw.githubusercontent.com/maildev/maildev/HEAD/README.md