frodovdr/node-red-nodes
1
0
Fork 0
mirror of https://github.com/node-red/node-red-nodes.git synced 2025-03-01 10:37:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Info/Doc style updates to core/pi nodes

Browse Source
This commit is contained in:
Dave Conway-Jones
2016-03-02 13:18:24 +00:00
parent 741c57e627
commit eff8327971
25 changed files with 78 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
social/email/README.md
View File

@@ -14,25 +14,24 @@ 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` .
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-email
npm i node-red-node-email
Usage
-----
Nodes to send and receive simple emails.
###Input
### 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.
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
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,
@@ -40,21 +39,21 @@ so set the repeat (polling) time appropriately.
Uses the *imap* npm module.
###Output
### Output
Sends the **msg.payload** as an email, with a subject of **msg.topic**.
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.
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.
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
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.

2
social/email/package.json
View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-email",
"version" : "0.1.2",
"version" : "0.1.3",
"description" : "Node-RED nodes to send and receive simple emails",
"dependencies" : {
"nodemailer" : "1.3.4",