home-assistant.io/source/_components/sensor.imap.markdown
noxhirsch 06ab18d9d0 Update sensor.imap.markdown (#6775)
* Update sensor.imap.markdown

Update IMAP Sensor configuration variable

* Update sensor.imap.markdown
2018-10-14 09:12:07 +02:00

1.3 KiB

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: imap.gmail.com
    port: 993
    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 {% endconfiguration %}