full test coverage

apprise/plugins/office365.py

@@ -37,6 +37,7 @@
 # Note: One must set up Application Permissions (not Delegated Permissions)
 #       - Scopes required: Mail.Send
 #       - For Large Attachments: Mail.ReadWrite
+#       - For Email Lookups: User.Read.All
 #
 import requests
 import json
@@ -285,9 +286,16 @@ def __init__(self, tenant, client_id, secret, source=None,
 
         # Our email source; we detect this if the source is an ObjectID
         # If it is unknown we set this to None
-        self.from_email = self.source \
-            if (self.source and is_email(self.source)) \
-            else self.store.get('from')
+        # User is the email associated with the account
+        self.from_email = self.store.get('from')
+        result = is_email(self.source)
+        if result:
+            self.from_email = result['full_email']
+            self.from_name = \
+                result['name'] or self.store.get('name')
+
+        else:
+            self.from_name = self.store.get('name')
 
         return
 
@@ -306,7 +314,7 @@ def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
                 'There are no Email recipients to notify')
             return False
 
-        if not self.from_email:
+        if self.from_email is None:
             if not self.authenticate():
                 # We could not authenticate ourselves; we're done
                 return False
@@ -319,18 +327,27 @@ def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
                 self.logger.warning(
                     'Could not acquire From email address; ensure '
                     '"User.Read.All" Application scope is set!')
-                return False
 
-            # Acquire our from_email
-            self.from_email = \
-                response.get("mail") or response.get("userPrincipalName")
-            if not is_email(self.from_email):
-                self.logger.warning(
-                    'Could not get From email from the Azure endpoint.')
-                return False
+            else:  # Acquire our from_email (if possible)
+                from_email = \
+                    response.get("mail") or response.get("userPrincipalName")
+                result = is_email(from_email)
+                if not result:
+                    self.logger.warning(
+                        'Could not get From email from the Azure endpoint.')
+
+                    # Prevent re-occuring upstream fetches for info that isn't
+                    # there
+                    self.from_email = False
+
+                else:
+                    # Store our email for future reference
+                    self.from_email = result['full_email']
+                    self.store.set('from', result['full_email'])
 
-            # Store our email for future reference
-            self.store.set('from', self.from_email)
+                    self.from_name = response.get("displayName")
+                    if self.from_name:
+                        self.store.set('name', self.from_name)
 
         # Setup our Content Type
         content_type = \
@@ -339,11 +356,6 @@ def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
         # Prepare our payload
         payload = {
             'message': {
-                'from': {
-                    "emailAddress": {
-                        "address": self.from_email,
-                    }
-                },
                 'subject': title,
                 'body': {
                     'contentType': content_type,
@@ -354,6 +366,19 @@ def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
             'saveToSentItems': 'true'
         }
 
+        if self.from_email:
+            # Apply from email if it is known
+            payload.update({
+                'message': {
+                    'from': {
+                        "emailAddress": {
+                            "address": self.from_email,
+                            "name": self.from_name or self.app_id,
+                        }
+                    },
+                }
+            })
+
         # Create a copy of the email list
         emails = list(self.targets)
 
@@ -446,7 +471,7 @@ def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
             # Prepare our email
             payload['message']['toRecipients'] = [{
                 'emailAddress': {
-                    'Address': to_addr
+                    'address': to_addr
                 }
             }]
             if to_name:
@@ -461,9 +486,9 @@ def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
                 # Prepare our CC list
                 payload['message']['ccRecipients'] = []
                 for addr in cc:
-                    _payload = {'Address': addr}
+                    _payload = {'address': addr}
                     if self.names.get(addr):
-                        _payload['Name'] = self.names[addr]
+                        _payload['name'] = self.names[addr]
 
                     # Store our address in our payload
                     payload['message']['ccRecipients']\
@@ -787,6 +812,23 @@ def _fetch(self, url, payload=None, headers=None,
                 #  }}
                 # }
 
+                # Error 403; the below is returned if he User.Read.All
+                #           Application scope is not set and a lookup is
+                #           attempted.
+                # {
+                #   "error": {
+                #     "code": "Authorization_RequestDenied",
+                #     "message":
+                #        "Insufficient privileges to complete the operation.",
+                #     "innerError": {
+                #       "date": "2024-12-06T00:15:57",
+                #       "request-id":
+                #         "48fdb3e7-2f1a-4f45-a5a0-99b8b851278b",
+                #         "client-request-id": "48f-2f1a-4f45-a5a0-99b8"
+                #     }
+                #   }
+                # }
+
                 # Another response type (error 415):
                 # {
                 #  "error": {