Simple Node.js module for Mailgun.
npm install mailgun-js
This is a simple Node.js module for interacting with the Mailgun API. This module is intended to be used within Node.js environment and not from the browser. For browser use the mailgun.js module.
Please see Mailgun Documentation for full Mailgun API reference.
This module works by providing proxy objects for interacting with different resources through the Mailgun API.
Most methods take a data parameter, which is a Javascript object that would contain the arguments for the Mailgun API.
All methods take a final parameter callback with two parameters: error, and body.
We try to parse the body into a javascript object, and return it to the callback as such for easier use and inspection by the client.
If there was an error a new Error object will be passed to the callback in the error parameter.
If the error originated from the (Mailgun) server, the response code will be available in the statusCode property
of the error object passed in the callback.
See the /docs folder for detailed documentation. For full usage examples see the /test folder.
var api_key = 'key-XXXXXXXXXXXXXXXXXXXXXXX';
var domain = 'www.mydomain.com';
var mailgun = require('mailgun-js')({apiKey: api_key, domain: domain});
var data = {
from: 'Excited User <me@samples.mailgun.org>',
to: 'serobnic@mail.ru',
subject: 'Hello',
text: 'Testing some Mailgun awesomeness!'
};
mailgun.messages().send(data, function (error, body) {
console.log(body);
});Note that the to field is required and should contain all recipients ("TO", "CC" and "BCC") of the message (see https://documentation.mailgun.com/api-sending.html#sending). Additionally cc and bcc fields can be specified. Recipients in those fields will be addressed as such.
Messages stored using the Mailgun store() action can be retrieved using messages(<message_key>).info() function.
Optionally the MIME representation of the message can be retrieved if MIME argument is passed in and set to true.
Something more elaborate. Get mailing list info, create a member and get mailing list members and update member. Notice that the proxy objects can be reused.
var list = mailgun.lists('mylist@mycompany.com');
list.info(function (err, data) {
// `data` is mailing list info
console.log(data);
});
var bob = {
subscribed: true,
address: 'bob@gmail.com',
name: 'Bob Bar',
vars: {age: 26}
};
list.members().create(bob, function (err, data) {
// `data` is the member details
console.log(data);
});
list.members().list(function (err, members) {
// `members` is the list of members
console.log(members);
});
list.members('bob@gmail.com').update({ name: 'Foo Bar' }, function (err, body) {
console.log(body);
});
list.members('bob@gmail.com').delete(function (err, data) {
console.log(data);
});Mailgun object constructor options:
apiKey- Your Mailgun API KEYpublicApiKey- Your public Mailgun API KEYdomain- Your Mailgun Domain (Please note: domain field isMY-DOMAIN-NAME.com, not https://api.mailgun.net/v3/MY-DOMAIN-NAME.com)mute- Set totrueif you wish to mute the console error logs invalidateWebhook()functionproxy- The proxy URI in formathttp[s]://[auth@]host:port. ex:'http://proxy.example.com:8080'timeout- Request timeout in millisecondshost- the mailgun host (default: 'api.mailgun.net')protocol- the mailgun protocol (default: 'https:', possible values: 'http:' or 'https:')port- the mailgun port (default: '443')endpoint- the mailgun host (default: '/v3')retry- the number of total attempts to do when performing requests. Default is1. That is, we will try an operation only once with no retries on error. You can also use a config object compatible with theasynclibrary for more control as to how the retries take place. See docs here
Attachments can be sent using either the attachment or inline parameters. inline parameter can be use to send an
attachment with inline disposition. It can be used to send inline images. Both types are supported with same mechanisms
as described, we will just use attachment parameter in the documentation below but same stands for inline.
Sending attachments can be done in a few ways. We can use the path to a file in the attachment parameter.
If the attachment parameter is of type string it is assumed to be the path to a file.
var filepath = path.join(__dirname, 'mailgun_logo.png');
var data = {
from: 'Excited User <me@samples.mailgun.org>',
to: 'serobnic@mail.ru',
subject: 'Hello',
text: 'Testing some Mailgun awesomeness!',
attachment: filepath
};
mailgun.messages().send(data, function (error, body) {
console.log(body);
});We can pass a buffer (has to be a Buffer object) of the data. If a buffer is used the data will be attached using a
generic filename "file".
var filepath = path.join(__dirname, 'mailgun_logo.png');
var file = fs.readFileSync(filepath);
var data = {
from: 'Excited User <me@samples.mailgun.org>',
to: 'serobnic@mail.ru',
subject: 'Hello',
text: 'Testing some Mailgun awesomeness!',
attachment: file
};
mailgun.messages().send(data, function (error, body) {
console.log(body);
});We can also pass in a stream of the data. This is useful if you're attaching a file from the internet.
var request = require('request');
var file = request("https://www.google.ca/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png");
var data = {
from: 'Excited User <me@samples.mailgun.org>',
to: 'serobnic@mail.ru',
subject: 'Hello',
text: 'Testing some Mailgun awesomeness!',
attachment: file
};
mailgun.messages().send(data, function (error, body) {
console.log(body);
});Finally we provide a Mailgun.Attachment class to add attachments with a bit more customization. The Attachment
constructor takes an options object. The options parameters can have the following fields:
data- can be one of- a string representing file path to the attachment
- a buffer of file data
- an instance of
Streamwhich means it is a readable stream.
filename- the file name to be used for the attachment. Default is 'file'contentType- the content type. Required for case ofStreamdata. Ex.image/jpeg.knownLength- the content length in bytes. Required for case ofStreamdata.
If an attachment object does not satisfy those valid conditions it is ignored. Multiple attachments can be sent by
passing an array in the attachment parameter. The array elements can be of any one of the valid types and each one
will be handled appropriately.
var mailgun = require('mailgun-js')({apiKey: api_key, domain: domain});
var filename = 'mailgun_logo.png';
var filepath = path.join(__dirname, filename);
var file = fs.readFileSync(filepath);
var attch = new mailgun.Attachment({data: file, filename: filename});
var data = {
from: 'Excited User <me@samples.mailgun.org>',
to: 'serobnic@mail.ru',
subject: 'Hello',
text: 'Testing some Mailgun awesomeness!',
attachment: attch
};
mailgun.messages().send(data, function (error, body) {
console.log(body);
});var mailgun = require('mailgun-js')({apiKey: api_key, domain: domain});
var filename = 'mailgun_logo.png';
var filepath = path.join(__dirname, filename);
var fileStream = fs.createReadStream(filepath);
var fileStat = fs.statSync(filepath);
msg.attachment = new mailgun.Attachment({
data: fileStream,
filename: 'my_custom_name.png',
knownLength: fileStat.size,
contentType: 'image/png'});
mailgun.messages().send(data, function (error, body) {
console.log(body);
});Sending messages in MIME format can be accomplished using the sendMime() function of the messages() proxy object.
The data parameter for the function has to have to and message properties. The message property can be a full
file path to the MIME file, a stream of the file, or a string representation of the MIME
message. To build a MIME string you can use the nodemailer library.
Some examples:
var domain = 'mydomain.org';
var mailgun = require('mailgun-js')({ apiKey: "YOUR API KEY", domain: domain });
var MailComposer = require('nodemailer/lib/mail-composer');
var mailOptions = {
from: 'you@samples.mailgun.org',
to: 'mm@samples.mailgun.org',
subject: 'Test email subject',
text: 'Test email text',
html: '<b> Test email text </b>'
};
var mail = new MailComposer(mailOptions);
mail.compile().build((err, message) => {
var dataToSend = {
to: 'mm@samples.mailgun.org',
message: message.toString('ascii')
};
mailgun.messages().sendMime(dataToSend, (sendError, body) => {
if (sendError) {
console.log(sendError);
return;
}
});
});var filepath = '/path/to/message.mime';
var data = {
to: fixture.message.to,
message: filepath
};
mailgun.messages().sendMime(data, function (err, body) {
console.log(body);
});var filepath = '/path/to/message.mime';
var data = {
to: fixture.message.to,
message: fs.createReadStream(filepath)
};
mailgun.messages().sendMime(data, function (err, body) {
console.log(body);
});members().create({data}) will create a mailing list member with data. Mailgun also offers a resource for creating
members in bulk. Doing a POST to /lists/<address>/members.json adds multiple members, up to 1,000 per call,
to a Mailing List. This can be accomplished using members().add().
var members = [
{
address: 'Alice <alice@example.com>',
vars: { age: 26 }
},
{
name: 'Bob',
address: 'bob@example.com',
vars: { age: 34 }
}
];
mailgun.lists('mylist@mycompany.com').members().add({ members: members, subscribed: true }, function (err, body) {
console.log(body);
});Mailgun-js also provides helper methods to allow users to interact with parts of the api that are not exposed already.
These are not tied to the domain passed in the constructor, and thus require the full path with the domain
passed in the resource argument.
mailgun.get(resource, data, callback)- sends GET request to the specified resource on api.mailgun.post(resource, data, callback)- sends POST request to the specified resource on api.mailgun.delete(resource, data, callback)- sends DELETE request to the specified resource on api.mailgun.put(resource, data, callback)- sends PUT request to the specified resource on api.
Example: Get some stats
mailgun.get('/samples.mailgun.org/stats', { event: ['sent', 'delivered'] }, function (error, body) {
console.log(body);
});Module works with Node-style callbacks, but also implements promises with the promisify-call library.
mailgun.lists('mylist@mydomain.com').info().then(function (data) {
console.log(data);
}, function (err) {
console.log(err);
});The function passed as 2nd argument is optional and not needed if you don't care about the fail case.
The Mailgun object also has a helper function for validating Mailgun Webhook requests (as per the mailgun docs for securing webhooks). This code came from this gist.
Example usage:
var mailgun = require('mailgun-js')({apiKey: api_key, domain: domain});
function router(app) {
app.post('/webhooks/mailgun/*', function (req, res, next) {
var body = req.body;
if (!mailgun.validateWebhook(body.timestamp, body.token, body.signature)) {
console.error('Request came, but not from Mailgun');
res.send({ error: { message: 'Invalid signature. Are you even Mailgun?' } });
return;
}
next();
});
app.post('/webhooks/mailgun/catchall', function (req, res) {
// actually handle request here
});
}These routes require Mailgun public API key. Please check Mailgun email validation documentation for more responses details.
mailgun.validate(address, private, options, fn)
Checks if email is valid.
private- wether it's private validateoptions- any additional options
Example usage:
var mailgun = require('mailgun-js')({apiKey: api_key, domain: domain});
mailgun.validate('test@mail.com', function (err, body) {
if(body && body.is_valid){
// do something
}
});Parses list of email addresses and returns two lists:
- parsed email addresses
- unparseable email addresses
Example usage:
var mailgun = require('mailgun-js')({apiKey: api_key, domain: domain});
mailgun.parse([ 'test@mail.com', 'test2@mail.com' ], function (err, body) {
if(error){
// handle error
}else{
// do something with parsed addresses: body.parsed;
// do something with unparseable addresses: body.unparseable;
}
});To run the test suite you must first have a Mailgun account with a domain setup. Then create a file named ./test/data/auth.json, which contains your credentials as JSON, for example:
{ "api_key": "key-XXXXXXXXXXXXXXXXXXXXXXX", "public_api_key": "pubkey-XXXXXXXXXXXXXXXXXXXXXXX", "domain": "mydomain.mailgun.org" }You should edit ./test/data/fixture.json and modify the data to match your context.
Then install the dev dependencies and execute the test suite:
$ npm install
$ npm test
The tests will call Mailgun API, and will send a test email, create route(s), mailing list and mailing list member.
This project is not endorsed by or affiliated with Mailgun. The general design and some code was heavily inspired by node-heroku-client.
Copyright (c) 2012 - 2017 OneLobby and Bojan D.
Licensed under the MIT License.