Server-side email notification manager using several push providers for real-time alerts. Conserve mobile battery without compromising on immediacy.
Go to file
2024-07-02 15:03:28 +02:00
man We reached 1.0 2024-07-02 14:49:33 +02:00
CHANGELOG.md We reached 1.0 2024-07-02 14:49:33 +02:00
config.ini.sample We reached 1.0 2024-07-02 14:49:33 +02:00
LICENSE Initial upload 2023-10-11 15:02:55 +02:00
NotiMail.py Update NotiMail.py - updated copyright year 2024-07-02 15:03:28 +02:00
README.md We reached 1.0 2024-07-02 14:49:33 +02:00

NotiMail 📧

Version 1.0 is here, read the changelog for more information!

Stay connected without the constant drain on your battery. Introducing NotiMail - the future of server-side email notifications supporting multiple push providers and multiple email accounts!

Mobile devices often use IMAP IDLE, maintaining a persistent connection to ensure real-time email notifications. Such continuous connections rapidly consume battery power. The modern era demanded a smarter, more energy-efficient solution. Meet NotiMail.

Features 🌟

  • Monitors Multiple Emails on the Server: From version 0.9 onwards, NotiMail can monitor multiple email accounts. Ensure you never miss an email regardless of which account it's sent to.

  • Monitors Multiple Folders per Account: With version 0.12, you can configure NotiMail to monitor multiple folders for each email account. Whether it's your 'inbox', 'junk', or any other folder, stay informed with NotiMail.

  • Processes and Notifies: Once a new email is detected, NotiMail swiftly processes its details.

  • Leverages Multiple Push Providers for Alerts: Rather than having your device always on alert, NotiMail sends notifications via multiple push providers, ensuring you're promptly informed.

  • Expanded Notification Capabilities: Version 0.13 introduced support for Apprise, allowing for an extensive array of notification services through a single interface.

  • Log Rotation: Version 1.0 introduces log rotation, which can be configured based on size or time, ensuring efficient log management.

  • Thread-Safe Email Processing: Improved thread safety in email processing, ensuring that multiple email accounts can be processed simultaneously without conflicts.

  • Enhanced Configuration Validation: Added configuration validation to ensure all required settings are present before running the script.

  • Database Integration: NotiMail uses an SQLite3 database to store and manage processed email UIDs, preventing repeated processing.

  • Built for Resilience: With connectivity hiccups in mind, NotiMail ensures you're always the first to know.

  • Multiple and Different Push Providers Supported: You can use one or more of the supported push providers - all support authentication, which now includes NTFY, Gotify, Pushover, and a wide range through Apprise.

Benefits 🚀

  • Extended Battery Life: Experience a noticeable improvement in your device's battery lifespan.

  • Swift Notifications: Using one of the supported push providers, NotiMail provides real-time notifications without delay.

  • Reduced Data Consumption: With notifications being the primary data exchange, you can save on unnecessary data usage.

  • Always in the Loop: Whether it's a new email or a server glitch, NotiMail and push notifications guarantee you're always informed.

Implementation Details 🔧

  • Efficient Operation: Crafted for server-side operations, NotiMail guarantees a smooth, lightweight experience.

  • Customizable Settings: Through an intuitive config.ini, customize NotiMail to fit your needs. With the new 0.9 version, configure multiple email accounts for monitoring.

  • Dependable Error Handling: With robust mechanisms, NotiMail ensures you're notified of any hitches or anomalies.

  • Safety First: Employing secure IMAP SSL encryption, your email data is always safe.


Contributions, feedback, and stars are always welcome.

NotiMail Installation Walkthrough


Prerequisites:

Ensure you have Python installed on your machine. NotiMail is written in Python, and you'd need it to run the script. If you haven't already installed Python, download it from the official website or your OS package manager.


Step-by-Step Installation:

1. Clone or Download NotiMail:

If you've hosted NotiMail on a platform like GitHub, provide the link and the command. For this example, I'll use a placeholder link:

git clone https://github.com/draga79/NotiMail.git

If you're not using version control, ensure users have a link to download the .zip or .tar.gz of the project and then extract it.

2. Navigate to the NotiMail Directory:

cd NotiMail

3. Set Up a Virtual Environment (Optional but Recommended):

A virtual environment ensures that the dependencies for the project don't interfere with your other Python projects or system libraries.

python -m venv notimail-env

Activate the virtual environment:

  • On macOS and Linux:

    source notimail-env/bin/activate

  • On Windows:

    .\notimail-env\Scripts\activate

4. Install the Required Libraries:

Install the necessary Python libraries using pip, for example:

pip install requests configparser sqlite3 datetime signal logging argparse threading apprise

5. Configure NotiMail:

Open the config.ini file in a text editor. From version 0.9, you can configure multiple email accounts for monitoring by adding sections like [EMAIL:account1], [EMAIL:account2], etc. If you're upgrading from an earlier version, your old single [EMAIL] configuration is still supported. Also, update the configuration for one (or more) of the supported push providers.

6. Run NotiMail:

python NotiMail.py


Troubleshooting:

  1. Python Not Found: Ensure Python is installed and added to your system's PATH.

  2. Dependencies Missing: If the script raises an error about missing modules, ensure you've activated your virtual environment and installed all necessary libraries.


With that, you should have NotiMail up and running on your system! Enjoy a more efficient email notification experience.

Changelog

Moved to CHANGELOG.md