resilient-mailer-mandrill
v0.1.2
Published
Mandrill provider implementation for resilient-mailer
Downloads
2
Readme
resilient-mailer-mandrill
resilient-mailer-mandrill
implements Mandrill as an email provider for
resilient-mailer
.
var MandrillProvider = require('resilient-mailer-mandrill');
var mandrill = new MandrillProvider('MyApiKey');
var mailer; // ResilientMailer instance
mailer.registerProvider(mandrill);
Installation
$ npm install resilient-mailer-mandrill
Usage
Create an instance of the provider. There are also a number of options you can alter:
var MandrillProvider = require('resilient-mailer-mandrill');
var options = {
ipPool: '192.0.2.23', // see: http://help.mandrill.com/entries/24182062
async: true, // see 'async' field: https://mandrillapp.com/api/docs/messages.html#method-send
apiSecure: false, // allows the use of HTTP rather than HTTPS
apiHostname: '127.0.0.1', // allows alternative hostname
apiPort: 8080 // allows unusual ports
};
var mandrill = new MandrillProvider('MyApiKey', options);
To register the provider with your ResilientMailer
instance:
var mailer; // ResilientMailer instance
mailer.registerProvider(mandrill);
In the event that you want to use MandrillProvider
directly (rather than the
usual way - via ResilientMailer
):
var message = {
from: '[email protected]',
to: ['[email protected]'],
subject: 'Testing my new email provider',
textBody: 'Seems to be working!',
htmlBody: '<p>Seems to be working!</p>'
};
mandrill.send(message, function (error) {
if (!error)
console.log('Success! The message sent successfully.');
else
console.log('Message sending failed - ' + error.message);
});
To see everything available in the message
object, refer to
resilient-mailer.
Testing
Install the development dependencies first:
$ npm install
Then the tests:
$ npm test
Support
Please open an issue on this repository.
Authors
- James Billingham [email protected]
License
MIT licensed - see LICENSE file