Skip to content

Home Assistant integration providing day of package counts and USPS informed delivery images.

Notifications You must be signed in to change notification settings

chrisceska/Home-Assistant-Mail-And-Packages

 
 

Repository files navigation

GitHub release (latest by date) hacs_badge

GitHub contributors Maintenance GitHub commit activity GitHub last commit

HomeAssistant Mail and Packages

This provides a Card, Custom Component, and Notifications for getting UPS, USPS, and FedEx delivery information in Home Assistant. This component shows a snapshot of the current days packages that are in transit for delivery on the current day or have already been delivered on the current day. It also generates the number of USPS mail pieces and images, if available, for the current day.

The component connects to the email account you supply where your shipment notifications are sent. It looks at the subject lines of the current day's emails from the shipping companies and counts the subject line matches to the known standard subject lines from the shipping companies. For USPS Informed delivery emails, it also downloads the mail images to combine them into a rotating GIF.

All procedures are done locally on your machine.

Supports only Lovelace UI. Last tested in 0.110.x.

Credits:

  • Huge contributions from @firstof9 moving the project forward and keeping it active!

Buy Us A Coffee

How it works

From your instance of HASS, the Mail and Packages integration connects to the email account you supply where your shipment notifications are sent. It reviews at the subject lines of the current day's emails from the shipping companies and counts the subject lines that match known language from the shipping companies about their transit status. For USPS Informed delivery emails, it also downloads the mail images to combine them into a rotating GIF.

  • All procedures are done locally on your machine.
  • No external services are used to process your email.
  • No data is sent outside of your local instance of Home Assistant

Search Terms

Shipper Email Subject Body Text
USPS [email protected] Informed Delivery Daily Digest none
USPS [email protected] Expected Delivery on out for delivery
USPS [email protected] Item Delivered none
UPS [email protected] UPS Update: Package Scheduled for Delivery Today none
UPS [email protected] UPS Update: Follow Your Delivery on a Live Map none
UPS [email protected] Your UPS Package was delivered none
FEDEX [email protected] Delivery scheduled for today none
FEDEX [email protected] Your package is scheduled for delivery today none
FEDEX [email protected] Your package has been delivered none
Amazon [email protected] none regex order numbers
Amazon [email protected] none regex order numbers

Installation

HACS (Recommended)

  1. Have HACS installed, this will allow you to easily update
  2. Add https://github.com/moralmunky/Home-Assistant-Mail-And-Packages as a custom repository and Type: Integration
  3. Click install under "Mail and Packages", restart your instance.

Manual Installation

  1. Download this repository as a ZIP (green button, top right) and unzip the archive
  2. Copy the mail_and_packages folder inside the custom_components folder to the Home Assistant /<config path>/custom_components/ directory
    • You may need to create the custom_components in your Home Assistant installation folder if it does not exist
    • On Home Assistant (formerly Hass.io) and Home Assistant Container the final location should be /config/custom_components/mail_and_packages
    • On Home Assistant Supervised, Home Assistant Core, and Hassbian the final location should be /home/homeassistant/.homeassistant/custom_components/mail_and_packages
  3. Restart your instance.

Configuration

Go to the Configuration, Templates, and Automations section

About

Home Assistant integration providing day of package counts and USPS informed delivery images.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%