node-red-nodes/social/email/README.md

node-red-node-email
===================

<a href="http://nodered.org" target="_new">Node-RED</a> nodes to send and receive simple emails.

**Note** : This is the same node as was in the core of Node-RED.
As of v0.10.8 it will be installed from here instead.

Pre-requisite
-------------

You will need valid email credentials for your email server.

Install
-------

Run the following command in the root directory of your Node-RED install.
Usually this is `~/.node-red` .

        npm install node-red-node-email

Usage
-----

Nodes to send and receive simple emails.

###Input

Repeatedly gets a **single email** from an IMAP server and forwards on as a msg 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.

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 <a href="https://www.npmjs.com/package/nodemailer#attachments" target="_new">nodemailer</a> format.

Uses the *nodemailer* npm module.