Skip to content

Configuration and Email Settings

Jump to bottom
moralmunky edited this page Dec 18, 2020 · 37 revisions

Installation

HACS (Recommended)

  1. Have HACS installed, this will allow you to easily update
  2. Click Integrations then click the + in the lower right corner and type in Mail and Packages
  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.

Note

If the integration does not show up, refresh the Integrations page.

Checking multiple email boxes

In order to check multiple email boxes just add the integration again with the credentials for the additional mail provider you are using. This will create another set of sensors for you that will update based on those emails.

Re-configuration

If you for some reason need to modify your settings instead of removing the integration and re-adding. Go into Configuration -> Integration select the Options button on Mail And Packages to re-configure the settings.

Configuration

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 nortifications
Image Path This is the absolute path to the folder where Mail and Packages integration will save the compiled USPS informed delivery gif.
--- On Home Assistant (formerly Hass.io) and Home Assistant Container the final location should be /config/custom_components/mail_and_packages if using the local_file camera platform to display the image
--- On Home Assistant Supervised, Home Assistant Core, and Hassbian the final location should be /home/homeassistant/.homeassistant/custom_components/mail_and_packages if using the local_file camera platform to display the image
--- On Home Assistant (formerly Hass.io) and Home Assistant Container the final location should be /config/www if using the Mail And Packages Custom Card
--- On Home Assistant Supervised, Home Assistant Core, and Hassbian the final location should be /home/homeassistant/.homeassistant/www if using the Mail And Packages Custom Card
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
*Privacy / Security Note

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.

Supported Shippers and Requirements:

Shipper Notification Settings
USPS Informed Delivery: account and all nortifications turned on for email with the email address you will have the component check. USPS Informed Delivery notification settings.
FedEx Delivery Manager: account and all nortifications turned on for email with the email address you will have the component check. FedEx notification settings.
UPS MyChoice: account and all nortifications turned on for email with the email address you will have the component check. FedEx notification settings.

GMail

Please note if you are using GMail for this you will need to setup an App Password in order for this to work. Please refer to this link for details on how to setup an App Password

Yahoo Mail

Nothing special is required to setup a Yahoo Mail account in this component, just enter your username (your Yahoo Email address) and password as normal. If you have 2FA enabled you will need to generate an app password as outlined on the Yahoo help pages.

References:

Server Settings

App Passwords

Hotmail/Outlook/Live

Nothing special is required to setup a Yahoo Mail account in this component, just enter your username (your Outlook/Hotmail/Live Email address) and password as normal.

Reference: Here

Clone this wiki locally