Configuration documentation refinements

Author: simonrob

emailproxy.config

@@ -3,8 +3,8 @@ documentation = This is a sample Email OAuth 2.0 Proxy configuration file. Confi
 	[Server setup] and [Account setup] sections below. You may delete any servers or accounts that you do not intend to
 	use. Documentation is provided inline, with example setups for Gmail and Office 365 (though you will need to enter
 	your own desktop app API client credentials in the accounts section). Use the `Reload configuration file` menu
-	option (or restart the proxy) to apply any changes.
-warning = Do not commit changes to this file into a public repository (e.g., GitHub etc). While the proxy encrypts the
+	option or send a SIGHUP signal (or restart the proxy) to apply any changes.
+warning = Do not commit changes to this file into a public repository (e.g., GitHub, etc). While the proxy encrypts the
 	OAuth 2.0 tokens it obtains and saves on your behalf, it cannot protect these against offline brute-force attacks.
 
 
@@ -77,21 +77,22 @@ documentation = Accounts are specified using your email address as the section h
 	reused from an existing source (such as another email client that supports OAuth 2.0), or you can register and use
 	your own desktop app API client credentials. See https://developers.google.com/identity/protocols/oauth2/native-app
 	and the Microsoft link below for details. Multiple accounts on the same server can use the same values for the
-	`client_id` and `client_secret` properties; just duplicate these in each account's entry below. Note that there are
-	also example account configurations for AOL and Yahoo Mail below, but these services are not currently accepting new
-	OAuth 2.0 client registrations with the mail access scope, so reusing existing credentials is the only option here.
+	`client_id` and `client_secret` properties; just duplicate these in each account's entry below, or see the advanced
+	`allow_catch_all_accounts` option. Note that while there are example account configurations for AOL and Yahoo Mail
+	below, these services are not currently accepting new OAuth 2.0 client registrations with the mail access scope, so
+	reusing existing credentials is the only option here.
 
 	Once the proxy is correctly configured, after the first successful use of an account its access token details will
 	be cached for future use, encrypted with the IMAP/POP/SMTP password you used in your email client. By default this
 	configuration file is reused for caching (so it must be writable), but you can specify a different location or
-	method using the proxy's `--cache-store` parameter. You do not need to add or edit cached values manually (i.e.,
+	method using the proxy's `--cache-store` parameter. You should not add or edit cached values manually (i.e.,
 	`token_salt`, `access_token`, `access_token_expiry`, `refresh_token` and `last_activity`); the proxy handles this.
 
 	The password used in your email client is not used for authentication with the actual email server (this is done via
 	OAuth 2.0 in a web browser), so it can be different to your real account password, which is helpful for debugging.
 	Please note, though, that all clients that use a particular account via the proxy should use the same IMAP/POP/SMTP
 	password to avoid repeated re-authentication requests (which is the proxy's default behaviour when credential
-	decryption fails). See the proxy's README.md file for more information and further configuration options.
+	decryption fails). See the proxy's README.md file for more information and the end of this file for further options.
 
 	Office 365 customisation:
 	- Unlike other providers, Office 365 requires an OAuth 2.0 scope that explicitly specifies `offline_access` (shown
@@ -175,7 +176,8 @@ redirect_uri = http://localhost
 client_id = *** your client id here ***
 client_secret = *** your client secret here ***
 
-[[email protected]]
+[[email protected]]
+documentation = *** note: this is an advanced O365 account example; in most cases you want the version above instead ***
 token_url = https://login.microsoftonline.com/*** your tenant id here ***/oauth2/v2.0/token
 oauth2_scope = https://outlook.office365.com/.default
 oauth2_flow = client_credentials

emailproxy.py

@@ -4,9 +4,9 @@
 2.0 authentication. Designed for apps/clients that don't support OAuth 2.0 but need to connect to modern servers."""
 
 __author__ = 'Simon Robinson'
-__copyright__ = 'Copyright (c) 2022 Simon Robinson'
+__copyright__ = 'Copyright (c) 2023 Simon Robinson'
 __license__ = 'Apache 2.0'
-__version__ = '2023-04-04'  # ISO 8601 (YYYY-MM-DD)
+__version__ = '2023-05-18'  # ISO 8601 (YYYY-MM-DD)
 
 import abc
 import argparse