0.0.6 • Published 7 years ago

feathers-sendwithus-batch v0.0.6

Weekly downloads
1
License
GPL-3.0
Repository
github
Last release
7 years ago

feathers-sendwithus

Build Status

Feathers service for sending mailers with sendwithus.

STATUS: Under development

Installation

npm install --save feathers-sendwithus

Usage

const sendwithusService = require('feathers-sendwithus');

module.exports = function() {
  const app = this;
  const config = app.get('mailer').sendwithus;
  app.use('/mailers', sendwithusService(config));
};

Configuration

apiKey - Sendwithus api key (Required)

templateNameMapping - Will map template names to IDs when doing api calls (default: true)

templateNameCacheExpiry - Duration before templates are fetched again to be mapped. *Set larger or smaller depending on how often you create new templates or change template names (default 1h (one hour))

templateMapper - Custom function which maps templates (default: the built in cached template mapper) e.g.

const myMap = { friendly: 'templateId' };

const service = sendwithusService({
  ...
  templateMapper: (t) => Promise.resolve(myMap[t] || t),
});

service.create({
template: 'friendly',
...
}) will send { template: 'templateId' };