update readme

Lucky-ESA · Aug 20, 2023 · 326d5e3 · 326d5e3
1 parent b8fa216
commit 326d5e3
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@
 ## imap adapter for ioBroker
 
 -   Monitor your email accounts via IMAP (Internet Message Access Protocol)
+-   Receive notification of new emails or updates (e. g. marked unseen)
+-   Simple login with password and username (without xoauth2 or xoauth).
 
 ## Requirements
 
@@ -36,6 +38,7 @@
 -   gmail [app-password](https://support.google.com/mail/answer/185833?hl=de)
 -   vodafone
 -   strato
+-   outlook (e. g. [outlook 2Factor authentication](https://mcuiobroker.gitbook.io/jarvis-infos/tipps/allgemein/microsoft-windows/2-fach-authentifizierung))
 
 ## Description
 
@@ -55,10 +58,11 @@
 
 ### **WORK IN PROGRESS**
 
--   (Lucky-ESA) Added RAM consumption - Instance Config
+-   (Lucky-ESA) Added RAM consumption - Instance Settings
 -   (Lucky-ESA) Added german documention
 -   (Lucky-ESA) Added Mailparser options
 -   (Lucky-ESA) Added counter history
+-   (Lucky-ESA) Bug fixes
 
 ### 0.0.9 (2023-07-26)
 

diff --git a/docs/de/README.md b/docs/de/README.md
@@ -3,10 +3,12 @@
 # ioBroker.imap
 
 ```:warning:
- ⚠ Dieser Adapter kann das System sehr schnell zum Absturz bringen.
+ ⚠ 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](/README.md)
+
 # Zusammenfassung
 
 -   [Instanz Einstellungen](#instanz-einstellungen)
@@ -48,9 +50,8 @@
 -   `Posteingang`: Standard INBOX - Box die Überwacht werden soll - Mögliche Auswahl siehe imap.0.xxx.remote.change_folder
 -   `Port`: Standard 993
 -   `Nutzername`: Benutzername - Instanz muss aktiviert sein!!!
--   `Passwort`: Passwort - Instanz muss aktiviert sein!!!
-
-![imap_create_1.png](img/imap_create_1.png)
+-   `Passwort`: Passwort - Instanz muss aktiviert sein!!! - [gmail login](https://support.google.com/mail/answer/185833?hl=de) - [outlook 2-Fach-Authentifizierung](https://mcuiobroker.gitbook.io/jarvis-infos/tipps/allgemein/microsoft-windows/2-fach-authentifizierung)
+    ![imap_create_1.png](img/imap_create_1.png)
 
 -   `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)
@@ -132,12 +133,12 @@ UNSEEN - ungesehen – Nachrichten, bei denen das Flag „Gesehen“ nicht geset
 
 [Zusammenfassung](#zusammenfassung)
 
-| Objekt                | Beschreibung                                                                              |
-| --------------------- | ----------------------------------------------------------------------------------------- |
-| imap.0.json_imap      | Name der IMAP Verbindung mit der letzten Aktivität                                        |
-| imap.0.json_table     | Letzte Aktualisierung einer IMAP Verbindung als JSON Table für VIS                        |
-| imap.0.online_counter | Anzahl der aktiven IMAP Verbindungen                                                      |
-| imap.0.online_history | History der Verbindungsaktivitäten als JSON - [Beispiel](#array-json-imap0online_history) |
+| Objekt                | Beschreibung                                                                                    |
+| --------------------- | ----------------------------------------------------------------------------------------------- |
+| imap.0.json_imap      | Name der IMAP Verbindung mit der letzten Aktivität. Trigger für eingehende Emails oder Updates. |
+| imap.0.json_table     | Letzte Aktualisierung einer IMAP Verbindung als JSON Table für VIS.                             |
+| imap.0.online_counter | Anzahl der aktiven IMAP Verbindungen.                                                           |
+| imap.0.online_history | History der Verbindungsaktivitäten als JSON - [Beispiel](#array-json-imap0online_history).      |
 
 ![imap_total_overview.png](img/imap_total_overview.png)
 
@@ -239,7 +240,7 @@ UNSEEN - ungesehen – Nachrichten, bei denen das Flag „Gesehen“ nicht geset
 | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
 | imap.0.xxx.remote.copy.apply_copy | Änderung von folder und uid anwenden.                                                                                     |
 | imap.0.xxx.remote.copy.folder     | Ordner auswählen in dem die ausgewählt Mail kopiert werden soll.                                                          |
-| imap.0.xxx.remote.copy.uid        | Hier die UID der eMail eintragen die kopiert werden soll. Die UID findet ihr im imap.0.xxx.json oder in den email Ordnern |
+| imap.0.xxx.remote.copy.uid        | Hier die UID der eMail eintragen die kopiert werden soll. Die UID findet man im imap.0.xxx.json oder in den email Ordnern |
 
 ![imap_overview_remote_copy.png](img/imap_overview_remote_copy.png)
 
@@ -252,7 +253,7 @@ UNSEEN - ungesehen – Nachrichten, bei denen das Flag „Gesehen“ nicht geset
 | imap.0.xxx.remote.flag.apply_flag | Änderung von set, type und uid anwenden.                                                                                  |
 | imap.0.xxx.remote.flag.set        | Auswahl setFlag für Flag setzen, addFlag für ein Flag hinzuzufügen und delFlag für ein Flag zu löschen                    |
 | imap.0.xxx.remote.flag.type       | Flag auswählen der hinzugefügt, gesetzt oder gelöscht werden soll                                                         |
-| imap.0.xxx.remote.flag.uid        | Die UID an der die Flag Änderung vorgenommen werden soll. Die UID findet ihr im imap.0.xxx.json oder in den email Ordnern |
+| imap.0.xxx.remote.flag.uid        | Die UID an der die Flag Änderung vorgenommen werden soll. Die UID findet man im imap.0.xxx.json oder in den email Ordnern |
 
 ![imap_overview_remote_flag.png](img/imap_overview_remote_flag.png)
 

diff --git a/docs/en/README.md b/docs/en/README.md
@@ -3,10 +3,12 @@
 # ioBroker.imap
 
 ```:warning:
- ⚠ This adapter can crash the system very quickly.
+ ⚠ This adapter can crash the system very quickly with the Blockly (own query).
  ⚠ So please read this description carefully.
 ```
 
+[Back to the README](/README.md)
+
 # Summary
 
 -   [Instance Settings](#instance-settings)
@@ -49,6 +51,8 @@
 -   `Port`: Port - Default 993
 -   `Username`: Username - Instance must be activated!!!
 -   `Password`: Password - Instance must be activated!!!
+    -   [gmail login](https://support.google.com/mail/answer/185833?hl=de)
+    -   [outlook 2Factor authentication](https://mcuiobroker.gitbook.io/jarvis-infos/tipps/allgemein/microsoft-windows/2-fach-authentifizierung)
 
 ![imap_create_1.png](img/imap_create_1.png)
 
@@ -132,12 +136,12 @@ UNSEEN - Messages that do not have the Seen flag set.
 
 [Summary](#summary)
 
-| Object                | Description                                                                      |
-| --------------------- | -------------------------------------------------------------------------------- |
-| imap.0.json_imap      | Name of the IMAP connection of the last activity                                 |
-| imap.0.json_table     | Last update of an IMAP connection as a JSON table for VIS                        |
-| imap.0.online_counter | Number of active IMAP connections                                                |
-| imap.0.online_history | Connection activity history as JSON - [Example](#array-json-imap0online_history) |
+| Object                | Description                                                                               |
+| --------------------- | ----------------------------------------------------------------------------------------- |
+| imap.0.json_imap      | Name of the IMAP connection of the last activity. Trigger for incoming emails or updates. |
+| imap.0.json_table     | Last update of an IMAP connection as a JSON table for VIS.                                |
+| imap.0.online_counter | Number of active IMAP connections.                                                        |
+| imap.0.online_history | Connection activity history as JSON - [Example](#array-json-imap0online_history).         |
 
 ![imap_total_overview.png](img/imap_total_overview.png)