Socket
Socket
Sign inDemoInstall

kuzzle-plugin-mailer

Package Overview
Dependencies
22
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    kuzzle-plugin-mailer

Send e-mails through a custom Kuzzle controller.


Version published
Maintainers
1
Install size
1.17 MB
Created

Readme

Source

Kuzzle Plugin Mailer

This plugin extends the Kuzzle API allowing to send mail from a new exposed controller. It acts as a bridge between the "Node Mailer" library and the Kuzzle backend.

Configuration

You must define some configuration before start.

SMTP Server & Proxy

Just provide an smtpConfig key with your config SMTP configuration: Here is the list of available config options.

The only option you can't define on your own is options.pool because this will depend on the controller action you are using. At the moment the bulk action is not supported but in the future this will be taken in consideration.

From contact

Define a fromContact key with format "User" address@adress.com

See NodeMailer documentation

Documentation

This plugin exposes different API that you should use depending on your needs.

In all case you can look at this documentation to understand the e-mail format : NodeMailer mail format

Sending e-mail API (Small amount of mail)

You can call the HTTP route :

POST - /api/1.0/_plugin/kuzzle-plugin-mailer/send-email

Just provide a single Mail object with some of given option : NodeMailer mail format

Bulk e-mail API (Large amount of mail)

Not supported yet. See you further.

Keywords

FAQs

Last updated on 17 Oct 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc