Skip to content
A component that give you to info about incoming letters and packages from USPS.
Python
Branch: master
Clone or download
Latest commit e103e8f Jan 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Typo correction Jan 24, 2019
custom_components Camera URL fix & "no mail" display adjustment (#8) Nov 24, 2018
LICENSE Init Aug 15, 2018
README.md Fix Typo (#12) Jan 28, 2019

README.md

USPS Mail

A component that give you to info about incoming letters and packages from USPS.
This component is based of the work of skalavala


⚠️ Before you start using this make sure that you read this article on skalavala's blog.
Read down to Prerequisites, from that part this component takes care of the rest.


Installation

Step 1

Install this component by copying /custom_components/usps_mail.py from this repo to <config directory>/custom_components/usps_mail.py on your Home Assistant instanse.

You do not need to get the /custom_components/camera/usps_mail.py file, the component will download this for you if it's needed.

Step 2

Add this to your configuration.yaml

usps_mail:
  provider: gmail
  email: 'username@gamil.com'
  password: 'fjkhg347847idsbj'

Optional config options

key default required description
provider yes Your mail provider, can be gmail, outlook, yahoo
email yes Your email address
password yes Your mail password, if you have 2FA enabled you need to create a App password for this.
inbox_folder Inbox no The folder in your inbox where these mails are
port 993 no The IMAP port that the provider is using.
camera False no Set to True if you want to use a camera platofrm to show your incomming mail.
default_image None no Relativ path to custom "NO MAIL" image from the config dir, example /www/no_mail.png

Updates

This component are subject to change.
To make sure you get notified about upcoming releases you should also get the custom_updater component.


Activate Debug logging

Put this in your configuration.yaml

logger:
  default: warn
  logs:
    custom_components.usps_mail: debug

Due to how custom_components are loaded, it is normal to see a ModuleNotFoundError error on first boot after adding this, to resolve it, restart Home-Assistant.

You can’t perform that action at this time.