1.0.2 • Published 4 years ago

feathers-mail v1.0.2

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

feathers-mail

Simple Feathers mailer service using nodemailer

For security, the Mail service has been set up to only work internally. The service is named _mailer

Installation

npm install feathers-mail --save

How to use

In your config file (eg config/default.json) add

  "feathers-mail": {
    "from": "your@email.here",
    "smtp": {
        "host": "smtp.host.here",
        "secure": true,
        "auth": {
          "user": "smtp@user.here",
          "pass": "replacewithpassword"
        }
    }
  }

More smtp settings available here https://nodemailer.com/smtp/

####Install plugin

// mailer plugin
app.configure(require('feathers-mail'));

This can be done in either

  • app.js after "app.configure(channels);"
  • in any class or service where app. is available.

if you define the service multiple times, it will ignore the duplicates

Example usage

    try {
        await app.service('_mailer').create({
                from: "sender@server.com",
                to: "receiver@sender.com",
                subject: "Message title",
                text: "Plaintext version of the message",
                html: "<p>HTML version of the message</p>"
        });
    } catch (error) {
  
      //do something with error    

    }

Node Mailer message settings https://nodemailer.com/message/

License

Copyright (c) 2020

Licensed under the MIT license.