MailDev v0.5.1

SMTP Server + Web Interface for viewing and testing emails during development.

Fork me on Github

MailDev is a simple way to test your projects' emails during development with an easy to use web interface that runs on your machine.

Features

  • Toggle between HTML, plain text views as well as view email headers
  • Test Responsive Emails w/ resizeable preview pane available for 320/480/600px screen sizes
  • Receive and view email attachments
  • New emails appear instantly in interface when received (via Websockets)
  • Command line interface for configuring SMTP and Web interface ports
  • Build on Node.js & hosted on NPM

Requirements - Node.js

Install & Run

Use npm to download and install MailDev.


  $ npm install -g maildev

Run the app


  $ maildev

Alternately, you can download MailDev as a ZIP File, TAR Ball, or just grab the source off GitHub.

Usage

  maildev [options]

    -h, --help         output usage information
    -V, --version      output the version number
    -s, --smtp [port]  SMTP port to catch emails [1025]
    -w, --web [port]   Port to run the Web GUI [1080]
    -o, --open         Open the Web GUI after startup
    -v, --verbose

Configure your project

Configure your application to send emails via port 1025 and open localhost:1080.

Example Setups

  • Node — Nodemailer:
    var transport = nodemailer.createTransport("SMTP", {
      port: 1025
      // other settings...
    });
    
  • Django — add EMAIL_PORT = 1025 in your settings file [source]
  • Rails — add the port to your config settings:
    config.action_mailer.delivery_method = :smtp
      config.action_mailer.smtp_settings = {
        :address => "localhost",
        :port => 1025
      }
    

Roadmap

  • Forward email to real email address for device/application testing
  • Write tests for server and client
  • Have an idea or feature request? I would love to here it. Create an issue on github or contact me on twitter @djfarrelly

Changelog

0.5.1 - Fix menu layout issue in Safari/Webkit

0.5.0 - Add command line interface. Web UI redesign.

0.4.0 - Add ability to receive and view attachments

0.3.1 - Added Socket.io to notify interface of new email

0.3.0 - Initial open source release

Thanks

Thanks to Andris Reinman for creating his projects that are the backbone of this app and MailCatcher for the inspiration.

License

MailDev is released under the MIT license