Skip to content
This repository has been archived by the owner on Aug 31, 2020. It is now read-only.

secretfader/edict

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Edict

Send notifications the easy way.

Configuration

var edict = require('edict');

edict.configure({
  from: 'SaaS App <[email protected]>',
  views: /* views path */,
  ext: 'html' // optional
}).connect(/* transport or Nodemailer transport options. */);

edict.send('template', {
  title: 'Hello, New User!',
  to: 'Nicholas Young <[email protected]>',
  token: // options for template rendering.
});

For a full example, see the examples folder.

Contributing

  1. Fork the repository, and do all of your work in a feature branch.

  2. Don't change the API without notifying me. Breaking changes are totally fine, but we should establish a sane upgrade path first.

  3. Document and test your changes.

  4. Send that pull request!

License

Copyright (C) Original Machine LLC.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

Easy email notifications for Node.js apps.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages