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-04-29 07:47:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/sensor.imap.markdown
DavidFW1960 2f29fd458f Adding example for doing a search (#8431) 
* 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
2019-02-11 14:52:57 +01:00

2.4 KiB
Raw Blame History

layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page IMAP Unread E-mail Instructions on how to integrate IMAP unread email into Home Assistant. 2016-07-11 06:00 true false true true smtp.png Mailbox 0.25 Cloud Push

The imap sensor platform is observing your IMAP server and reporting the amount of unread emails.

{% linkable_title Configuration %}

To enable this sensor, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: imap
    server: YOUR_IMAP_SERVER
    username: YOUR_USERNAME
    password: YOUR_PASSWORD

{% configuration %} server: description: The IP address or hostname of the IMAP server. required: true type: string port: description: The port where the server is accessible. required: false default: 993 type: integer name: description: Name of the IMAP sensor. required: false type: string username: description: Username for the IMAP server. required: true type: string password: description: Password for the IMAP server. required: true type: string folder: description: The IMAP folder to watch. 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)
  • Gmail's 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 %}

# 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>