This commit is contained in:
Fabian Affolter 2019-10-27 20:52:41 +01:00 committed by GitHub
parent 057fb85caf
commit b9b241c3a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 10 deletions

View File

@ -8,7 +8,7 @@ ha_release: 0.25
ha_iot_class: Cloud Push ha_iot_class: Cloud Push
--- ---
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. The `imap` integration is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails.
## Configuration ## Configuration
@ -56,9 +56,9 @@ search:
default: UnSeen UnDeleted default: UnSeen UnDeleted
type: string type: string
charset: charset:
description: The characterset used for this connection description: The character set used for this connection.
required: false required: false
default: UTF-8 default: utf-8
type: string type: string
{% endconfiguration %} {% endconfiguration %}
@ -81,7 +81,6 @@ sensor:
username: YOUR_USERNAME username: YOUR_USERNAME
password: YOUR_PASSWORD password: YOUR_PASSWORD
search: FROM <sender@email.com>, SUBJECT <subject here> search: FROM <sender@email.com>, SUBJECT <subject here>
charset: utf-8
# Example configuration.yaml entry for Office 365 # Example configuration.yaml entry for Office 365
sensor: sensor:

View File

@ -8,7 +8,7 @@ ha_iot_class: Cloud Push
ha_release: 0.25 ha_release: 0.25
--- ---
The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email. The `imap_email_content` integration will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email.
## Configuration ## Configuration
@ -20,9 +20,9 @@ sensor:
- platform: imap_email_content - platform: imap_email_content
server: imap.gmail.com server: imap.gmail.com
port: 993 port: 993
username: USERNAME username: YOUR_USERNAME
password: PASSWORD password: YOUR_PASSWORD
folder: <Folder> folder: YOUR_FOLDER
senders: senders:
- example@gmail.com - example@gmail.com
``` ```
@ -68,7 +68,7 @@ value_template:
body: body:
description: The body of the email. description: The body of the email.
subject: subject:
description: The subject of the email. description: The subject of the email.git.
date: date:
description: The date and time the email was sent. description: The date and time the email was sent.
{% endconfiguration %} {% endconfiguration %}
@ -97,4 +97,4 @@ sensor:
``` ```
{% endraw %} {% endraw %}
The same template structure can scan the date, body, or sender for matching text before setting the state of the sensor. The same template structure can scan the date, body or sender for matching text before setting the state of the sensor.