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 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding example for doing a search (#8431)

Browse Source 
* Adding example for doing a search

Not intuitive and it took me a while but I worked it out so I'm documenting here.

* Minimize the conf sample and move search to full sample
This commit is contained in:
DavidFW1960 2019-02-12 00:52:57 +11:00 committed by Fabian Affolter
parent 35abeebf0f
commit 2f29fd458f
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,8 +24,7 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry
sensor:
- platform: imap
server: imap.gmail.com
port: 993
server: YOUR_IMAP_SERVER
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
@ -66,9 +65,21 @@ search:
### {% 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:
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!
* [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!
#### {% linkable_title Full configuration sample with search %}
```yaml
# Example configuration.yaml entry
sensor:
- platform: imap
server: imap.gmail.com
port: 993
username: YOUR_USERNAME
password: YOUR_PASSWORD
search: FROM <sender@email.com>, SUBJECT <subject here>
```