Email Service API
npm package for sending email through multiple service provider
If one of the services goes down, it can quickly failover to a another provider without affecting customers
Getting Started
Prerequisites
nodejs
Setup Environment Variables
Update the development environment with your email service API keys
e.g. [SENDGRID_API_KEY] on (https://app.sendgrid.com/settings/api_keys)
echo "export SENDGRID_API_KEY='YOUR_SENDGRID_API_KEY' export MAILGUN_API_KEY='YOUR_MAILGUN_API_KEY'export MAILGUN_DOMAIN='YOUR_MAILGUN_DOMAIN' export SES_ACCESS_KEY='YOUR_SES_ACCESS_KEY'export SES_SECRET_KEY='YOUR_SES_SECRET_KEY'" > emailer.envecho "emailer.env" >> .gitignoresource ./emailer.env
Installing
npm install --save emailer-js
Running the tests
You need to set the NODE_ENV environment variable to 'test' and install devDependencies before you run test
npm test
Usage
'use strict'; let Emailer = ; let emailer = ; let options = fromEmail: 'from@example.com' toEmail: 'to@email.com' subject: 'Test Emailer' content: 'Hello World'; emailer
TODO
- Improve Documentation
- Add Mailchimp/Mandrill Support - On April 27, Mandrill became a paid MailChimp add-on. Keep receiving "Acceptable Use Violation Detected"...
- Rate Limit of Sending Emails
- Support More Complex Email - html body, cc, bcc, attachment, contentType, etc
- More Test Cases
Authors
- Amanda Xiang - Initial work - Amanda Xiang
See also the list of contributors who participated in this project.