mailers

1.0.2 • Public • Published

Mailers Build Status

mailing library.

Example

var mailer = require("mailers").create("stub");
 
 
var message = {
    from:    "info@example.com",
    to:      "aoj@n13.cz",
    subject: "hello",
    text:    "world"
};
 
mailer.sendMail(message, function (err, response) {
    if(err) return console.error(err.stack);
 
    console.log(response);
});

usage with mandrill

MANDRILL_KEY=54ef0259-0372-415b-81c6 node app
...
var mailer = require("mailers").create("mandrillApi")

API for mailers

var mailers = require("mailers")
  • create(engineName, options) Nodemailer engin one "mandrillApi". Options is object for the engine. Can contain maxConnections to setup concurrency level, default is 10.

API for mailer

var mailer = require("mailers").create("stub")
  • sendMail(message, cb) send email. Format of message is same as in nodemamiler.
  • sendMailImmediately(message, cb) Send email as soon as posible, before others one queued.
  • pause() pause sending
  • resume() resume paused sending
  • kill() stop sending
  • isPaused() return bool if sending is paused
  • concurrency() return sending concurrency
  • remain() return how many emails remain in queue
  • now() return how many emails are sendings at the time

Events

mailer wrapper rising a events.

  • drain the event is called when the last item from the queue has returned from the worker
  • empty the event is called when the last item from the queue is given to a worker
  • saturated the event is called when the queue length hits the concurrency limit, and further tasks will be queued

Changelog

  • 1.0.1 (2014-04-17) typos, add error test, add example
  • 1.0.0 (2014-04-16) init

TODO

  • overwrite X-Mailer
  • bulk api
  • normalize response object
  • test memory and cpu

Readme

Keywords

none

Package Sidebar

Install

npm i mailers

Weekly Downloads

5

Version

1.0.2

License

none

Last publish

Collaborators

  • aoj