nodemailer-mailgun-transport

What is this?

nodemailer is an amazing node module to send emails within any of your nodejs apps. This is the transport plugin that goes with nodemailer to send email using Mailgun's awesomeness! Pow Pow.

How does it work?

Based on this mailgun-js module and the nodemailer module, the Mailgun Transport was born. This is a transport layer, meaning it will allow you to send emails using nodemailer, using the Mailgun API instead of the SMTP protocol!

Nodemailer allows you to write code once and then swap out the transport so you can use different accounts on different providers. On top of that it's a super solid way of sending emails quickly on your node app(s).

The Mailgun transport for nodemailer is great to use when SMTP is blocked on your server or you just prefer the reliability of the web api!

Quickstart - Example

Create a new file, install the dependencies [1] and look at the skeleton code below to get you started quickly!

var nodemailer = require('nodemailer');
var mg = require('nodemailer-mailgun-transport');

// This is your API key that you retrieve from www.mailgun.com/cp (free up to 10K monthly emails)
var auth = {
  auth: {
    api_key: 'key-1234123412341234',
    domain: 'one of your domain names listed at your https://mailgun.com/app/domains'
  }
}

var nodemailerMailgun = nodemailer.createTransport(mg(auth));

nodemailerMailgun.sendMail({
  from: 'myemail@example.com', 
  // OR from: { name: "Firstname Lastname", address: "myemail@example" }
  to: 'recipient@domain.com', // An array if you have multiple recipients.
  cc: 'second@domain.com',
  bcc: 'secretagent@company.gov',
  subject: 'Hey you, awesome!',
  // You can use "html:" to send HTML email content. It's magic!
  html: '<b>Wow Big powerful letters</b>',
  // You can use "text:" to send plain-text content. It's oldschool!
  text: 'Mailgun rocks, pow pow!',
  
  // Optional
  replyTo: 'reply2this@company.com',
  testmode: false,
  tracking: true,
  trackingClicks: true,
  trackingOpens: true,
  tag: ["September newsletter", "newsletter"],
  dkim: false,
  requireTls: false
}, function (err, info) {
  if (err) {
    console.log('Error: ' + err);
  }
  else {
    console.log('Response: ' + info);
  }
});

[1] Quickly install dependencies

npm install nodemailer
npm install git+https://github.com/molinto/nodemailer-mailgun-transport.git --save