@objectif-lune/node-red-contrib-sendgrid
TypeScript icon, indicating that this package has built-in type declarations

0.9.11 • Public • Published

Node-RED node to send email content generated by OL Connect technology using the SendGrid service

This sendgrid node sends pre-rendered email content, created by the email content node of the OL Connect package for Node-RED, via the SendGrid service for bulk processing. This task uses SendGrid's v3 Web API which is faster than sending email over SMTP.

Features

  • Sends pre-rendered email content, created by the email content node of the OL Connect package for Node-RED.
  • Tag emails with category names, which helps organize your email analytics.
  • Batch multiple messages to optimize performance.
  • Add custom headers specifying specific handling instructions for your email.
  • Utilize SendGrid's sandbox mode to test an Email campaign before it is sent.
  • Specify multiple replyTo addressees
  • Send messages to a test address.

Installation

Use the Manage Palette option from the Node-RED-menu, or run the following command in your Node-RED user directory - typically ~/.node-red

npm install @objectif-lune/node-red-contrib-sendgrid

Obviously, you must have OL Connect installed on a server that can be reached from the one where Node-RED is installed, otherwise you won't be able to perform any automation tasks.

Usage

This sendgrid node should be placed after the email content node of the OL Connect package for Node-RED. The node takes its information from the messages array in msg.payload. This data could be modified and extended using a function node (for example to add static attachments).

To be able to send email using the node, you need a SendGrid account and an API key created in the Settings section of the SendGrid portal.

Rate limitations and restrictions apply to the number of Emails that can be added to a single batch, for more information see the SendGrid documentation.

Note also that this node requires you to specify the connection to the OL Connect Server.

A word of caution

This node is part of the OL Connect Automate stack. It is intended for use by current users of OL Connect who want to experiment with automating server operations through Node-RED. The OL Connect Automate stack is a technology preview.

Support

At this early stage, the OL Connect Automate stack is not supported through the OL Care program. Feel free to visit the OL Connect Automate stack forum to post questions, comments and suggestions.

License

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.

Readme

Keywords

Package Sidebar

Install

npm i @objectif-lune/node-red-contrib-sendgrid

Weekly Downloads

5

Version

0.9.11

License

MIT

Unpacked Size

96.1 kB

Total Files

86

Last publish

Collaborators

  • aghorab
  • matt_lee
  • barbeaujol
  • philippe-fontan
  • fortiny