jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 00:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add IMAP fetch service (#32200)

Browse Source 
* Add IMAP fetch service

* Remove invalid data

* Tiny tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Jan Bouwhuis 2024-04-08 10:08:48 +02:00 committed by GitHub
parent b000e36d81
commit a83491f47e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
source/_integrations/imap.markdown
View File

@ -188,6 +188,7 @@ Available services are:
- `seen`: Mark the message as seen.
- `move`: Move the message to a `target_folder` and optionally mark the message `seen`.
- `delete`: Delete the message.
- `fetch`: Fetch the content of a message. Returns a dictionary containing `"text"`, `"subject"`, `"sender"` and `"uid""`. This allows to fetch and process the complete message text, not limited by size.
<div class='note warning'>
@ -197,13 +198,13 @@ When these services are used in an automation, make sure the right triggers and
## Example - post-processing
The example below filters the event trigger by `entry_id` and marks the message in the event as seen. The `seen` service `entry_id` can be a template or literal string. In UI mode you can select the desired entry from a list as well.
The example below filters the event trigger by `entry_id`, fetches the message and stores it in `message_text`. It then marks the message in the event as seen and finally, it adds a notification with the subject of the message. The `seen` service `entry_id` can be a template or literal string. In UI mode you can select the desired entry from a list as well.
{% raw %}
```yaml
alias: imap seen example
description: Mark in incoming message as seen
alias: imap fetch and seen example
description: Fetch and mark an incoming message as seen
trigger:
- platform: event
event_type: imap_content
@ -213,11 +214,19 @@ condition:
- condition: template
value_template: "{{ trigger.event.data['sender'] == 'info@example.com' }}"
action:
- service: imap.fetch
data:
entry: 91fadb3617c5a3ea692aeb62d92aa869
uid: "{{ trigger.event.data['uid'] }}"
response_variable: message_text
- service: imap.seen
data:
entry: 91fadb3617c5a3ea692aeb62d92aa869
uid: "{{ trigger.event.data['uid'] }}"
- service: persistent_notification.create
metadata: {}
data:
entry: "{{ trigger.event.data['entry_id'] }}"
uid: "{{ trigger.event.data['uid'] }}"
message: "{{ message_text['subject'] }}"
mode: single
```