diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown new file mode 100644 index 00000000000..54e1db5bc94 --- /dev/null +++ b/source/_components/sensor.imap.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "IMAP Sensor" +description: "Instructions how to integrate IMAP sensors into Home Assistant." +date: 2016-07-11 06:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Sensor +ha_release: 0.24 +--- + + +The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. + +To enable this sensor, add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: imap + server: imap.gmail.com + port: 993 + name: Emails + user: USERNAME + password: PASSWORD +``` + +Configuration variables: + +- **server** (*Required*): The IP address or hostname of the IMAP server. +- **port** (*Required*): The port where the server is accessible. +- **name** (*Optional*): Name of the IMAP sensor. +- **user** (*Required*): Username for the IMAP server. +- **password** (*Required*): Password for the IMAP server. +