src/index.js

Build Status

A Nxus module for sending emails through different services.

Installation

> npm install @nxus/mailer --save

Usage

Register a mail service

app.get('mailer').service(myService)

Each service is expected to implement a method called sendMessage with the signature

sendMessage(to, from, subject, content, opts) {
...
}

Send an email using a service

app.get('mailer').send('to@address', 'from@address', "My subject", "Body content", {some: opts})

Opts

The opts hash can be used to send service specific opts back to the mail handler. For example:

// Mandrill opts
app.get('mailer').send('to@address', 'from@address', "My subject", "Body content", { async: true })

API


Mailer

src/index.js

The main Mailer class.

Instance members

#service(service)

Register a service. See MandrillService for an example.

service(service)

src/index.js

Register a service. See MandrillService for an example.

Parameters

  • function service :

    a Class or callable that implements a method called sendMessage.

MandrillSerivce

src/MandrillService.js

A default service for mailing with Mandrill.