automated commit 20/07/2019 13:14:00

info.md

@@ -0,0 +1,51 @@
+# Home Assistant Email Sensor
+
+Gets emails from SMTP and prases out any tracking numbers from FedEx, UPS, USPS, Rockauto, Newegg, B&H Photo, Paypal, eBay, DHL, and Ali Express. Goes well with the [tracking-number-card](https://github.com/ljmerza/tracking-number-card) for lovelace!
+
+---
+
+[![GitHub Release][releases-shield]][releases]
+[![License][license-shield]](LICENSE.md)
+
+![Project Maintenance][maintenance-shield]
+[![GitHub Activity][commits-shield]][commits]
+
+## Installation
+
+* Add the `email` folder in your `custom_components` folder
+* If the component doesn't load this might be due to Home Assistant not installing the requirements automatically through the manifests file. You can install them manaually by running `pip install beautifulsoup4==4.7.1 imapclient==2.1.0 mail-parser==3.9.3`
+* If you use 2 factor authentication for Google you'll need to create an app password. See more details [here](https://support.google.com/accounts/answer/185833?hl=en)
+
+
+## Options
+
+| Name | Type | Requirement | `default` Description
+| ---- | ---- | ------- | -----------
+| email | string | **Required** | email address
+| password | string | **Required** | email password
+| smtp_server | string | **Optional** | `imap.gmail.com`  SMTP server address>
+| smtp_port | number | **Optional** | `993` SMTP port
+| folder | string | **Optional** | `INBOX` Which folder to pull emails from
+| show_all | boolean | **Optional** | `false` Show only unseen emails (default) or all emails from `folder`
+
+```yaml
+sensor:
+  - platform: email
+    email: !secret my_email
+    password: !secret my_email_password
+```
+
+
+---
+
+Enjoy my card? Help me out for a couple of :beers: or a :coffee:!
+
+[![coffee](https://www.buymeacoffee.com/assets/img/custom_images/black_img.png)](https://www.buymeacoffee.com/JMISm06AD)
+
+
+[commits-shield]: https://img.shields.io/github/commit-activity/y/ljmerza/ha-email-sensor.svg?style=for-the-badge
+[commits]: https://github.com/ljmerza/ha-email-sensor/commits/master
+[license-shield]: https://img.shields.io/github/license/ljmerza/ha-email-sensor.svg?style=for-the-badge
+[maintenance-shield]: https://img.shields.io/badge/maintainer-Leonardo%20Merza%20%40ljmerza-blue.svg?style=for-the-badge
+[releases-shield]: https://img.shields.io/github/release/ljmerza/ha-email-sensor.svg?style=for-the-badge
+[releases]: https://github.com/ljmerza/ha-email-sensor/releases