email node: improved EN help and added DE help

This commit is contained in:
Heiko 2021-03-23 16:28:44 +01:00
parent c1c82a623e
commit 3dfb6325bb
3 changed files with 75 additions and 10 deletions

View File

@ -0,0 +1,67 @@
<script type="text/html" data-help-name="e-mail">
<p>Versand von <code>msg.payload</code> als E-Mail mit <code>msg.topic</code> als Subjekt.</p>
<p>Der Standard-Nachrichtenempfänger kann im Node vorgegeben werden.
Wenn nicht angegeben, muss der Nachrichtenempfänger über die <code>msg.to</code>-Eigenschaft
der eingehenden Nachricht übergeben werden.
Ebenso können einige oder alle vorgegeben werden von: <code>msg.cc</code>, <code>msg.bcc</code>, <code>msg.replyTo</code>,
<code>msg.inReplyTo</code>, <code>msg.references</code>, <code>msg.headers</code> oder <code>msg.priority</code>-Eigenschaften.</p>
<p>Es kann optional auch <code>msg.from</code> in den Nutzdaten (Payload) vorgegeben werden,
was die eingestellte <code>Benutzer-ID</code> überschreiben würde.</p>
<h3>Gmail-Benutzer</h3>
<p>Beim Zugriff auf Gmail kann es nötig sein, entweder <a target="_new" href="https://support.google.com/mail/answer/185833?hl=de">ein App-Passwort</a> zu aktivieren oder den <a target="_new" href="https://support.google.com/accounts/answer/6010255?hl=de">Zugriff aufs Google-Konto durch weniger sichere Apps</a> über die Google-Konto-Einstellungen zu erlauben.</p>
<h3>Details</h3>
<p>Die Nachricht in <code>msg.payload</code> kann als HTML formatiert sein.</p>
<p>Wenn <code>msg.payload</code> ein binärer Buffer ist, so wird sie in einen Nachrichten-Dateianhang (attachment) konvertiert.
Der Dateiname sollte mittels <code>msg.filename</code> angegeben werden.
Optional kann <code>msg.description</code> als Nachrichtentext hinzugefügt werden.</p>
<p>Alternativ kann auch <code>msg.attachments</code> übergeben werden, welches ein Datenfeld (array) mit einen oder mehreren
Dateianhängen im <a href="https://nodemailer.com/message/attachments/" target="_new">nodemailer</a>-Format enthält.</p>
<p>Falls vom Empfänger benötigt, kann zusätzlich über <code>msg.envelope</code> ein Objekt übergeben werden, welches typischerweise zusätzliche <code>from</code>- und <code>to</code>-Eigenschaften enthält.</p>
<p>Wenn ein selbstausgestelltes Zertifikates vorliegt, kann sich Nodemailer darüber beschweren und das Senden der Nachricht ablehnen.
In diesem Fall kann versucht werden TLS abzuschalten.</p>
<p><b>Hinweis</b>: Verwendet SMTP mit SSL über Port 465.</p>
</script>
<script type="text/html" data-help-name="e-mail in">
<p>Regelmäßiger Abruf von E-Mails von einem POP3- oder IMAP-Server und Weiterleitung der Nachricht, falls diese noch nicht angezeigt wurde.</p>
<p>Der Subjekttext wird in <code>msg.topic</code> und der Klartextinhalt in <code>msg.payload</code> abgelegt.
Wenn text/html vorliegt, dann wird dieser in <code>msg.html</code> abgelegt.
<code>msg.from</code> und <code>msg.date</code> sind ebenfalls für die weitere Nutzung gesetzt.</p>
<p>Zusätzlich enthält <code>msg.header</code> den kompletten Mailkopf (Header) als Objekt mit
<i>to</i>, <i>cc</i> und anderen eventuell nützlichen Eigenschaften.</p>
<p>Der Node kann optional die Nachricht als gelesen markieren (Standard-Einstellung), sie löschen oder sie als unmarkiert belassen.</p>
<p>Verwendet wird das <a href="https://github.com/mscdex/node-imap/blob/master/README.md" target="_new">node-imap-Modul</a> -
siehe dort für Informationen über das <code>msg.criteria</code>-Format, falls benötigt.</p>
<p>Alle Dateianhänge mitgeliefert in eingehenden E-Mails können in der <code>msg.attachments</code>-Eigenschaft gefunden werden.
Es wird dann ein Datenfeld (Array) von Objekten übergeben, wo jedes Objekt ein einzelner Dateianhang (attachment) darstellt.
Das Objektformat ist:</p>
<pre>
{
contentType: // Die MIME-Inhaltsbeschreibung (MIME content description)
fileName: // Ein vorgeschlagener Dateiname, der diesem Anhang zugeordnet ist
transferEncoding: // Wie wurde der ursprüngliche E-Mail-Anhang verschlüsselt?
contentDisposition: // Unbekannt
generatedFileName: // Ein vorgeschlagener Dateiname, der diesem Anhang zugeordnet ist
contentId: // Eine eindeutige generierte ID für diesen Anhang
checksum: // Eine Prüfsumme gegen die Daten
length: // Datengröße in Bytes
content: // Der tatsächliche Inhalt der in einem Node.js-Pufferobjekt enthaltenen Daten
// Wir können dies in eine base64-Datenzeichenfolge mit content.toString('base64') umwandeln
}
</pre>
<p><b>Hinweis</b>: Bei POP3 sind die Standard-Portnummern 110 für ungesichertes TCP und 995 für SSL. Bei IMAP 143 für ungesichertes TCP und 993 für SSL.</p>
<p><b>Hinweis</b>: Das maximale Aktualisierungsintervall ist 2147483 Sekunden (24,8 Tage).</p>
</script>
<script type="text/html" data-help-name="e-mail mta">
<p>Mail Transfer Agent - Portüberwachung für eingehende SMTP-Mails.</p>
<p><b>Hinweis</b>: "NICHT für Produktivbetrieb", da keine Sicherheitsfunktionen eingebaut sind!
Dies dient hauptsächlich zum lokalen Testen des Versands ausgehender E-Mails,
kann jedoch bei Bedarf verwendet werden als Mail-Weiterleitung an einen echten E-Mail-Dienst.</p>
<p>Um Ports unter 1024 (z.B. 25 or 465) zu benutzen, könnten höhere Zugriffsrechte nötig sein.
Auf Linux-Systemen kann dieses erreicht werden durch Starten von
<pre>sudo setcap 'cap_net_bind_service=+eip' $(which node)</pre>
und Neustart von Node-RED.
Es ist zu beachten, dass dadurch alle Knotenanwendungen auf alle Ports zugreifen können.</p>
</script>

View File

@ -33,9 +33,9 @@
}, },
"default-message": "__description__\n\nDatei von Node-RED ist angehängt: __filename__", "default-message": "__description__\n\nDatei von Node-RED ist angehängt: __filename__",
"tip": { "tip": {
"cred": "<b>Hinweis:</b> Berechtigungen von globaler emailkeys.js-Datei kopiert", "cred": "<b>Hinweis</b>: Berechtigungen von globaler emailkeys.js-Datei kopiert",
"recent": "Tipp: Es wird nur die letzte E-Mail abgerufen", "recent": "Tipp: Es wird nur die letzte E-Mail abgerufen",
"mta": "<b>Hinweis:</b> Um Ports unter 1024 zu verwenden könnten höhere (root) Rechte benötigt werden. Siehe Hilfe-Seitenleiste." "mta": "<b>Hinweis</b>: Um Ports unter 1024 zu verwenden könnten höhere (root) Rechte benötigt werden. Siehe Hilfe-Seitenleiste."
}, },
"status": { "status": {
"messagesent": "Nachricht gesendet: __response__", "messagesent": "Nachricht gesendet: __response__",

View File

@ -6,8 +6,8 @@
<code>msg.inReplyTo</code>, <code>msg.references</code>, <code>msg.headers</code>, or <code>msg.priority</code> properties.</p> <code>msg.inReplyTo</code>, <code>msg.references</code>, <code>msg.headers</code>, or <code>msg.priority</code> properties.</p>
<p>You may optionally set <code>msg.from</code> in the payload which will override the <code>userid</code> <p>You may optionally set <code>msg.from</code> in the payload which will override the <code>userid</code>
default value.</p> default value.</p>
<h3>GMail users</h3> <h3>Gmail users</h3>
<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>, <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> 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> <h3>Details</h3>
<p>The payload can be html format.</p> <p>The payload can be html format.</p>
@ -21,7 +21,7 @@
</script> </script>
<script type="text/html" data-help-name="e-mail in"> <script type="text/html" data-help-name="e-mail in">
<p>Repeatedly gets emails from an IMAP server and forwards on as a msg if not already seen.</p> <p>Repeatedly gets emails from a POP3 or IMAP server and forwards on as a msg if not already seen.</p>
<p>The subject is loaded into <code>msg.topic</code> and <code>msg.payload</code> is the plain text body. <p>The subject is loaded into <code>msg.topic</code> and <code>msg.payload</code> is the plain text body.
If there is text/html then that is returned in <code>msg.html</code>. <code>msg.from</code> and <code>msg.date</code> are also set if you need them.</p> If there is text/html then that is returned in <code>msg.html</code>. <code>msg.from</code> and <code>msg.date</code> are also set if you need them.</p>
<p>Additionally <code>msg.header</code> contains the complete header object including <p>Additionally <code>msg.header</code> contains the complete header object including
@ -29,10 +29,8 @@
<p>It can optionally mark the message as Read (default), Delete it, or leave unmarked (None).</p> <p>It can optionally mark the message as Read (default), Delete it, or leave unmarked (None).</p>
<p>Uses the <a href="https://github.com/mscdex/node-imap/blob/master/README.md" target="_new">node-imap module</a> - see that page for <p>Uses the <a href="https://github.com/mscdex/node-imap/blob/master/README.md" target="_new">node-imap module</a> - see that page for
information on the <code>msg.criteria</code> format if needed.</p> information on the <code>msg.criteria</code> format if needed.</p>
<p><b>Note</b>: uses IMAP with SSL to port 993.</p>
<p>Any attachments supplied in the incoming email can be found in the <code>msg.attachments</code> property. This will be an array of objects where <p>Any attachments supplied in the incoming email can be found in the <code>msg.attachments</code> property. This will be an array of objects where
each object represents a specific attachments. The format of the object is:</p> each object represents a specific attachments. The format of the object is:</p>
<pre> <pre>
{ {
contentType: // The MIME content description contentType: // The MIME content description
@ -47,13 +45,13 @@
// We can turn this into a base64 data string with content.toString('base64') // We can turn this into a base64 data string with content.toString('base64')
} }
</pre> </pre>
<p>For POP3, the default port numbers are 110 for plain TCP and 995 for SSL. For IMAP the port numbers are 143 for plain TCP and 993 for SSL.</p> <p><b>Note</b>: For POP3, the default port numbers are 110 for plain TCP and 995 for SSL. For IMAP the port numbers are 143 for plain TCP and 993 for SSL.</p>
<p>The maximum refresh interval is 2147483 seconds (24.8 days).</p> <p><b>Note</b>: The maximum refresh interval is 2147483 seconds (24.8 days).</p>
</script> </script>
<script type="text/html" data-help-name="e-mail mta"> <script type="text/html" data-help-name="e-mail mta">
<p>Mail Transfer Agent - listens on a port for incoming SMTP mail.</p> <p>Mail Transfer Agent - listens on a port for incoming SMTP mails.</p>
<p><b>Note</b>: "NOT for production use" as there is no security built in. <p><b>Note</b>: "NOT for production use" as there is no security built in.
This is primarily for local testing of outbound mail sending, but could be used This is primarily for local testing of outbound mail sending, but could be used
as a mail forwarder to a real email service if required.</p> as a mail forwarder to a real email service if required.</p>