PyEmailerAJM 1.1__tar.gz → 1.5__tar.gz

{PyEmailerAJM-1.1 → PyEmailerAJM-1.5}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: PyEmailerAJM
-Version: 1.1
+Version: 1.5
 Summary: Allows for automating sending Email with the Outlook Desktop client. Future releases will add more client support
 Home-page: https://github.com/amcsparron2793-Water/PyEmailer
 Author: Amcsparron
 Author-email: amcsparron@albanyny.gov
 License: MIT License
-Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.1.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.5.tar.gz
 Keywords: Outlook,Email,Automation
 Platform: UNKNOWN
 License-File: LICENSE.txt

{PyEmailerAJM-1.1 → PyEmailerAJM-1.5}/PyEmailerAJM/PyEmailerAJM.py

@@ -4,7 +4,8 @@ PyEmailerAJM.py
 
 install win32 with pip install pywin32
 """
-from os.path import isfile, abspath, isabs, join
+from os import environ
+from os.path import isfile, abspath, isabs, join, isdir
 
 # imports
 
@@ -19,9 +20,21 @@ class EmailerNotSetupError(Exception):
     ...
 
 
+class DisplayManualQuit(Exception):
+    ...
+
+
 class PyEmailer:
+    # the email tab_char
+    tab_char = ' '
+    signature_dir_path = join((environ['USERPROFILE']),
+                              'AppData\\Roaming\\Microsoft\\Signatures\\')
+
+    DisplayEmailSendTrackingWarning = "THIS TYPE OF SEND CANNOT BE DETECTED FOR SEND SUCCESS AUTOMATICALLY."
+
     def __init__(self, display_window: bool,
                  send_emails: bool, logger: Logger = None,
+                 email_sig_filename: str = None,
                  auto_send: bool = False,
                  email_app_name: str = 'outlook.application'):
 
@@ -51,6 +64,69 @@ class PyEmailer:
             self._logger.error(e, exc_info=True)
             raise e
 
+        self._email_signature = None
+        self._send_success = False
+        self.email_sig_filename = email_sig_filename
+
+    @property
+    def email_signature(self):
+        return self._email_signature
+
+    @email_signature.getter
+    def email_signature(self):
+        signature_full_path = join(self.signature_dir_path, self.email_sig_filename)
+        if isdir(self.signature_dir_path):
+            pass
+        else:
+            try:
+                raise NotADirectoryError(f"{self.signature_dir_path} does not exist.")
+            except NotADirectoryError as e:
+                self._logger.warning(e)
+                self._email_signature = None
+
+        if isfile(signature_full_path):
+            with open(signature_full_path, 'r', encoding='utf-16') as f:
+                self._email_signature = f.read().strip()
+        else:
+            try:
+                raise FileNotFoundError(f"{signature_full_path} does not exist.")
+            except FileNotFoundError as e:
+                self._logger.warning(e)
+                self._email_signature = None
+
+        return self._email_signature
+
+    @property
+    def send_success(self):
+        return self._send_success
+
+    @send_success.setter
+    def send_success(self, value):
+        self._send_success = value
+
+    def _display_tracking_warning_confirm(self):
+        while True:
+            q = input(f"{self.DisplayEmailSendTrackingWarning}. Do you understand? (y/n): ").lower().strip()
+            if q == 'y':
+                self._logger.warning(self.DisplayEmailSendTrackingWarning)
+                return True
+            elif q == 'n':
+                return False
+            else:
+                print("Please respond with 'y' or 'n'.")
+
+    def display_tracker_check(self) -> bool:
+        if self.display_window:
+            c = self._display_tracking_warning_confirm()
+            if c:
+                return c
+            else:
+                try:
+                    raise DisplayManualQuit("User cancelled operation due to DisplayTrackingWarning.")
+                except DisplayManualQuit as e:
+                    self._logger.error(e, exc_info=True)
+                    raise e
+
     def _GetReadFolder(self, email_dir_index: int = 6):
         # 6 = inbox
         self.read_folder = self._mapi_ns.GetDefaultFolder(email_dir_index)
@@ -83,11 +159,39 @@ class PyEmailer:
                 self._logger.error(e, exc_info=True)
                 raise e
 
-    def FindMsgBySubject(self, subject: str) -> list:
+    def FindMsgBySubject(self, subject: str, forwarded_message_match: bool = True,
+                         reply_msg_match: bool = True) -> list:
+        """Matches the message.Subject string to the subject attr string and returns a list of messages.
+        If forward_message_match is True than messages are matched without
+        regard to if they start with 'FW:' or 'FWD:'
+
+        If reply_msg_match is True than messages are matched without
+        regard to if they start with 'RE:'
+        """
         matched_messages = []
+        subject = subject.lower().strip()
+        fw_str = 'FW:'.lower()
+        fwd_str = 'FWD:'.lower()
+        re_str = 'RE:'.lower()
+
         for message in self.GetMessages():
-            if message.Subject == subject:
-                matched_messages.append(message)
+            message.Subject = message.Subject.lower()
+            if forwarded_message_match:
+                if (message.Subject == subject or
+                        (message.Subject.startswith(fw_str)
+                         and message.Subject.split(fw_str)[1].strip() == subject) or
+                        (message.Subject.startswith(fwd_str)
+                         and message.Subject.split(fwd_str)[1].strip() == subject)):
+                    matched_messages.append(message)
+            if reply_msg_match:
+                if (message.Subject == subject or
+                        (message.Subject.startswith(re_str)
+                         and message.Subject.split(re_str)[1].strip() == subject)):
+                    matched_messages.append(message)
+            else:
+                if message.Subject == subject:
+                    matched_messages.append(message)
+
         return matched_messages
 
     def SaveAllEmailAttachments(self, msg, save_dir_path):
@@ -166,8 +270,10 @@ class PyEmailer:
 
     def _send(self):
         try:
+            self.send_success = False
             self.email.Send()
             # print(f"Mail sent to {self._recipient}")
+            self.send_success = True
             self._logger.info(f"Mail successfully sent to {self._recipient}")
         except Exception as e:
             self._logger.error(e, exc_info=True)
@@ -233,9 +339,9 @@ if __name__ == "__main__":
         "subject": f"TEST: Your TEST "
                    f"agreement expires in 30 days or less!",
         "text": "testing to see if the attachment works",
-        "recipient": 'pbehnke@albanyny.gov',
+        "recipient": 'test',
         "attachments": []
     }
     #   is the tab character for emails
-    emailer.SetupEmail(**r_dict)  # recipient="amcsparron@albanyny.gov", subject="test subject", text="test_body")
+    emailer.SetupEmail(**r_dict)  # recipient="test", subject="test subject", text="test_body")
     emailer.SendOrDisplay()"""

{PyEmailerAJM-1.1 → PyEmailerAJM-1.5}/PyEmailerAJM.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: PyEmailerAJM
-Version: 1.1
+Version: 1.5
 Summary: Allows for automating sending Email with the Outlook Desktop client. Future releases will add more client support
 Home-page: https://github.com/amcsparron2793-Water/PyEmailer
 Author: Amcsparron
 Author-email: amcsparron@albanyny.gov
 License: MIT License
-Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.1.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.5.tar.gz
 Keywords: Outlook,Email,Automation
 Platform: UNKNOWN
 License-File: LICENSE.txt

PyEmailerAJM-1.5/README.md

@@ -0,0 +1,15 @@
+# <u>PyEmailerAJM</u>
+### <i>Makes automating Outlook emails quick and easy</i>
+
+- PyEmailerAJM uses pywin32 to automate the sending/reading of Outlook emails.
+
+**Import**
+
+- import PyEmailer class using `from PyEmailerAJM.PyEmailerAJM import PyEmailer`
+
+**Notes**
+
+- see [OutlookPywin32Commands.xlsx](OutlookPywin32Commands.xlsx) for list of commands that can be used with a message object.
+
+- Email signature **text** can now be added as of v1.4
+  - Assuming the signature *.txt file is found in `%APPDATA%/Microsoft/Signatures/`

{PyEmailerAJM-1.1 → PyEmailerAJM-1.5}/setup.py

@@ -2,10 +2,10 @@ from setuptools import setup
 
 setup(
     name='PyEmailerAJM',
-    version='1.1',
+    version='1.5',
     packages=['PyEmailerAJM'],
     url='https://github.com/amcsparron2793-Water/PyEmailer',
-    download_url='https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.1.tar.gz',
+    download_url='https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.5.tar.gz',
     keywords=["Outlook", "Email", "Automation"],
     install_requires=['pywin32'],
     license='MIT License',

PyEmailerAJM-1.1/README.md

@@ -1,8 +0,0 @@
-# <u>PyEmailerAJM</u>
-### <i>Makes automating Outlook emails quick and easy</i>
-
-- PyEmailerAJM uses pywin32 to automate the sending of Outlook emails.
-
-<b>Import</b>
-
-import PyEmailer class using `from PyEmailerAJM.PyEmailerAJM import PyEmailer`