mirror of
https://github.com/node-red/node-red-nodes.git
synced 2023-10-10 13:36:58 +02:00
87 lines
3.8 KiB
Markdown
87 lines
3.8 KiB
Markdown
node-red-node-email
|
|
===================
|
|
|
|
<a href="http://nodered.org" target="info">Node-RED</a> 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.
|
|
|
|
For Exchange and Outlook 365 you must use OAuth2.0.
|
|
|
|
**Notes **:
|
|
Version 2.x of this node required **Node.js v12** or newer.
|
|
Version 1.x of this node requires **Node.js v8** or newer.
|
|
|
|
Install
|
|
-------
|
|
|
|
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
|
|
npm i node-red-node-email
|
|
|
|
GMail users
|
|
-----------
|
|
|
|
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>
|
|
|
|
Office 365 users
|
|
----------------
|
|
|
|
If you are accessing Exchnage you will need to register an application through their platform and use OAuth2.0.
|
|
<a target="_new" href="https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth#get-an-access-token">Details on how to do this can be found here.</a>
|
|
|
|
Usage
|
|
-----
|
|
|
|
Nodes to send and receive simple emails.
|
|
|
|
### Input node
|
|
|
|
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
|
|
`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.
|
|
|
|
Modern authentication through OAuth2.0 is supported, but must be triggered by an incoming access token and
|
|
can only be automatically triggered upstream.
|
|
|
|
### 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. You can also specify any or all of: `msg.cc`, `msg.bcc`, `msg.replyTo`, `msg.inReplyTo`, `msg.references`, `msg.headers`, or `msg.priority` properties.
|
|
|
|
|
|
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. 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.
|
|
|
|
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://nodemailer.com/message/attachments/" target="_new">nodemailer</a> format.
|
|
|
|
If required by your recipient you may also pass in a `msg.envelope` object, typically containing extra from and to properties.
|
|
|
|
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.
|
|
|
|
Use secure connection - If enabled the connection will use TLS when connecting to server. If disabled then TLS is used if server supports the STARTTLS extension. In most cases set this to enabled if you are connecting to port 465. For port 587 or 25 keep it disabled.
|
|
|
|
This node uses the *nodemailer* npm module.
|