stefano/NotiMail
1
0
Fork 0
mirror of https://github.com/draga79/NotiMail.git synced 2024-09-19 19:14:19 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed README.md

Browse source
This commit is contained in:
Stefano Marinelli 2023-10-22 21:28:25 +02:00
parent 9f23eb8c92
commit d10ab7a20e
1 changed files with 21 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -134,28 +134,31 @@ bash
With that, you should have NotiMail up and running on your system! Enjoy a more efficient email notification experience. With that, you should have NotiMail up and running on your system! Enjoy a more efficient email notification experience.
### Changelog: ## Changelog
- **Version 0.11 Alpha - not yet released:** ### Version 0.11 Alpha (Not Yet Released)
New Features: #### New Features:
- **Configurable Paths:** Introduced the ability to configure the location of the log file and the SQLite database from the configuration file. - Configurable Paths: You can now customize the location of the log file and the SQLite database from the configuration file.
- **Flexible Configuration:** Added support to specify a custom configuration file when running the script. - Flexible Configuration: Added support for specifying a custom configuration file when running the script.
Changes: #### Changes:
- **Codebase:** - **Codebase:**
- Introduced `argparse` to enable command-line arguments. Users can now specify the path to a configuration file using `-c` or `--config` option. - Introduced `argparse` to enable command-line arguments. You can now specify the path to a configuration file using the `-c` or `--config` option.
- Moved the config reading to the top of the script to make it globally accessible. - Moved the configuration reading to the top of the script to make it globally accessible.
- Updated the logging setup to fetch the log file location from the config file (`LogFileLocation`). If not set, it defaults to `notimail.log`. - Updated the logging setup to use the log file location from the config file (`LogFileLocation`). If not set, it defaults to `notimail.log`.
- Modified the `DatabaseHandler` class to fetch the database location from the config file (`DataBaseLocation`). If not set, it defaults to `processed_emails.db`. - Modified the `DatabaseHandler` class to use the database location from the config file (`DataBaseLocation`). If not set, it defaults to `processed_emails.db`.
- **Configuration (`config.ini`):** - **Configuration (`config.ini`):**
- Introduced a new `[GENERAL]` section. Users can specify `LogFileLocation` and `DataBaseLocation` within this section to set the desired paths for the log file and database, respectively. - Introduced a new `[GENERAL]` section. You can specify `LogFileLocation` and `DataBaseLocation` within this section to set the desired paths for the log file and database, respectively.
- **Version 0.10:** ### Version 0.10
- Authentication Tokens for NTFY Notifications: Enhanced the NTFYNotificationProvider to support optional authentication tokens. If a token is provided in the config.ini file for a specific NTFY URL, the notification request will include an "Authorization" header for authentication.
- Authentication Tokens for NTFY Notifications: Enhanced the NTFYNotificationProvider to support optional authentication tokens. If a token is provided in the `config.ini` file for a specific NTFY URL, the notification request will include an "Authorization" header for authentication.
### Version 0.9
- **Version 0.9:**
- Introduced support for monitoring multiple email accounts. Configure multiple accounts in the `config.ini` using the format `[EMAIL:account1]`, `[EMAIL:account2]`, and so on. - Introduced support for monitoring multiple email accounts. Configure multiple accounts in the `config.ini` using the format `[EMAIL:account1]`, `[EMAIL:account2]`, and so on.
- Maintained compatibility with the old single `[EMAIL]` configuration for a smooth upgrade path. - Maintained compatibility with the old single `[EMAIL]` configuration for a smooth upgrade path.