Mailserver

MailDev is a Free Email Testing Solution for Developers

SMTP server & web interface for viewing and testing emails during development.

Hazem Abbas

Aug 14, 2024 — 2 min read

Table of Content

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.

Features

SMTP Server for Catching Emails
Web Interface to View and Inspect Emails
Support for HTML and Plain Text Emails
Email Attachments Support
REST API for Automated Testing
View Email Headers and Raw Source
Quick Email Deletion and Management
Programmatic & CLI
Browser notifications
Relay
Dark Theme
Real-time

Install and Run with Docker

$ docker run -p 1080:1080 -p 1025:1025 soulteary/maildev

Run as Node.js APp

MailDev can be used in your Node.js application. For more info view the API docs.

const MailDev = require("maildev");

const maildev = new MailDev();

maildev.listen();

maildev.on("new", function (email) {
  // We got a new email!
});

MailDev also has a REST API. For more info view the docs.

License

Copyright (c) 2023 Dan Farrelly

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.