Package Exports

@nxus/mailer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nxus/mailer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@nxus/mailer

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

The main Mailer class.

service

Parameters

service function a Class or callable that implements a method called sendMessage.

MandrillSerivce

A default service for mailing with Mandrill.