⚠ Dieser Adapter kann mit dem Blockly (Eigene Abfrage) das System sehr schnell zum Absturz bringen.
 ⚠ Daher bitte diese Beschreibung aufmerksam durchlesen.

Zurück zur README

Zusammenfassung

• Instanz Einstellungen
  • Einstellungen TAB IMAP
  • Einstellungen TAB Symbole
  • Einstellungen TAB Oauth2
  • Einstellungen TAB Mailparser
• Datenpunkte
  • Datenpunkte imap.0
  • Datenpunkte imap.0.benutzername
  • Datenpunkte imap.0.benutzername.email.emails_xx
  • Datenpunkte imap.0.benutzername.infos
  • Datenpunkte imap.0.benutzername.remote
  • Datenpunkte imap.0.benutzername.remote.copy
  • Datenpunkte imap.0.benutzername.remote.flag
  • Datenpunkte imap.0.benutzername.remote.html
  • Datenpunkte imap.0.benutzername.remote.move
• Blocklys
  • Blockly Instanzeinstellungen ändern
  • Eigene Abfrage erstellen
  • Abfrage mit Instanzeinstellungen
  • Flags setzen
• Array JSON
  • imap.0.xxx.email.email_xx.attach_json
  • imap.0.xxx.json
  • imap.0.xxx.last_activity_json
  • imap.0.xxx.quality
  • imap.0.xxx.status
  • imap.0.online_history
• Beispiel Javascripte und Blocklys

Instanz Einstellungen

Instanz Konfiguration TAB IMAP erstellen

Zusammenfassung

 ⚠ Die Instanz muss aktiviert sein!!!!

• Aktiv: IMAP Verbindung aktivieren

• Host: z. Bsp. imap.gmail.com

• Posteingang: Standard INBOX - Box die Überwacht werden soll - Mögliche Auswahl siehe imap.0.xxx.remote.change_folder Beispiel: INBOX.unterordner (punkt als seperator)

• Port: Standard 993

• Nutzername: Benutzername - Instanz muss aktiviert sein!!!

• Passwort: Passwort - Instanz muss aktiviert sein!!! - gmail login - outlook Oauth2-Authentifizierung

• max.: Maximale Anlage als Datenpunkte email_01...email_02... (1-99)

• max. HTML: Maximale Anzahl von eMails als HTML. Muss größer sein als max. Datenpunkte (1-99)

• TLS: TLS-Verbindung verwenden - Standard ist true

• Flaggen: Flag für die IMAP Abfrage. Mögliche Flags:

ALL - alle – Alle Nachrichten.
ANSWERED - geantwortet – Nachrichten mit gesetzter Beantwortet-Flagge.
DELETED - gelöscht – Nachrichten mit gesetzter Gelöscht-Flagge.
DRAFT - Entwurf – Nachrichten mit gesetzter Entwurfsflagge.
FLAGGED - gekennzeichnet – Nachrichten mit gesetzter Flagge.
NEW - neu – Nachrichten, bei denen das Flag „Zuletzt verwendet“ gesetzt ist, aber nicht das Flag „Gesehen“.
SEEN - gesehen – Nachrichten, bei denen das Flag „Gesehen“ gesetzt ist.
RECENT - jüngste – Nachrichten, bei denen das Flag „Zuletzt verwendet“ gesetzt ist.
OLD - alt – Nachrichten, für die das Flag „Zuletzt verwendet“ nicht gesetzt ist. Dies entspricht funktional !RECENT (im Gegensatz zu „!NEW“).
UNANSWERED - unbeantwortet – Nachrichten, bei denen das Flag „Beantwortet“ nicht gesetzt ist.
UNDELETED - ungelöscht – Nachrichten, für die das Flag „Gelöscht“ nicht gesetzt ist.
UNDRAFT - kein Entwurf – Nachrichten, bei denen das Draft-Flag nicht gesetzt ist.
UNFLAGGED - ungekennzeichnet – Nachrichten, für die das Flag „Markiert“ nicht gesetzt ist.
UNSEEN - ungesehen – Nachrichten, bei denen das Flag „Gesehen“ nicht gesetzt ist.

• Symbol auswählen: Symbol für den Ordner (unter TAB Symbole erstellen hochladen)

• tls-Option: Standard ist {"rejectUnauthorized": false}
• Auto-TLS: Mögliche Auswahl ist always, required and never. Standard ist never Für mehr Informationen bitte hier lesen.

• Att.: Um das Feld HTML zu füllen müssen Anhänge mit geladen werden. Das verbraucht sehr viel RAM!!! Daher Standard false
• Mailparser-Option: Mailparser-Option (erst unter TAB MAILPARSER-OPTIONEN erstellen)
• Token: Token hier erst anlegen

• max. MEMRSS-Limit: Ab wann die u. a. Aktion ausgelöst wird.
• Neu starten: Ist das MEMRSS Limit erreicht wird der Adapter neu gestartet. Es wird allerdings nur alle 24h geprüft.

• Objekt-ID: Ist das MEMRSS Limit erreicht wird der ausgewählt Datenpunkt auf true gesetzt. Dieser muss manuell zurückgesetzt werden. Es wird allerdings nur alle 24h geprüft.

• Senden: Ist das MEMRSS Limit erreicht wird eine Nachricht versendet. Es wird dann bei jeder Aktualisierung von MEMRSS eine Nachricht versendet.
  • Instanzen: Beispiel: telegram.0,telegram.1,pushover.0
  • Instanzen Benutzer: Beispiel: Peter,Olaf,Thomas

Instanz Konfiguration TAB Symbole erstellen

Zusammenfassung

• Symbolname: Name für das Symbol. Bitte keine doppelten Namen verwenden. Es wird dann bei Adapterstart ein Error im Logeintrag generiert.
• Upload: Das Icon hochladen.

Instanz Konfiguration TAB oauth2 erstellen

Zusammenfassung

• Name Name
• Kunden ID Client-ID
• Token Token
• Mandanten-ID Mandaten-ID

Instanz Konfiguration TAB Mailparser Optionen erstellen

Zusammenfassung

• Name: Name vom Mailparser. Bitte keine doppelten Namen verwenden. Es wird dann bei Adapterstart ein Error im Logeintrag generiert. Genaue Beschreibung kann hier gelesen werden.
• HTML in Text überspringen: Generiert keinen Klartext aus HTML
• Maximale HTML-Länge zum Parsen: Die maximale Menge an zu analysierendem HTML in Bytes. Wird diese überschritten werden nur Header Daten generiert.
• Bildlinks überspringen: Überspringt die Konvertierung von CID-Anhängen in Daten-URL-Bilder. Bilder werden nicht als base64 konvertiert was enormen RAM Verbrauch einspart.
• Text in HTML überspringen: Generiert kein HTML aus Klartextnachrichten
• Textlinks überspringen: Verlink keine Links in Klartextinhalten

Zustände (Objekte)

Zustände imap.0

Zusammenfassung

Zustände imap.0.benutzername

Zusammenfassung

Zustände imap.0.benutzername.email.email_xx

Zusammenfassung

Zustände imap.0.benutzername.infos

Zusammenfassung

Zustände imap.0.benutzername.remote

Zusammenfassung

Ordnername

Alte Ordnernamen können im Objekt imap.0.xxx.remote.change_folder eingesehen werden

Zustände imap.0.benutzername.remote.copy

Zusammenfassung

Zustände imap.0.benutzername.remote.flag

Zusammenfassung

Zustände imap.0.benutzername.remote.html

Zusammenfassung

Zustände imap.0.benutzername.remote.move

Zusammenfassung

Blocklys

Blockly IMAP Abfrage ändern

Zusammenfassung

• Hiermit kann man diese Datenpunkte setzen.
• Mögliche Flags findet man in der Instanz Konfig.
• Auswahl der IMAP Verbindung möglich oder für alle anwenden.
• Max. 100 Emails erlaubt.

Blockly IMAP eigene Abfrage

Zusammenfassung

• ACHTUNG! Hier kommen alle Daten wie z. Bsp. Anhänge. Diese Abfrage kann den RAM oder CPU ans Limit bringen. Wird ein fehlerhaftes Kriterium erstellt, kann dieses zum iobroker Absturtz führen!!!
• Die Daten werden dann als JSON geliefert.
• Bei Logausgaben wird das Logfile sehr groß. Daher später die Logausgaben wieder löschen.
• Es muss eine Variable mit dem Namen result erstellt werden.
• Max. 100 Emails erlaubt.
• Beispiele

Blockly IMAP Abfrage mit Instanz Einstellungen

Zusammenfassung

• Alle Daten von der IMAP Verbindung laden und selber verarbeiten. Als Suchkriterium wird die Instanz Einstellung verwendet.
• ACHTUNG! Hoher RAM Verbrauch
• Die Daten werden dann als JSON geliefert.
• Bei Logausgaben wird das Logfile sehr groß. Daher später die Logausgaben wieder löschen.
• Es muss eine Variable mit dem Namen result erstellt werden.
• Beispiele

Blockly IMAP Flags setzen

Zusammenfassung

• Bei einer eMail ein Flag setFlag=setzen, addFlag=hinzufügen oder delFlag=löschen.
• Postfach auswählen.
• Auswählen setFlag=setzen, addFlag=hinzufügen oder delFlag=löschen.
• Flag auswählen.
• Mögliche Flags siehe imap.0.xxx.status

Array JSON

Array JSON imap.0.xxx.email.email_xx.attach_json

Zusammenfassung

[
    {
        "partID": "2",
        "id": "<image001.png@01D9C718.240FAD50>",
        "uid": 86,
        "size": "159762",
        "filename": "image001.png",
        "type": "inline",
        "encoding": "base64"
    },
    {
        "partID": "3",
        "id": "<image002.png@01D9C718.36F8AE30>",
        "uid": 86,
        "size": "1296247",
        "filename": "image002.png",
        "type": "inline",
        "encoding": "base64"
    }
]

Array JSON imap.0.xxx.json

Zusammenfassung

[
    {
        "id": 1,
        "date": "15.08.2023 15:39:17",
        "from": ["test@luckyskills.de"],
        "from_name": ["Tester"],
        "attach": 0,
        "attach_info": [],
        "to": ["github@luckyskills.de"],
        "to_name": ["Lucky-ESA"],
        "subject": "Test",
        "text": "Am 2023-08-10 12:17, schrieb test@luckyskills.de:\n>>> TEST\n",
        "html": false,
        "textAsHtml": "Am 2023-08-10 12:17, schrieb <a href=\"mailto:test@luckyskills.de\">test@luckyskills.de</a>:<br/>&gt;&gt;&gt; TEST</p>",
        "seqno": 74,
        "uid": 93,
        "size": 1077,
        "flag": "unseen"
    }
]

JSON imap.0.xxx.last_activity_json

Zusammenfassung

{
    "modseq": "196",
    "flags": ["\\Seen"]
}

JSON imap.0.xxx.quality

Zusammenfassung

{
    "message": "No Message"
}

Möglichkeiten

0: "0x00 - good",
1: "0x01 - general problem",
2: "0x02 - no connection problem",
16: "0x10 - substitute value from controller",
17: "0x11 - general problem by instance",
18: "0x12 - instance not connected",
32: "0x20 - substitute initial value",
64: "0x40 - substitute value from device or instance",
65: "0x41 - general problem by device",
66: "0x42 - device not connected",
68: "0x44 - device reports error",
128: "0x80 - substitute value from sensor",
129: "0x81 - general problem by sensor",
130: "0x82 - sensor not connected",
132: "0x84 - sensor reports error",

JSON imap.0.xxx.status

Zusammenfassung

{
    "name": "INBOX",
    "flags": ["\\Answered", "\\Flagged", "\\Deleted", "\\Seen", "\\Draft"],
    "readOnly": false,
    "uidvalidity": 1667682367,
    "uidnext": 94,
    "permFlags": ["\\Answered", "\\Flagged", "\\Deleted", "\\Seen", "\\Draft"],
    "keywords": [],
    "newKeywords": true,
    "persistentUIDs": true,
    "nomodseq": false,
    "seq": 0,
    "time": 0,
    "reason": "",
    "user": "github_luckyskills_de",
    "messages": {
        "total": 74,
        "new": 0
    },
    "highestmodseq": "200"
}

Array JSON imap.0.online_history

Zusammenfassung

[
    {
        "client": "github_luckyskills_de",
        "time": 1692298599784,
        "status": "Online"
    },
    {
        "client": "github_luckyskills_de",
        "time": 1692298232899,
        "status": "Online"
    }
]

Changelog

WORK IN PROGRESS

• (Lucky-ESA) Admin 7.6.20 required

0.4.0 (2026-05-30)

• (copilot) Adapter requires node.js >= 22 now
• (Lucky-ESA) Description revised
• (Lucky-ESA) Admin 7.8.23 required
• (Lucky-ESA) JS-Controller 7.0.7 required
• (Lucky-ESA) Added meta object for attachments

0.3.0 (2024-12-07)

• (Lucky-ESA) Mailbox folder delete added
• (Lucky-ESA) Mailbox folder create added
• (Lucky-ESA) Change Mailbox Folder name added
• (Lucky-ESA) IMAP package changed
• (Lucky-ESA) Migration to ESLint9

0.2.2 (2024-11-07)

• (Lucky-ESA) New design for settings page added
• (Lucky-ESA) Crash if uid is empty for new emails

0.2.1 (2024-09-16)

• (Lucky-ESA) Update dependencies
• (Lucky-ESA) Changed Log info to debug
• (Lucky-ESA) Fixed blockly setFlag crash

0.2.0 (2024-06-15)

• (Lucky-ESA) Updated Blockly definitions
• (Lucky-ESA) JS-Controller >= 5.0.19 required
• (Lucky-ESA) Admin >=6.13.16 required

License

MIT License

Copyright (c) 2023-2026 Lucky-ESA github@luckyskills.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.