{% if prerelease %}

This is a pre-release version

It may contain bugs or break functionality in addition to adding new features and fixes. Please review open issues and submit new issues to the GitHub issue tracker.

{% endif %}

About Mail and Packages integration

The Mail and Packages integration creates sensors for supported shippers to show a snapshot of mail and packages that are scheduled to be delivered the current day. For the packages that are scheduled for delivery the current day a count of in transit and delivered packages will be provided. It also generates the number of USPS mail pieces and provides a rotating GIF of the USPS provided images of the mail, if available, for the current day.

Credits:

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

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 supported shippers and counts the subject lines that match known language from the supported shippers about their transit status. For USPS Informed delivery emails, it also downloads the mail images to combine them into a rotating GIF. See the WIKI information on how this works.

The email can not be deleted until the next day. You can have your email filtered into a folder and have the integration watch that folder.

The image will revert back to the no mail graphic after the first email check after midnight, local time.

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

*Privacy / Security Note

Please note that files stored in the www Home Assistant folder are publicly accessible unless you have taken security measures outside of Home Assistant to secure it. For increased security and simplicity the USPS Informed Delivery image name is random by default and no longer has the option to turn it on/off. Two new sensors have been created that provide the local file path or a web accessible url for use in displaying or sending in various Home Assistant notification methods.

sensor.mail_image_system_path
sensor.mail_image_url - Requires that either External_URL or Internal_URL is defined in the general configuration options in Home Assistant.