Skip to content

Documentation for Exposing IMAP Search String #8034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 2 commits into from
Jan 21, 2019
Merged

Documentation for Exposing IMAP Search String #8034

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a0b37a
Documentation for Exposing IMAP Search String
mwegner Jan 3, 2019
265c2dc
Rewrote Last Sentence for More Clarity
mwegner Jan 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions source/_components/sensor.imap.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!