History

Dave Conway-Jones 1f8ab3ebb7 Update email node readme to be less confusing Bump pre-reqs as well		2019-02-24 23:07:38 +00:00
..
locales	add option to set criteria witch type of emails should be requested (#519 )	2019-02-11 19:26:45 +00:00
61-email.html	Fixup email PR and push to npm	2019-02-11 20:10:31 +00:00
61-email.js	Fixup email PR and push to npm	2019-02-11 20:10:31 +00:00
LICENSE	Update licenses and packages for all nodes	2016-11-06 20:26:19 +00:00
README.md	Update email node readme to be less confusing	2019-02-24 23:07:38 +00:00
package.json	Update email node readme to be less confusing	2019-02-24 23:07:38 +00:00

README.md

node-red-node-email

Node-RED nodes to send and receive simple emails.

Pre-requisite

You will need valid email credentials for your email server. For GMail this may mean getting an application password if you have two-factor authentication enabled.

Note : Version 1.x of this node requires Node.js v8 or newer.

Install

Version 0.x of this node is usually installed by default by Node-RED. As long as you have at least version 0.19.x of Node-RED you can install the new version by using the Menu - Manage Palette option, or running the following command in your Node-RED user directory - typically ~/.node-red

    cd ~/.node-red
    npm i node-red-node-email

Usage

Nodes to send and receive simple emails.

Input

Repeatedly gets emails from an IMAP or POP3 server and forwards them onwards as messages if not already seen.

The subject is loaded into msg.topic and msg.payload is the plain text body. If there is text/html then that is returned in msg.html. msg.from and msg.date are also set if you need them.

Additionally msg.header contains the complete header object including to, cc and other potentially useful properties.

Note: this node only gets the most recent single email from the inbox, so set the repeat (polling) time appropriately.

Uses the imap npm module.

Output

Sends the msg.payload as an email, with a subject of msg.topic.

The default message recipient can be configured in the node, if it is left blank it should be set using the msg.to property of the incoming message.

You may optionally override the from email address by setting msg.from, otherwise the node will use the userid setting from the server connection.

The payload can be html format.

If the payload is a binary buffer then it will be converted to an attachment.

The filename should be set using msg.filename. Optionally msg.description can be added for the body text.

Alternatively you may provide msg.attachments which should contain an array of one or more attachments in nodemailer format.

Uses the nodemailer npm module.