Repository files navigation

MailDev is sponsored by ⭐️inngest/inngest.

Inngest is the developer platform for easily building reliable workflows with zero infrastructure. Check it out and give it a star! ⭐️

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 ofNode.js.

If you want to use MailDev withDocker, you can use themaildev/maildev image on Docker Hub.For a guide for usage with Docker,checkout the docs.

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

Usage: maildev [options]

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

constMailDev=require("maildev");constmaildev=newMailDev();maildev.listen();maildev.on("new",function(email){// We got a new email!});

MailDev also has aREST API. For more infoview the docs.

Maildev optionally supports selectively relaying emails to an outgoing SMTP server. If you configure outgoingemail with the --outgoing-* options you can click "Relay" on an individual email to relay through MailDev outto a real SMTP service that will *actually* send the email to the recipient.

Example:

$ maildev --outgoing-host smtp.gmail.com \          --outgoing-secure \          --outgoing-user 'you@gmail.com' \          --outgoing-pass '<pass>'

Enabling the auto relay mode will automatically send each email to it's recipientwithout the need to click the "Relay" button mentioned above.The outgoing email options are required to enable this feature.

Optionally, you can specify a single email address to which Maildev will forwardall emails instead of the original recipient. For example, using--auto-relay you@example.com will forward all emails to that addressautomatically.

Additionally, you can pass a valid json file with additional configuration forwhich email addresses you would like toallow ordeny. The last matchingrule in the array will be the rule MailDev will follow.

Example:

$ maildev --outgoing-host smtp.gmail.com \          --outgoing-secure \          --outgoing-user 'you@gmail.com' \          --outgoing-pass '<pass>' \          --auto-relay \          --auto-relay-rules file.json

Rules example file:

[{"allow":"*"},{"deny":"*@test.com"},{"allow":"ok@test.com"},{"deny":"*@utah.com"},{"allow":"johnny@utah.com"}]

This would allowangelo@fbi.gov,ok@test.com,johnny@utah.com, but denybodhi@test.com.

Configure your application to send emails via port1025 and openlocalhost:1080 in your browser.

Nodemailer (v1.0+)

// We add this setting to tell nodemailer the host isn't secure during devprocess.env.NODE_TLS_REJECT_UNAUTHORIZED="0";consttransport=nodemailer.createTransport({port:1025,// other settings...});

Django -- AddEMAIL_PORT = 1025 in your settings file[source]

Rails -- config settings:

config.action_mailer.delivery_method=:smtpconfig.action_mailer.smtp_settings={address:"localhost",port:1025,enable_starttls_auto:false}

Drupal -- Install and configureSMTP module or use a library likeSwiftMailer.

Spring Boot -- configuration:
in application.properties file:

spring.mail.host=localhost #where the smtp server is runningspring.mail.port=1025spring.mail.username=no-reply@gmail.comspring.mail.properties.mail.smtp.starttls.enable=truespring.mail.properties.mail.smtp.starttls.required=truespring.mail.properties.mail.smtp.auth=truespring.mail.properties.mail.smtp.connectiontimeout=5000spring.mail.properties.mail.smtp.timeout=5000spring.mail.properties.mail.smtp.writetimeout=5000

Or in application.yml file:

spring:    mail:        properties:            mail:                smtp:                    starttls:                        enable: true                        required: true                    auth: true                    connectiontimeout: 5000                    timeout: 5000                    writetimeout: 5000        host: localhost        port: 1025

• Toggle between HTML, plain text views as well as view email headers
• Test responsive emails with resizable preview pane available for various screen sizes
• Ability to receive and view email attachments
• WebSocket integration keeps the interface in sync once emails are received
• Command line interface for configuring SMTP and web interface ports
• Ability to relay email to an upstream SMTP server

If you're using MailDev and you have a great idea, I'd love to hear it. If you're not using MailDev because it lacks a feature, I'd love to hear that too. Add an issue to the repohere.

Any help on MailDev would be awesome. There is plenty of room for improvement. Feel free tocreate a Pull Request from small to big changes.

To runMailDev during development:

npm installnpm run dev

The "dev" task will run MailDev using nodemon and restart automatically whenchanges are detected. On*.scss file save, the css will also be recompiled.Usingtest/send.js, a few test emails will be sent every time the applicationrestarts.

If you want to debug you can use thenodemon debug profile in VSCode. To change arguments or environment variables edit the.vscode\launch.json.

The project uses theJavaScript Standard coding style.To lint your code before submitting your PR, runnpm run lint.

To run the test suite:

$ npm test

MailDev is built on using great open source projects includingExpress,AngularJS,Font Awesome and two great projects fromAndris Reinman:smtp-serverandmailparser.Many thanks to Andris as his projects are the backbone of this app and toMailCatcher for the inspiration.

Additionally, thanks to all the awesomecontributorsto the project.

MIT