/ha-email-sensor

Email Sensor for collecting tracking numbers from over 30 providers.

Primary LanguagePythonMIT LicenseMIT

Home Assistant Email Sensor

Gets emails from IMAP and parses out any tracking numbers. Goes well with the tracking-number-card for lovelace!

Supported Emails

  • Adafruit
  • Adam & Eve
  • Amazon
  • Ali Express
  • B&H Photo
  • Bespoke Post
  • Best Buy
  • Chewy
  • DHL
  • Dollar Shave Club
  • DSW
  • eBay
  • FedEx
  • Gamestop
  • Georgia Power
  • Google Express
  • Groupon
  • Guitar Center
  • Litter Robot
  • Manta Sleep
  • Monoprice
  • NewEgg
  • Nintendo
  • Nuleaf
  • Paypal
  • Pledge Box
  • Philips Hue
  • Prusa
  • Reolink
  • Rockauto
  • Sylvane
  • Sony
  • Swiss Post
  • Target
  • Timeless
  • The Smartest House
  • Ubiquiti
  • UPS
  • USPS
  • Wyze
  • Zazzle

If you want support for tracking, forward me the email (ljmerza at gmail) and open an issue.

GitHub Release License

Project Maintenance GitHub Activity

Installation

  • Add the email folder in your custom_components folder
sensor:
  - platform: email
    email: !secret my_email
    password: !secret my_email_password
  • 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

Options

Name Type Requirement default Description
email string Required email address
password string Required email password
imap_server string Optional imap.gmail.com IMAP server address>
imap_port number Optional 993 IMAP port
folder string Optional INBOX Which folder to pull emails from
ssl boolean Optional true enable or disable SSL when using IMAP
days_old number Optional 30 how many days of emails to retrieve

Enjoy my card? Help me out for a couple of 🍻 or a ☕!

coffee