Avoid double version issue in requirements; update readme

Also streamline `get_title` and reorder notification handling now that pystray (0.19.4+) has notifications on macOS

Author: simonrob

README.md

@@ -7,7 +7,7 @@ Email services that support IMAP and/or SMTP access are increasingly requiring t
 
 ### Example use-cases
 - You need to use an Office 365 email account, but don't get on with Outlook. The email client you like doesn't support OAuth 2.0.
-- You currently use Gmail via IMAP/SMTP with your raw account credentials (i.e., your real password). You've received a notification that Google is disabling this access at the end of May 2022, but you don't want to use an [App Password](https://support.google.com/accounts/answer/185833) (or cannot enable this option).
+- You used to use Gmail via IMAP/SMTP with your raw account credentials (i.e., your real password), but cannot do this now that Google has disabled this method, and don't want to use an [App Password](https://support.google.com/accounts/answer/185833) (or cannot enable this option).
 - You have an account already set up in an email client, and you need to switch it to OAuth 2.0 authentication. You can edit the server details, but the client forces you to delete and re-add the account to enable OAuth 2.0, and you don't want to do this.
 - You have made your own script or application that sends or receives email, but it doesn't support OAuth 2.0, and you don't want to have to modify it to implement this.
 - You run a server with multiple services that use IMAP/SMTP, and you don't want to have to set up OAuth 2.0 independently for each one.
@@ -32,9 +32,9 @@ After your accounts are fully set-up and authorised, no further proxy interactio
 ### OAuth 2.0 client credentials
 As part of the proxy setup process you need to provide an OAuth 2.0 `client_id` and `client_secret` to allow it to authenticate with email servers on your behalf.
 
-If you have an existing client ID and secret for a desktop app, you can use these directly in the proxy. You can also reuse the client ID and secret from any email client that supports IMAP/SMTP OAuth 2.0 authentication with the email server you would like to connect to.
+If you have an existing client ID and secret for a desktop app, you can use these directly in the proxy. If this is not possible, you can also reuse the client ID and secret from any email client that supports IMAP/SMTP OAuth 2.0 authentication with the email server you would like to connect to (such as the various [open](https://github.com/mozilla/releases-comm-central/blob/master/mailnews/base/src/OAuth2Providers.jsm) [source](https://gitlab.gnome.org/GNOME/evolution-data-server/-/blob/master/CMakeLists.txt) [clients](https://gitlab.gnome.org/GNOME/gnome-online-accounts/-/blob/master/meson_options.txt) with OAuth 2.0 support), but please do this with care and restraint as access through reused tokens will be associated with the token owner rather than your own client.
 
-If you do not have access to credentials for an  existing client you will need to register your own. The process to do this is different for each provider, but the registration guides for several common ones are linked below. In all cases, when registering, make sure your client is set up to use an OAuth scope that will give it permission to access IMAP/SMTP – see the sample configuration file for examples.
+If you do not have access to credentials for an existing client you will need to register your own. The process to do this is different for each provider, but the registration guides for several common ones are linked below. In all cases, when registering, make sure your client is set up to use an OAuth scope that will give it permission to access IMAP/SMTP – see the sample configuration file for examples.
 
 - Office 365: register a new [Microsoft identity application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app)
 - Gmail / Google Workspace: register a [Google API desktop app client](https://developers.google.com/identity/protocols/oauth2/native-app)
@@ -90,7 +90,7 @@ Please feel free to [open an issue](https://github.com/simonrob/email-oauth2-pro
 
 
 ## Advanced / experimental features
-The [plugins branch](https://github.com/simonrob/email-oauth2-proxy/tree/plugins) has a semi-experimental new feature that enables the use of separate scripts to modify IMAP/SMTP commands when they are received from the client or server before passing through to the other side of the connection. This allows a wide range of additional capabilities or triggers to be added the proxy. For example, the [IMAPIgnoreSentMessageUpload plugin](https://github.com/simonrob/email-oauth2-proxy/blob/plugins/plugins/IMAPIgnoreSentMessageUpload.py) intercepts any client commands to add emails to the IMAP sent messages mailbox, which resolves message duplication issues for servers that automatically do this when emails are received via SMTP (e.g., Office 365, Gmail, etc). See the documentation and examples in this branch for further details and setup instructions.
+The [plugins branch](https://github.com/simonrob/email-oauth2-proxy/tree/plugins) has a semi-experimental new feature that enables the use of separate scripts to modify IMAP/SMTP commands when they are received from the client or server before passing through to the other side of the connection. This allows a wide range of additional capabilities or triggers to be added the proxy. For example, the [IMAPIgnoreSentMessageUpload plugin](https://github.com/simonrob/email-oauth2-proxy/blob/plugins/plugins/IMAPIgnoreSentMessageUpload.py) intercepts any client commands to add emails to the IMAP sent messages mailbox, which resolves message duplication issues for servers that automatically do this when emails are received via SMTP (e.g., Office 365, Gmail, etc). The [SMTPBlackHole plugin](https://github.com/simonrob/email-oauth2-proxy/blob/plugins/plugins/SMTPBlackHole.py) gives the impression emails are being sent but actually silently discards them, which is useful for testing email sending tools. See the documentation and examples in this branch for further details, additional sample plugins and setup instructions.
 
 
 ## Potential improvements (pull requests welcome)

emailproxy.py

@@ -730,7 +730,7 @@ def authenticate_connection(self, username, password, command='login'):
 
 
 class SMTPOAuth2ClientConnection(OAuth2ClientConnection):
-    """The client side of the connection - intercept AUTH LOGIN commands and replace with OAuth 2.0"""
+    """The client side of the connection - intercept AUTH PLAIN and AUTH LOGIN commands and replace with OAuth 2.0"""
 
     class AUTH(enum.Enum):
         PENDING = 1
@@ -1050,7 +1050,7 @@ def process_data(self, byte_data):
 
 
 class OAuth2Proxy(asyncore.dispatcher):
-    """Listen on SERVER_ADDRESS:SERVER_PORT, creating a ServerConnection + ClientConnection for each new connection"""
+    """Listen on local_address, creating an OAuth2ServerConnection + OAuth2ClientConnection for each new connection"""
 
     def __init__(self, proxy_type, local_address, server_address, custom_configuration):
         asyncore.dispatcher.__init__(self)
@@ -1089,7 +1089,7 @@ def handle_accepted(self, connection, address):
                 error_text = '%s encountered an SSL error - is the server\'s starttls setting correct? Current ' \
                              'value: %s' % (self.info_string(), self.custom_configuration['starttls'])
                 Log.error(error_text)
-                if sys.platform == 'darwin':
+                if sys.platform in ['darwin', 'win32']:
                     Log.error('If you encounter this error repeatedly, please check that you have correctly configured '
                               'python root certificates; see: https://github.com/simonrob/email-oauth2-proxy/issues/14')
                 connection.send(b'%s\r\n' % self.bye_message(error_text).encode('utf-8'))
@@ -1205,14 +1205,6 @@ def handle_close(self):
             Log.error('Abandoning restart of', self.info_string(), 'due to repeated exception:', Log.error_string(e))
 
 
-class AuthorisationWindow:
-    """Used to dynamically add the missing get_title method to a pywebview window"""
-
-    # noinspection PyUnresolvedReferences
-    def get_title(self):
-        return self.title
-
-
 if sys.platform == 'darwin':
     # noinspection PyUnresolvedReferences,PyMethodMayBeStatic,PyPep8Naming,PyUnusedLocal
     class ProvisionalNavigationBrowserDelegate:
@@ -1546,7 +1538,7 @@ def create_authorisation_window(self, request):
             authorisation_window = webview.create_window(window_title, html=auth_page, on_top=True, text_select=True)
         else:
             authorisation_window = webview.create_window(window_title, request['permission_url'], on_top=True)
-        setattr(authorisation_window, 'get_title', AuthorisationWindow.get_title)  # add missing get_title method
+        setattr(authorisation_window, 'get_title', lambda window: window.title)  # add missing get_title method
 
         # pywebview 3.6+ moved window events to a separate namespace in a non-backwards-compatible way
         if pkg_resources.parse_version(
@@ -1763,11 +1755,7 @@ def toggle_debug(_, item):
     # noinspection PyUnresolvedReferences
     def notify(self, title, text):
         if self.icon:
-            if self.icon.HAS_NOTIFICATION:
-                self.icon.remove_notification()
-                self.icon.notify('%s: %s' % (title, text))
-
-            elif sys.platform == 'darwin':
+            if sys.platform == 'darwin':  # prefer native notifications over the osascript approach
                 user_notification = AppKit.NSUserNotification.alloc().init()
                 user_notification.setTitle_(title)
                 user_notification.setInformativeText_(text)
@@ -1782,6 +1770,10 @@ def notify(self, title, text):
                         title = title.replace(*replacement)
                     os.system('osascript -e \'display notification "%s" with title "%s"\'' % (text, title))
 
+            elif self.icon.HAS_NOTIFICATION:
+                self.icon.remove_notification()
+                self.icon.notify('%s: %s' % (title, text))
+
             else:
                 Log.info(title, text)  # last resort
         else:

requirements.txt

@@ -2,7 +2,7 @@ configobj
 cryptography
 pillow
 pystray
-pywebview
+pywebview; sys_platform != 'win32'  # specify platform to avoid double requirement error with older pip versions
 timeago
 
 # used to improve menu bar interaction, provide native notifications, handle system events and output to unified logging