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!
Support the project
I know this is a tiny module but many people use it in production (high5 to all of us) - if you happen to use this module please click the star button - it means a lot to all the contributors
Quickstart - Example
Create a new file, install the dependencies  and look at the skeleton code below to get you started quickly!
const nodemailer = ;const mg = ;// This is your API key that you retrieve from www.mailgun.com/cp (free up to 10K monthly emails)const auth =auth:api_key: 'key-1234123412341234'domain: 'one of your domain names listed at your 'proxy: '' // optional proxy, default is falseconst nodemailerMailgun = nodemailer;nodemailerMailgun;
const mailOptions =...attachments:filename: 'text2.txt'content: 'hello world!''utf-8'
with encoded string as attachment content:
const mailOptions =...attachments:filename: 'text1.txt'content: 'aGVsbG8gd29ybGQh'encoding: 'base64'
with encoded string as an inline attachment:
// Replace `filename` with `cid`const mailOptions =...attachments:cid: 'logo.png'content: 'aGVsbG8gd29ybGQh'encoding: 'base64'
<!-- Reference the `cid` in your email template file -->
The "from", "to", "cc", and "bcc" fields support an address object or array of address objects. Each "name" and "address" are converted to
"name <address>" format. "name" is optional, "address" is required. Missing or null address in object is skipped.
from: name: 'Sales' address: 'firstname.lastname@example.org'to: name:'Mary' address:'email@example.com' address:'firstname.lastname@example.org'
is converted to:
from: 'Sales <email@example.com>'to: 'Mary <firstname.lastname@example.org>,email@example.com'
Now with Consolidate.js templates
If you pass a "template" key an object that contains a "name" key, an "engine" key and, optionally, a "context" object, you can use Handlebars templates to generate the HTML for your message. Like so:
const handlebars = ;const contextObject =variable1: 'value1'variable2: 'value2';nodemailerMailgun;
You can use any of the templating engines supported by Consolidate.js. Just require the engine module in your script, and pass a string of the engine name to the
template object. Please see the Consolidate.js documentation for supported engines.
You can use two different region environments for your mailgun domains. For USA region you should use api endpoint
api.mailgun.net, but for EU region
You can pass it as "host" to transport options object:
const nodemailer = ;const mg = ;const options =auth:api_key: 'key-1234123412341234'domain: 'one of your domain names listed at your 'host: 'api.eu.mailgun.net' // e.g. for EU regionconst nodemailerMailgun = nodemailer;
 Quickly install dependencies
npm install nodemailernpm install nodemailer-mailgun-transport
Legacy Node.js versions
Versions of Node.js before 7.6 are supported via
const nodemailer = ;const mg = ;