https://github.com/madhums/node-notifier

A simple node.js module to handle all the application level notifications (apple push notifications and mails)
https://github.com/madhums/node-notifier

Last synced: 8 days ago
JSON representation

A simple node.js module to handle all the application level notifications (apple push notifications and mails)

• Host: GitHub
• URL: https://github.com/madhums/node-notifier
• Owner: madhums
• License: mit
• Created: 2013-03-05T11:02:49.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2019-03-13T13:11:46.000Z (over 5 years ago)
• Last Synced: 2024-04-15T00:17:09.594Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 67.4 KB
• Stars: 86
• Watchers: 7
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/madhums/node-notifier.png)](https://travis-ci.org/madhums/node-notifier)

## Notifier

A simple node.js module to handle all the application level notifications (apple push notifications, mails and facebook posts)

## Installation

```sh

$ npm install notifier

```

or include it in `package.json`

**NOTE**: Sending emails is disabled in 'development' and 'test' environment. (instead it will log to console)

## Usage

```js

var notifier = new Notifier({

  service: 'postmark' // or 'sendgrid'

  APN: true,

  email: true,

  tplType: 'ejs', // if you want to use ejs as templating system

  actions: ['comment', 'like'],

  tplPath: require('path').resolve(__dirname, './templates'),

  key: 'SERVICE_KEY',

  sendgridUser: 'SENDGRID_USER',

  parseAppId: 'APP_ID',

  parseApiKey: 'MASTER_KEY'

});

var comment = {

  to: 'Tom',

  from: 'Harry'

};

var options = {

  to: '[email protected]',

  subject: 'Harry says Hi to you',

  from: '[email protected]',

  locals: comment // should be the object containing the objects used in the templates

};

notifier.use({

  parseChannels: ['USER_5093a266180b779762000005']

});

// OR

// options.parseChannels = ['USER_5093a266180b779762000005']

notifier.send('comment', options, function (err) {

  if (err) return console.log(err);

  console.log('Successfully sent Notifiaction!');

});

```

If you want to use a different templating engine like ejs or something else then just override the `processTemplate` method. And don't forget to use the `tplType` config option

For example

```js

Notifier.prototype.processTemplate = function (tplPath, locals) {

  var ejs = require('ejs')

  locals.filename = tplPath

  var tpl = require('fs').readFileSync(tplPath, 'utf8')

  return ejs.render(tpl, locals)

}

```

## Tests

```sh

$ npm test

```

## License

(The MIT License)

Copyright (c) 2013 Madhusudhan Srinivasa < [[email protected]](mailto:[email protected]) >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.