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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation for Exposing IMAP Search String (#8034)

Browse Source 
* Documentation for Exposing IMAP Search String

To accompany a PR to sensor/imap.py

* Rewrote Last Sentence for More Clarity
This commit is contained in:
Matthew Wegner 2019-01-21 15:00:22 -07:00 committed by Franck Nijhof
parent a8cd28c5cf
commit 6bc6467b0f
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/_components/sensor.imap.markdown
View File

@ -57,4 +57,18 @@ folder:
required: false
default: inbox
type: string
search:
description: The IMAP search to perform on the watched folder.
required: false
default: UnSeen UnDeleted
type: string
{% endconfiguration %}
### {% linkable_title Configuring IMAP Searches %}
By default, this component will count unread emails. By configuring the search string, you can count other results, for example:
* `ALL` to count all emails in a folder
* `FROM`, `TO`, `SUBJECT` to find emails in a folder (see [IMAP RFC for all standard options](https://tools.ietf.org/html/rfc3501#section-6.4.4))
* [Gmail's IMAP extensions](https://developers.google.com/gmail/imap/imap-extensions) allow raw Gmail searches, like `X-GM-RAW "in: inbox older_than:7d"` to show emails older than one week in your inbox. Note that raw Gmail searches will ignore your folder configuration and search all emails in your account!