{"id":14036852,"url":"https://github.com/aneisch/informed-delivery-home-assistant","last_synced_at":"2025-06-21T01:35:12.894Z","repository":{"id":79012241,"uuid":"240179690","full_name":"aneisch/informed-delivery-home-assistant","owner":"aneisch","description":"Retrieves USPS mail and package info from informed delivery emails via IMAP. Publishes mail and package count to MQTT and creates mail image gif.","archived":false,"fork":false,"pushed_at":"2020-02-15T19:50:46.000Z","size":54,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-06-15T03:45:22.360Z","etag":null,"topics":["docker","docker-compose","homeassistant","mqtt","usps"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aneisch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-02-13T04:51:01.000Z","updated_at":"2024-07-10T18:51:36.000Z","dependencies_parsed_at":"2023-03-08T19:15:17.962Z","dependency_job_id":null,"html_url":"https://github.com/aneisch/informed-delivery-home-assistant","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/aneisch/informed-delivery-home-assistant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneisch%2Finformed-delivery-home-assistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneisch%2Finformed-delivery-home-assistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneisch%2Finformed-delivery-home-assistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneisch%2Finformed-delivery-home-assistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aneisch","download_url":"https://codeload.github.com/aneisch/informed-delivery-home-assistant/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneisch%2Finformed-delivery-home-assistant/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261046872,"owners_count":23102342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","homeassistant","mqtt","usps"],"created_at":"2024-08-12T03:02:16.597Z","updated_at":"2025-06-21T01:35:07.865Z","avatar_url":"https://github.com/aneisch.png","language":"Python","funding_links":["https://www.buymeacoffee.com/aneisch"],"categories":["Python"],"sub_categories":[],"readme":"# Informed Delivery Home Assistant\n\u003ca href=\"https://www.buymeacoffee.com/aneisch\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-black.png\" width=\"150px\" height=\"35px\" alt=\"Buy Me A Coffee\" style=\"height: 35px !important;width: 150px !important;\" \u003e\u003c/a\u003e\u003cbr\u003e\n\nRetrieves USPS mail and package info from informed delivery emails via IMAP. Publishes mail and package count to MQTT and creates scanned mail gif. This container image was created based on content from the top link, check it out for additional Home Assistant sensor integration info. Credit to [@skalavala](https://github.com/skalavala) and [arychj](https://github.com/arychj) for the code and writeup!\n* https://www.awesome-automations.com/blog/usps/ \n* https://community.home-assistant.io/t/a-working-usps-component-solved-for-now/41012/14\n\nhttps://hub.docker.com/r/aneisch/informed-delivery-home-assistant\n\n## Usage\n\n### Example docker-compose:\n\n```yaml\nversion: '3.2'\nservices:\n    informed_delivery:\n        container_name: informed_delivery\n        image: aneisch/informed-delivery-home-assistant\n        volumes:\n          - '/etc/localtime:/etc/localtime:ro'\n          # volume for mails image output\n          - '/tmp/:/output/'\n        environment:\n          - EMAIL_USERNAME=your_email@your_provider.com\n          - EMAIL_PASSWORD=your_password\n          - MQTT_USPS_MAIL_TOPIC=/sensor/usps/mails\n          - MQTT_USPS_PACKAGE_TOPIC=/sensor/usps/packages\n          - SLEEP_TIME_IN_SECONDS=600\n```\n\n### Example `docker run`:\n```bash\ndocker run -d -v '/tmp/:/output/' -v '/etc/localtime:/etc/localtime:ro' \\\n--name informed_delivery -e EMAIL_USERNAME=your_email@your_provider.com \\\n-e EMAIL_PASSWORD=your_password -e SLEEP_TIME_IN_SECONDS=600 \\\naneisch/informed-delivery-home-assistant\n```\n\n### Environmental Variables\nYou only need to specify the environmental variables in `docker run` or your docker-compose file that you want/need to override:\n\nvariable | default | description\n-- | -- | --\n`MQTT_SERVER` | 10.0.1.22 | MQTT server address\n`MQTT_SERVER_PORT` | 1883 | MQTT server port\n`MQTT_USERNAME` | mosquitto | MQTT username (can be ignored if unneeded)\n`MQTT_PASSWORD` | password | MQTT password (can be ignored if unneeded)\n`MQTT_USPS_MAIL_TOPIC` | /usps/mails | Topic where mail count is published\n`MQTT_USPS_PACKAGE_TOPIC` | /usps/packages | Topic where package count is published\n`EMAIL_HOST` | imap.gmail.com | Email provider url (see table below)\n`EMAIL_PORT` | 993 | Email IMAP port\n`EMAIL_USERNAME` | xxx.xxx@outlook.com | Email login\n`EMAIL_PASSWORD` | xxx | Email password\n`EMAIL_FOLDER` | informed_delivery | Folder where Informed Delivery mail will be found (you can filter to a specific folder)\n`GIF_FILE_NAME` | todays_mails.gif | Mail image gif output name\n`GIF_MAKER_OPTIONS` | '/usr/bin/convert -delay 300 -loop 0' | Gif creation options\n`SLEEP_TIME_IN_SECONDS` | 300 | Sleep time between checks\n\nEmail Provider | Host Address | Port\n-- | -- | --\nGMail | imap.gmail.com | 993\nYahoo | imap.mail.yahoo.com | 993\nOutlook | imap-mail.outlook.com | 993\n\n### Notes: \n* If using Gmail, you will need to [allow less secure apps](https://hotter.io/docs/email-accounts/secure-app-gmail/) to login. I suggest making a separate Google account for this. You will also need to enable IMAP from your Gmail inbox.\n* If MQTT doesn't require login you can leave MQTT_USERNAME and MQTT_PASSWORD as is. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faneisch%2Finformed-delivery-home-assistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faneisch%2Finformed-delivery-home-assistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faneisch%2Finformed-delivery-home-assistant/lists"}