Tidy email node README to remove false "only one mail" statement.

and tidy some other newer functionality. like plaintext.
to close #792
This commit is contained in:
Dave Conway-Jones 2021-04-03 16:55:45 +01:00
parent 1c256fd3b3
commit 61a03d7cc3
No known key found for this signature in database
GPG Key ID: 88BA2B8A411BE9FF
3 changed files with 13 additions and 22 deletions

View File

@ -3,7 +3,6 @@ node-red-node-email
<a href="http://nodered.org" target="info">Node-RED</a> nodes to send and receive simple emails.
Pre-requisite
-------------
@ -12,13 +11,10 @@ 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
You can install by using the `Menu - Manage Palette` option, or running the following command in your
Node-RED user directory - typically `~/.node-red`
cd ~/.node-red
@ -35,9 +31,9 @@ Usage
Nodes to send and receive simple emails.
### Input
### Input node
Repeatedly gets emails from an IMAP or POP3 server and forwards them onwards as messages if not already seen.
Fetches 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
@ -46,24 +42,19 @@ If there is text/html then that is returned in `msg.html`. `msg.from` and
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
### Output node
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 email *from* can be set using `msg.from` but not all mail services allow
this unless `msg.from` is also a valid userid or email address associated with
the password. Note: if `userid` or msg.from does not contain a valid email
address (userxx@some_domain.com), you may see (No Sender) in the email.
The email *from* can be set using `msg.from` but not all mail services allow
this unless `msg.from` is also a valid userid or email address associated with
the password. Note: if `userid` or msg.from does not contain a valid email
address (userxx@some_domain.com), you may see *(No Sender)* in the email.
The payload can be html format.
The payload can be html format. You can also specify `msg.plaintext` if the main payload is html.
If the payload is a binary buffer then it will be converted to an attachment.

View File

@ -10,8 +10,8 @@
<p>If you are accessing Gmail you may need to either enable <a target="_new" href="https://support.google.com/mail/answer/185833?hl=en">an application password</a>,
or enable <a target="_new" href="https://support.google.com/accounts/answer/6010255?hl=en">less secure access</a> via your Google account settings.</p>
<h3>Details</h3>
<p>The payload can be html format. You may supply a separate plaintext version using <code>msg.plaintext</code>.
If you don't and <code>msg.payload</code> contains html, it will also be used for the plaintext.
<p>The payload can be html format. You may supply a separate plaintext version using <code>msg.plaintext</code>.
If you don't and <code>msg.payload</code> contains html, it will also be used for the plaintext.
<code>msg.plaintext</code> will be ignored if <code>msg.payload</code> doesn't contain html.</p>
<p>If the payload is a binary buffer then it will be converted to an attachment.
The filename should be set using <code>msg.filename</code>. Optionally <code>msg.description</code> can be added for the body text.</p>
@ -19,7 +19,7 @@
more attachments in <a href="https://nodemailer.com/message/attachments/" target="_new">nodemailer</a> format.</p>
<p>If required by your recipient you may also pass in a <code>msg.envelope</code> object, typically containing extra from and to properties.</p>
<p>If you have own signed certificates, Nodemailer can complain about that and refuse sending the message. In this case you can try switching off TLS.</p>
<p>Note: uses SMTP with SSL to port 465.</p>
<p><b>Note</b>: uses SMTP with SSL to port 465.</p>
</script>
<script type="text/html" data-help-name="e-mail in">

View File

@ -1,6 +1,6 @@
{
"name": "node-red-node-email",
"version": "1.11.0",
"version": "1.11.1",
"description": "Node-RED nodes to send and receive simple emails.",
"dependencies": {
"imap": "^0.8.19",