{% if prerelease %}
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 %}
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. It provides a count of in transit and delivered packages that are scheduled to be delivered the current day. 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.
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
| Sensors | Shipper | Subject | Body Text | |
|---|---|---|---|---|
| sensor.mail_usps_mail, mail_today.gif | USPS | [email protected] | Informed Delivery Daily Digest | none |
| sensor.mail_usps_delivering | USPS | [email protected] | Expected Delivery on | out for delivery |
| sensor.mail_usps_delivered | USPS | [email protected] | Item Delivered | none |
| sensor.mail_ups_delivering | UPS | [email protected] | UPS Update: Package Scheduled for Delivery Today | none |
| sensor.mail_ups_delivering | UPS | [email protected] | UPS Update: Follow Your Delivery on a Live Map | none |
| sensor.mail_ups_delivered | UPS | [email protected] | Your UPS Package was delivered | none |
| sensor.mail_fedex_delivering | FEDEX | [email protected] | Delivery scheduled for today | none |
| sensor.mail_fedex_delivering | FEDEX | [email protected] | Your package is scheduled for delivery today | none |
| sensor.mail_fedex_delivered | FEDEX | [email protected] | Your package has been delivered | none |
| sensor.mail_amazon_packages | Amazon | [email protected] | none | regex order numbers |
| sensor.mail_amazon_packages | Amazon | [email protected] | none | regex order numbers |
Once you have finished installing through HACS or manually go into Configuration -> Integration select the +and add the Mail And Packages integration. You first be prompted to input your mail server settings and then additonal settings.
| Setting | Description |
|---|---|
| Mail Folder | The folder in your email account that the notification messages are stored. The default is Inbox. |
| Scanning Interval (minutes) | The amount of time that will pass between checking for new email notifications |
| Image Path* | This is the absolute path to the folder where Mail and Packages integration will save the compiled USPS informed delivery gif. |
| Image Duration (seconds) | The amount of time each USPS Informed Delivery image is shown in the generated rotating GIF. |
| Random Image Filename* | Change the file name of the generated gif from mail_today.gif to a random string for increased secuirty in situations where it is required to store the image in the www directory |
Please note that files stored in the www Home Assistant folder is publicly accessible unless you have taken security measures outside of Home Assistant to secure it. You can place the images in an images directory inside Home Assistants root folder and still send notifications via most notification integrations.
| Shipper | Notification Settings |
|---|---|
| USPS Informed Delivery: account and all notifications turned on for email with the email address you will have the component check. |  |
| FedEx Delivery Manager: account and all notifications turned on for email with the email address you will have the component check. |  |
| UPS MyChoice: account and all notifications turned on for email with the email address you will have the component check. |  |