Skip to content

Latest commit

 

History

History
289 lines (226 loc) · 12.7 KB

README.md

File metadata and controls

289 lines (226 loc) · 12.7 KB
Raw

PayPal donate button

Plex Email

Introduction

This script aggregates all new TV and movie releases for the past x days and writes to your web directory and sends out an email.

Supported Environments

  • Windows - Tested
  • Linux - Tested
  • FreeBSD/FreeNAS - Tested
  • Mac - Tested
  • QNAP - User Tested

Supported Email Protocols

  • SMTP

Prerequisites

  1. Python 2.7 - Windows: 32 bit - https://www.python.org/ftp/python/2.7.9/python-2.7.9.msi
  2. Windows - 32 bit DLL for SQLite version 3.8.8.3 - http://www.sqlite.org/2015/sqlite-dll-win32-x86-3080803.zip (Put this into the DLLs folder of the Python installation)
  3. Requests module for Python. pip install requests or download it here and put it in the LIb folder of your Python installation: https://pypi.python.org/packages/source/r/requests/requests-2.5.3.tar.gz#md5=23bf4fcc89ea8d353eb5353bb4a475b1
  4. If web reports are wanted, a web server (i.e. Wamp, Apache, etc.)

Installation (Windows)

  1. Clone this repo or download the zip
  2. Copy the contents of scripts to where you want the script to run from
  3. Copy the contents of web to your web folder
  4. Update the config.conf file inside the scripts folder
  5. Schedule a weekly task to execute plexEmail.vbs from the scripts folder (make sure to set the start in folder as the folder where the vbs script resides)

Installation (Linux)

  1. Install python 2.7.9
  2. Copy the contents of scripts to where you want the script to run from
  3. Copy the contents of web to your web folder
  4. Update the config.conf file inside the scripts folder
  5. Schedule a weekly cron job to execute the plexEmail.py script

Installation (CentOS)

https://forums.plex.tv/index.php/topic/151619-plexemail-in-development/page-7#entry879778

Installation (FreeNAS)

Thanks to adrianwi:

https://forums.freenas.org/index.php?threads/guide-for-installing-plexemail.40748/#post-257799

Installation (QNAP)

Thanks to nickiman:

https://forum.qnap.com/viewtopic.php?f=177&t=125414

Usage

Normal Usage

python plexEmail.py

Alternate Usage

Pass in an alternate config file. For example, the default config file sends out a daily email (using Cloudinary), while an alternate config file is set up for a weekly web page.

python plexEmail.py -c C:\files\plexEmailWeekly.conf

Run in test mode (send email only to sender address)

python plexEmail.py -t

Pass a special one-time notice to users

python plexEmail.py -n "This is a special notice to all users"

Output the current script version

python plexEmail.py --version

Config File

The config file is in the scripts folder. Before first run of the script, please update this file with your information.

Field Explanations:

Folder Paths
  • plex_data_folder - Location where the Plex Media Server folder is located - i.e. E:\Library\Plex\
  • web_folder - Location of web/www/public_html folder is located - i.e. C:\wamp\www\
General
Logging
  • logging_debug_level - Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
  • logging_file_location - Leave blank to use default location - logs folder where the script file resides
  • logging_retain_previous_logs - True to append to the log file or False to overwrite the log file on every run of the script.
Plex API Authentication - This is only used for shared user emails currently
  • plex_username - Plex account username of the server
  • plex_password - Plex account password of the server
Web
  • web_enabled - Enable the creation of the web page
  • web_only_save_images - Will not create the index.html, but will still save images to the image folder.
  • web_domain - Domain name of the web page
  • web_path - Path on the domain to the web page
  • web_delete_previous_images - True to delete all .jpg images in the web image folder prior to copying over current images
  • web_skip_if_no_additions - True to skip creating a web page if there are no new additions
Image Upload - If this option is enabled, image hosting will be used for web and email

Cloudinary - Sign up for a free account at: http://cloudinary.com/

  • upload_use_cloudinary - Use Cloudinary image hosting
  • upload_cloudinary_cloud_name - Cloudinary cloud name
  • upload_cloudinary_api_key - Cloudinary api key
  • upload_cloudinary_api_secret - Cloudinary api secret
  • upload_cloudinary_use_https - True to use https and False to use http for both uploading url and image locations in the email/web page
Email
  • email_enabled - Enable the creation and sending of an email
  • email_individually - True to send out emails individually to each address in the email_to setting
  • email_use_bcc - True to send emails on using bcc instead of to (email_to settings will send to them using bcc)
  • email_to - Array of email addresses to send the email
  • email_to_send_to_shared_users - True to get list of shared user emails (plex_username and plex_password must be valid for this to be used)
  • email_unsubscribe - List of emails to exclude (emails in email_to will override emails in this)
  • email_from - Email address to send the email from
  • email_from_name - Friendly name of sender
  • email_smtp_address - SMTP address of the email service
  • email_smtp_port - SMTP port of the email service
  • email_use_ssl - Use SSL - Note that the port must be an SSL port for this to work i.e. 465
  • email_username - SMTP authentication username
  • email_password - SMTP authentication password
  • email_use_web_images - Use images from the web server instead of attaching them directly to the email
  • email_skip_if_no_additions - True to skip sending emails if there are no new additions
Filtering
  • filter_include_plex_web_link - True to add hyperlinks to the images and titles to go to Plex Web for the specific title
  • filter_show_movies - True to show recently added movies
  • filter_movies_include - List of movies to include (Anything that does not match perfectly will not be included)
  • filter_movies_excluse - List of movies to exclude (Only titles that match perfectly will be excluded)
  • filter_show_shows - True to show recently added TV shows
  • filter_shows_include - List of shows to include (Anything that does not match perfectly will not be included)
  • filter_shows_excluse - List of shows to exclude (Only titles that match perfectly will be excluded)
  • filter_show_seasons - True to show recently added TV seasons
  • filter_seasons_include - List of seasons to include (Anything that does not match perfectly will not be included)
  • filter_seasons_excluse - List of seasons to exclude (Only titles that match perfectly will be excluded)
  • filter_show_episodes - True to show recently added TV episodes
  • filter_episodes_include - List of episodes to include (Anything that does not match perfectly will not be included)
  • filter_episodes_excluse - List of episodes to exclude (Only titles that match perfectly will be excluded)
  • filter_show_artists - True to show recently added TV artists
  • filter_artists_include - List of artists to include (Anything that does not match perfectly will not be included)
  • filter_artists_excluse - List of artists to exclude (Only titles that match perfectly will be excluded)
  • filter_show_albums - True to show recently added albums
  • filter_albums_include - List of albums to include (Anything that does not match perfectly will not be included)
  • filter_albums_excluse - List of albums to exclude (Only titles that match perfectly will be excluded)
  • filter_show_email_images - True to show images in the email
  • filter_episode_thumbnail_type - Type of image to show for new TV Episodes - "episode", "season" or "show" (Defaults to episode)
  • filter_libraries - A list of library names to filter out - ['Home Videos', 'Private']
  • filter_sections_movies - Movie specific filters
  • filter_sections_TV - TV specific filters
  • filter_sections_Music - Music specific filters
    • Possible fields: tagline, summary, content_rating, duration, year, rating, studio, tags_genre, tags_director, tags_star
    • order - The order this field should appear for each title
    • show - Whether or not this field should be shown for each title
    • preText - The text that should be added before this field for each title
    • postText - The text that should be added after this field for each title
    • include - A list of values that are each title must match at least one to be shown
    • exclude - A list of values that if the title matches any of, will not be shown
    • format - Date format to be applied (Only use this for air_date)
Messages
  • msg_notice - Used for special notices to the users. This can also be done through the command line using the -n flag.
  • msg_email_teaser - Teaser text on the email
  • msg_web_title - Title of the webpage
  • msg_email_subject Subject of email
  • msg_header1 - First header text
  • msg_header2 - Second header text
  • msg_header3 - Third header text. Only used in the email
  • msg_top_link - Header link text to go to top of the page
  • msg_movies_link - Header link text to go to new movies
  • msg_shows_link - Header link text to go to new shows
  • msg_seasons_link - Header link text to go to new seasons
  • msg_episodes_link - Header link text to go to new episodes
  • msg_artists_link - Header link text to go to new artists
  • msg_albums_link - Header link text to go to new albums
  • msg_new_movies_header - Section header text for new movies
  • msg_new_shows_header - Section header text for new shows
  • msg_new_seasons_header - Section header text for new seasons
  • msg_new_episodes_header - Section header text for new episodes
  • msg_new_artists_header - Section header text for new artists
  • msg_new_albums_header - Section header text for new albums
  • msg_footer - Footer text at the bottom of the page
  • msg_no_new_content - Message to be displayed if no new content has been added
Sorting

  • movie_sort_1 - Highest priority sort

  • movie_sort_1_reverse - Reverse the default sort

  • movie_sort_2 - Second priority sort

  • movie_sort_2_reverse - Reverse the default sort

  • movie_sort_3 - Third Priority sort

  • movie_sort_3_reverse - Reverse the default sort

  • show_sort_1 - Highest priority sort

  • show_sort_1_reverse - Reverse the default sort

  • show_sort_2 - Second priority sort

  • show_sort_2_reverse - Reverse the default sort

  • show_sort_3 - Third Priority sort

  • show_sort_3_reverse - Reverse the default sort

  • season_sort_1 - Highest priority sort

  • season_sort_1_reverse - Reverse the default sort

  • season_sort_2 - Second priority sort

  • season_sort_2_reverse - Reverse the default sort

  • season_sort_3 - Third Priority sort

  • season_sort_3_reverse - Reverse the default sort

  • artist_sort_1 - Highest priority sort

  • artist_sort_1_reverse - Reverse the default sort

  • artist_sort_2 - Second priority sort

  • artist_sort_2_reverse - Reverse the default sort

  • artist_sort_3 - Third Priority sort

  • artist_sort_3_reverse - Reverse the default sort

  • album_sort_1 - Highest priority sort

  • album_sort_1_reverse - Reverse the default sort

  • album_sort_2 - Second priority sort

  • album_sort_2_reverse - Reverse the default sort

  • album_sort_3 - Third Priority sort

  • album_sort_3_reverse - Reverse the default sort

  • episode_sort_1 - Highest priority sort

  • episode_sort_1_reverse - Reverse the default sort

  • episode_sort_2 - Second priority sort

  • episode_sort_2_reverse - Reverse the default sort

  • episode_sort_3 - Third Priority sort

  • episode_sort_3_reverse - Reverse the default sort

Screenshots

Email

Top: alt tag

Movies: alt tag

TV Shows: alt tag

TV Seasons: alt tag

TV Episodes: alt tag

Web

Top: alt tag

Movies: alt tag

TV Shows: alt tag

TV Seasons: alt tag

TV Episodes: alt tag