Skip to content

Latest commit

 

History

History
587 lines (467 loc) · 36.2 KB

README.md

File metadata and controls

587 lines (467 loc) · 36.2 KB
Raw

Logo

ioBroker.imap

 ⚠ This adapter can crash the system very quickly with the Blockly (own query).
 ⚠ So please read this description carefully.

Back to the README

Summary

Instance Settings

Instance settings TAB - Create IMAP`s

Summary

 ⚠ The instance must be activated!!!!
  • Activ: Enable IMAP connection
  • Host: Host - e.g. imap.gmail.com
  • Inbox: Default INBOX - Box to be monitored - Possible selection see imap.0.xxx.remote.change_folder
  • Port: Port - Default 993
  • Username: Username - Instance must be activated!!!
  • Password: Password - Instance must be activated!!!

imap_create_1.png

  • max.: Create maximum as data points - email_01...email_02... (1-99)
  • max. HTML: Maximum number of emails as HTML. Should be greater than max data points (1-99)
  • TLS: Use TLS-Connection - Default true
  • Flags: Flags for the query - Possible flags:
ALL - All messages.
ANSWERED - Messages with the Answered flag set.
DELETED - Messages with the Deleted flag set.
DRAFT - Messages with the Draft flag set.
FLAGGED - Messages with the Flagged flag set.
NEW - Messages that have the Recent flag set but not the Seen flag.
SEEN - Messages that have the Seen flag set.
RECENT - Messages that have the Recent flag set.
OLD - Messages that do not have the Recent flag set. This is functionally equivalent to "!RECENT" (as opposed to "!NEW").
UNANSWERED - Messages that do not have the Answered flag set.
UNDELETED - Messages that do not have the Deleted flag set.
UNDRAFT - Messages that do not have the Draft flag set.
UNFLAGGED - Messages that do not have the Flagged flag set.
UNSEEN - Messages that do not have the Seen flag set.
  • Choose icon: Folder icon (upload under TAB CREATE ICON)

imap_create_icon.png

  • tls Option: Default {"rejectUnauthorized": false}
  • auto tls: Set to always to always attempt connection upgrades via STARTTLS, required only if upgrading is required, or never to never attempt upgrading. Default: never For more information

imap_create_2.png

  • Att.: In order to fill the HTML field, attachments must also be loaded. Very high RAM consumption!!! Default false
  • Mail option: Mailparser-Option (Create under TAB MAILPARSER OPTIONEN)

imap_create_3.png

  • max. MEMRSS-Limit: From when the actions listed below should be triggered. Default 400 MB
  • Restart: When the MEMRSS limit is reached, the adapter restarts. It is checked every 24 hours.

imap_create_restart.png

  • Datapoint: When the MEMRSS limit is reached, the selected data point is set to true. This must be reset manually. It is checked every 24 hours.

imap_create_datapoint.png

  • Send: A message is sent when the MEMRSS limit is reached. A message will then be sent whenever MEMRSS is updated.
    • Instance: e. g. telegram.0,telegram.1,pushover.0
    • Instance User: e. g. Peter,Olaf,Thomas

imap_create_send.png

Instance settings TAB - Create ICONS

Summary

  • Icon Name: Name for the icon. Please do not use duplicate names. An error message is output when the adapter starts.
  • Upload: Upload icon.

imap_create_icon.png

Instance settings TAB - MAILPARSER OPTIONS

Summary

  • Name: Name for the Mailparser. Please do not use duplicate names. An error message is output when the adapter starts. There is a detailed description here.
  • skip Html To Text: Don’t generate plaintext from HTML.
  • max Html Length To Parse: The maximum amount of HTML to parse in bytes. If this is exceeded, only header data is generated.
  • skip Image Links: Skip converting CID attachments to data URL images. Images are not converted as base64 which saves huge RAM usage.
  • skip Text To Html: Don’t generate HTML from plaintext message.
  • skip Text Links: Do not linkify links in plaintext content.

imap_create_mailparser.png

Data points

Data point imap.0

Summary

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.

imap_total_overview.png

Data point imap.0.username

Summary

Object Description
imap.0.xxx.active_inbox Active Inbox
imap.0.xxx.host Hostname
imap.0.xxx.html HTML Code for VIS
imap.0.xxx.json JSON Table for VIS - Example
imap.0.xxx.last_activity Last activity
imap.0.xxx.last_activity_json Activity as array JSON - Example
imap.0.xxx.last_activity_timestamp Last activity timestamp
imap.0.xxx.online IMAP status Verbindung
imap.0.xxx.quality Quality of all data points as JSON. Is updated every 24 hours - Example
imap.0.xxx.status Information about the IMAP connection as JSON - Example
imap.0.xxx.total Total eMails
imap.0.xxx.total_unread Total unread eMails

imap_overview_1.png

Data point imap.0.username.email.email_xx

Summary

Object Description
imap.0.xxx.email.email_01.attach Number of attachments and images in the body
imap.0.xxx.email.email_01.attach_json Infos der Anhänge als JSON - Beispiel
imap.0.xxx.email_01.content Content of the email
imap.0.xxx.email.email_01.flag Email flags
imap.0.xxx.email.email_01.from All sender as Array
imap.0.xxx.email.email_01.receive Received date
imap.0.xxx.email.email_01.seq Sequence number
imap.0.xxx.email.email_01.size Size of the email in bytes
imap.0.xxx.email.email_01.subject Subject
imap.0.xxx.email.email_01.texthtml Content as HTML
imap.0.xxx.email.email_01.to Recipient as Array
imap.0.xxx.email.email_01.uid Unique UID

imap_overview_email_single.png imap_overview_email.png

Data point imap.0.username.infos

Summary

Object Description
imap.0.xxx.infos.all_capability All capability from IMAP connection
imap.0.xxx.infos.auth_cram-md5 Authentication method auth_cram-md5
imap.0.xxx.infos.auth_xoauth Authentication method xoauth
imap.0.xxx.infos.auth_xoauth2 Authentication method xoauth2
imap.0.xxx.infos.condstore MODSEQ request possible lookup
imap.0.xxx.infos.esearch Search multiple mailboxes with one command
imap.0.xxx.infos.id lookup
imap.0.xxx.infos.idle lookup
imap.0.xxx.infos.literal* lookup
imap.0.xxx.infos.logindisabled lookup
imap.0.xxx.infos.move Emails can be moved. lookup
imap.0.xxx.infos.namespace lookup
imap.0.xxx.infos.quota lookup
imap.0.xxx.infos.sasl-ir lookup
imap.0.xxx.infos.sort e-mails are retrieved sorted lookup
imap.0.xxx.infos.sort_display Header info is sorted. lookup
imap.0.xxx.infos.starttls Starttls is supported. Can then be set in the instance settings. lookup
imap.0.xxx.infos.thread_orderedsubject lookup
imap.0.xxx.infos.thread_references lookup
imap.0.xxx.infos.unselect lookup
imap.0.xxx.infos.x-gm-ext-1 lookup

imap_overview_capability.png imap_overview_capability_1.png

Data point imap.0.username.remote

Summary

Object Description
imap.0.xxx.remote.apply_html Apply change in imap.0.xxx.remote.html.
imap.0.xxx.remote.change_folder Instance settings: Change post folder to be monitored and displayed. Will only be reset after a reboot.
imap.0.xxx.remote.criteria Instance settings: Change search. Will only be reset after a reboot.
imap.0.xxx.remote.reload_emails Reload emails.
imap.0.xxx.remote.search_start Apply changes from change_folder, criteria and show_mails
imap.0.xxx.remote.show_mails Instance settings: Number of emails (max. HTML) to be loaded. Will only be reset after a reboot. Should of course be greater than the value max.
imap.0.xxx.remote.vis_command Command from the VIS to move mails from the selection boxes. Only used by VIS.

imap_overview_remote.png

Data point imap.0.username.remote.copy

Summary

Object Description
imap.0.xxx.remote.copy.apply_copy Apply change of copy.folder and copy.uid.
imap.0.xxx.remote.copy.folder Select folder in which the selected mail should be copied.
imap.0.xxx.remote.copy.uid Enter the UID of the email to be copied here. You can find the UID in imap.0.xxx.json or in the email folders

imap_overview_remote_copy.png

Data point imap.0.username.remote.flag

Summary

Object Description
imap.0.xxx.remote.flag.apply_flag Apply change of set, type and uid.
imap.0.xxx.remote.flag.set Select setFlag, addFlag and delFlag.
imap.0.xxx.remote.flag.type Select flag to add, set or delete.
imap.0.xxx.remote.flag.uid The UID to which the flag change should be made. You can find the UID in imap.0.xxx.json or in the email folders.

imap_overview_remote_flag.png

Data point imap.0.username.remote.html

Summary

Object Description
imap.0.xxx.remote.html.body_background Background Body - Default #000000
imap.0.xxx.remote.html.choose_content Display attribute from email.
Possible fields are html, text, textAsHtml and html convert.
imap.0.xxx.remote.html.header_border Header border - Default 2 px
imap.0.xxx.remote.html.header_font Header font - Default Helvetica
imap.0.xxx.remote.html.header_font_size Header font size - Default 15 px
imap.0.xxx.remote.html.header_linear_color_1 Gradient background header value 1 - Default #424242
imap.0.xxx.remote.html.header_linear_color_2 Gradient background header value 2 - Default #424242
imap.0.xxx.remote.html.header_tag_border_color Header border color - Default #424242 - Everything possible
imap.0.xxx.remote.html.header_text_color Header text color - Default #BDBDBD
imap.0.xxx.remote.html.header_width Header width - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_align_column_1 Header align column 1 - Default center
Possible center, left, right and auto

imap_overview_remote_html_1.png

Object Description
imap.0.xxx.remote.html.headline_align_column_2 Text alignment header column 2 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_3 Text alignment header column 3 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_4 Text alignment header column 4 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_5 Text alignment header column 5 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_6 Text alignment header column 6 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_7 Text alignment header column 7 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_8 Text alignment header column 8 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_9 Text alignment header column 9 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_align_column_10 Text alignment header column 10 - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.headline_color Border color Body - Default #BD5A3C
imap.0.xxx.remote.html.headline_column_width_1 column width column 1 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_10 column width column 10 - Default auto - Possible px or %

imap_overview_remote_html_2.png

Objekt Description
imap.0.xxx.remote.html.headline_column_width_2 column width column 2 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_3 column width column 3 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_4 column width column 4 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_5 column width column 5 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_6 column width column 6 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_7 column width column 7 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_8 column width column 8 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_column_width_9 column width column 9 - Default auto - Possible px or %
imap.0.xxx.remote.html.headline_font_size Font size in the cell - Default 16 px
imap.0.xxx.remote.html.headline_height Cell height - Default 35 px
imap.0.xxx.remote.html.headline_style Style Cell - Default normal - Possible normal or bold

imap_overview_remote_html_3.png

Objekt Description
imap.0.xxx.remote.html.headline_underlined Cell border - Default 3 px
imap.0.xxx.remote.html.headline_underlined_color Cell border color - Default #ffffff
imap.0.xxx.remote.html.jarvis Code customization for View in Jarvis
imap.0.xxx.remote.html.mails_even_color Line background color for even IDs - Default #333333
imap.0.xxx.remote.html.mails_nextday_color_even Line background color for even IDs yesterday - Default #F7FFE0
imap.0.xxx.remote.html.mails_nextday_color_odd Line background color for odd IDs yesterday - Default #F7FFE0
imap.0.xxx.remote.html.mails_odd_color Line background color for odd IDs - Default #FFE32E
imap.0.xxx.remote.html.mails_today_color Line background color for even IDs today - Default #ffffff
imap.0.xxx.remote.html.mails_today_color_odd Line background color for odd IDs today - Default #ffffff
imap.0.xxx.remote.html.p_tag_text_align Text align Header and Footer - Default center
Possible center, left, right and auto
imap.0.xxx.remote.html.short_content Character limitation in the Content - Default 35
imap.0.xxx.remote.html.short_subject Character limitation in the Subject - Default 35
imap.0.xxx.remote.html.table_tag_border_color Table border color - Default #424242

imap_overview_remote_html_4.png

Objekt Description
imap.0.xxx.remote.html.table_tag_cell Table border spacing - Default 6 px
imap.0.xxx.remote.html.table_tag_text_align Table margin - Default auto - Possible px or %
imap.0.xxx.remote.html.table_tag_width Table width - Default auto - Possible px or %
imap.0.xxx.remote.html.td_tag_2_colums Line border of line 1 and 2 - Default auto - Possible px or %
imap.0.xxx.remote.html.td_tag_border_bottom Line under border - Default 1 px
imap.0.xxx.remote.html.td_tag_border_color Line under border color - Default #424242
imap.0.xxx.remote.html.td_tag_border_right Cell border right - Default 1 px
imap.0.xxx.remote.html.td_tag_cell Cell spacing in the rows - Default 6 px
imap.0.xxx.remote.html.text_content Header text column 5 - Default Content
imap.0.xxx.remote.html.text_date Header text column 4 - Default Date
imap.0.xxx.remote.html.text_flag Header text column 7 - Default Flags
imap.0.xxx.remote.html.text_from Header text column 2 - Default From

imap_overview_remote_html_5.png

Objekt Description
imap.0.xxx.remote.html.text_id Header text column 1 - Default ID
imap.0.xxx.remote.html.text_move_or_copy Header text column 9 - Default copy/paste
imap.0.xxx.remote.html.text_select_addflag Text in flag selection box - Default addFlags -
imap.0.xxx.remote.html.text_select_copy Text in Kopie selection box - Default copy
imap.0.xxx.remote.html.text_select_delflag Text in Flag selection box - Default delFlags -
imap.0.xxx.remote.html.text_select_move Text in Kopie selection box - Default move
imap.0.xxx.remote.html.text_select_setflag Text in Flag selection box - Default setFlags -
imap.0.xxx.remote.html.text_seq Header text column 6 - Default SEQ
imap.0.xxx.remote.html.text_setflag Header text column 10 - Default Flag action
imap.0.xxx.remote.html.text_subject Header text column 3 - Default Subject
imap.0.xxx.remote.html.text_uid Header text column 8 - Default UID
imap.0.xxx.remote.html.top_font Font Header und Footer - Default Helvetica

imap_overview_remote_html_6.png

Objekt Description
imap.0.xxx.remote.html.top_font_size Font size Header und Footer - Default 20 px
imap.0.xxx.remote.html.top_font_weight Schriftstärke Header und Footer - Default normal - Possible normal or bold
imap.0.xxx.remote.html.top_text Header text Default the Username
imap.0.xxx.remote.html.top_text_color Header text color - Default #ffffff

imap_overview_remote_html_7.png

Data point imap.0.username.remote.move

Summary

Objekt Description
imap.0.xxx.remote.move.apply_move Apply change of folder and uid.
imap.0.xxx.remote.move.folder Select folder in which the selected mail should be moved.
imap.0.xxx.remote.move.uid Enter the UID of the email to be moved here. You can find the UID in imap.0.xxx.json or in the email folders.

imap_overview_remote_move.png

Blocklys

Blockly - Change IMAP query

Summary

  • With this you can set these data points.
  • See the instance setting for possible flags.
  • Select IMAP connection or apply to all.
  • Max. 100 emails allowed.

blockly_imap_1.png blockly_imap_2.png

Blockly - IMAP own query

Summary

  • DANGER! Here comes all the data such. E.g. attachments. This query can push the RAM or CPU to the limit. If an incorrect criterion is created, this can lead to an iobroker crash!!!
  • The data is then delivered as JSON.
  • With log outputs, the log file becomes very large. Therefore delete the log outputs again later.
  • A variable called result must be created.
  • Max. 100 emails allowed.
  • Beispiele

blockly_imap_request.png

Blockly - IMAP query with instance settings

Summary

  • Load all data from the IMAP connection and process it yourself. The instance setting is used as the search criterion.
  • DANGER! Higher RAM consumption
  • The data is then delivered as JSON.
  • With log outputs, the log file becomes very large. Therefore delete the log outputs again later.
  • A variable called result must be created.
  • Example

blockly_imap_current.png

Blockly - Set IMAP flags

Summary

  • Set a flag setFlag=set, addFlag=add or delFlag=delete for an email.
  • Select mailbox.
  • Select setFlag=set, addFlag=add or delFlag=delete.
  • select flag.
  • Possible flags in imap.0.xxx.status

blockly_imap_flag.png

Array JSON

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

Summary

[
    {
        "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

Summary

[
    {
        "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

Summary

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

JSON imap.0.xxx.quality

Summary

{
    "message": "No Message"
}

Possibilities

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

Summary

{
    "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

Summary

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