super_mailer v1.0.11

Introduction

super_mailer is a multiple mail service API connector, include AWS SES, Sendgrid, Mandrill and Mailgun. You can set your default mail service, once there's a failure exists, super_mailer will try another mail service for you automatically.

Supporting Mail Services

• Sendgrid
• Mailgun
• Mandrill - Merge with MailChimp from April 27, 2016
• Amazon SES

After sign up those services and get the neccessary API Key settings, then you can start to use super_mailer then :)

Installation

$ npm install super_mailer
$ cp mailer.env.example mailer.env

Information you should fill in your mailer.env

export SENDGRID_API_KEY='<SENDGRID_API_KEY>'
export MAILGUN_SAND_BOX='<MAILGUN_SAND_BOX>'
export MAILGUN_API_KEY='<MAILGUN_API_KEY>'
export MANDRILL_API_KEY='<MANDRILL_API_KEY>'
export AMZSES_API_KEY_ID='<AMZSES_API_KEY_ID>'
export AMZSES_SECRET_KEY='<AMZSES_SECRET_KEY>'
export AMZSES_VALID_MAILBOX='<AMZSES_VALID_MAILBOX>'

Then $ source ./mailer.env to enable those information.

Usage

Usage example:

var super_mailer = require('super_mailer');
from_email = "test@eamil.com";
to_email = "test@eamil.com";
subject = "Test";
content = "This is a test mail. Enjoy it!";
default_service = 'sendgrid';
super_mailer(from_email, to_email, subject, content);

You can choose your prefer default_service, such as 'sendgrid', 'mailgun', 'mandrill' and 'amazonses'

Configuration

You can also setup default service / stub email addresses for testing in config/default.json.

Modify the example data below:

{
    "default": "mandrill",
    "amazonses": {
        "stub": {
            "to_email": "success@simulator.amazonses.com",
            "subject": "Welcome to Amazon SES",
            "content": "Enjoy it!"
        }
    },
    "sendgrid": {
        "endpoint": "https://api.sendgrid.com/v3/mail/send",
        "stub": {
            "from_email": "test@example.com",
            "to_email": "test@example.com",
            "subject": "Welcome to Sendgrid",
            "content": "Enjoy it!"
        }
    },
    "mandrill": {
        "endpoint": "https://mandrillapp.com/api/1.0/messages/send.json",
        "stub": {
            "from_email": "test@example.com",
            "to_email": "test@example.com",
            "subject": "Welcome to Mandrill",
            "content": "Enjoy it!"
        }
    },
    "mailgun": {
        "stub": {
            "to_email": "test@example.com",
            "subject": "Welcome to Mailgun",
            "content": "Enjoy it!"
        }
    }
}

Then you can test your mailing setting for each service by

var super_mailer = require('super_mailer');
mailer();

to get response results easily.

Tests

Now, you can test all builders of mail services by

$ npm test