Cleanup and README

Remove old code, update readme
This commit is contained in:
wooferguy 2023-02-11 14:50:48 +13:00
parent ce4bf11b48
commit bbf2330b1a
2 changed files with 12 additions and 49 deletions

View File

@ -578,55 +578,6 @@ module.exports = function(RED) {
} }
} // End of checkEmail } // End of checkEmail
/* if (node.protocol === "IMAP") {
var tout = (node.repeat > 0) ? node.repeat - 500 : 15000;
if(node.authentication == "OAUTH") {
imap = new Imap({
user: node.userid,
oauth: node.token,
host: node.inserver,
port: node.inport,
tls: node.useSSL,
autotls: node.autotls,
tlsOptions: { rejectUnauthorized: false },
connTimeout: tout,
authTimeout: tout
});
} else if(node.authentication == "XOAUTH2") {
imap = new Imap({
user: node.userid,
xoauth2: node.token,
host: node.inserver,
port: node.inport,
tls: node.useSSL,
autotls: node.autotls,
tlsOptions: { rejectUnauthorized: false },
connTimeout: tout,
authTimeout: tout
});
} else {
imap = new Imap({
user: node.userid,
password: node.password,
host: node.inserver,
port: node.inport,
tls: node.useSSL,
autotls: node.autotls,
tlsOptions: { rejectUnauthorized: false },
connTimeout: tout,
authTimeout: tout
});
}
imap.on('error', function(err) {
if (err.errno !== "ECONNRESET") {
s = false;
node.error(err.message,err);
node.status({fill:"red",shape:"ring",text:"email.status.connecterror"});
}
setInputRepeatTimeout();
});
}*/
node.on("input", function(msg, send, done) { node.on("input", function(msg, send, done) {
send = send || function() { node.send.apply(node,arguments) }; send = send || function() { node.send.apply(node,arguments) };
checkEmail(msg,send,done); checkEmail(msg,send,done);

View File

@ -9,6 +9,8 @@ Pre-requisite
You will need valid email credentials for your email server. For GMail this may mean 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. getting an application password if you have two-factor authentication enabled.
For Exchange and Outlook 365 you must use OAuth2.0.
**Note :** Version 1.x of this node requires **Node.js v8** or newer. **Note :** Version 1.x of this node requires **Node.js v8** or newer.
Install Install
@ -26,6 +28,13 @@ 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>, 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> 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 Usage
----- -----
@ -42,6 +51,9 @@ If there is text/html then that is returned in `msg.html`. `msg.from` and
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. **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 ### Output node
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`.