PyEmailerAJM 0.1__tar.gz → 1.3__tar.gz

{PyEmailerAJM-0.1 → PyEmailerAJM-1.3}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: PyEmailerAJM
-Version: 0.1
+Version: 1.3
 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/0.1.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.3.tar.gz
 Keywords: Outlook,Email,Automation
 Platform: UNKNOWN
 License-File: LICENSE.txt

PyEmailerAJM-1.3/PyEmailerAJM/PyEmailerAJM.py

@@ -0,0 +1,262 @@
+#! python3
+"""
+PyEmailerAJM.py
+
+install win32 with pip install pywin32
+"""
+from os.path import isfile, abspath, isabs, join
+
+# imports
+
+# install win32 with pip install pywin32
+import win32com.client as win32
+# This is installed as part of pywin32
+from pythoncom import com_error
+from logging import Logger
+
+
+class EmailerNotSetupError(Exception):
+    ...
+
+
+class PyEmailer:
+    # the email tab_char
+    tab_char = ' '
+
+    def __init__(self, display_window: bool,
+                 send_emails: bool, logger: Logger = None,
+                 auto_send: bool = False,
+                 email_app_name: str = 'outlook.application'):
+
+        if logger:
+            self._logger = logger
+        else:
+            self._logger = Logger("DUMMY")
+            # print("Dummy logger in use!")
+
+        self.email_app_name = email_app_name
+
+        self.display_window = display_window
+        self.auto_send = auto_send
+        self.send_emails = send_emails
+        self._setup_was_run = False
+
+        self._recipient = None
+        self._subject = None
+        self._text = None
+        self.read_folder = None
+
+        try:
+            self.email_app = win32.Dispatch(self.email_app_name)
+            self._mapi_ns = self.email_app.GetNamespace('MAPI')
+            self.email = self.email_app.CreateItem(0)
+        except com_error 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)
+        return self.read_folder
+
+    def GetMessages(self, folder_index=None):
+        if isinstance(folder_index, int):
+            self.read_folder = self._GetReadFolder(folder_index)
+        elif not folder_index and self.read_folder:
+            pass
+        elif not folder_index:
+            self.read_folder = self._GetReadFolder()
+        else:
+            try:
+                raise TypeError("folder_index must be an integer or self.read_folder must be defined")
+            except TypeError as e:
+                self._logger.error(e, exc_info=True)
+                raise e
+        return self.read_folder.Items
+
+    def GetEmailMessageBody(self, msg):
+        """message = messages.GetLast()"""
+        body_content = msg.body
+        if body_content:
+            return body_content
+        else:
+            try:
+                raise ValueError("This message has no body.")
+            except ValueError as e:
+                self._logger.error(e, exc_info=True)
+                raise e
+
+    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:'"""
+        matched_messages = []
+        for message in self.GetMessages():
+            if forwarded_message_match:
+                if (message.Subject == subject or
+                        (message.Subject.startswith('FW:')
+                         and message.Subject.split('FW:')[1].strip() == subject) or
+                        (message.Subject.startswith('FWD:')
+                         and message.Subject.split('FWD:')[1].strip() == subject)):
+                    matched_messages.append(message)
+            if reply_msg_match:
+                if (message.Subject == subject or
+                        (message.Subject.startswith('RE:')
+                         and message.Subject.split('RE:')[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):
+        attachments = msg.Attachments
+        for attachment in attachments:
+            full_save_path = join(save_dir_path, str(attachment))
+            try:
+                attachment.SaveAsFile(full_save_path)
+                self._logger.debug(f"{full_save_path} saved from email with subject {msg.subject}")
+            except Exception as e:
+                self._logger.error(e, exc_info=True)
+                raise e
+
+    def SetupEmail(self, recipient: str, subject: str, text: str, attachments: list = None):
+        def _validate_attachments():
+            if attachments:
+                if isinstance(attachments, list):
+                    for a in attachments:
+                        if isfile(a):
+                            if isabs(a):
+                                self.email.Attachments.Add(a)
+                            else:
+                                a = abspath(a)
+                                if isfile(a):
+                                    self.email.Attachments.Add(a)
+                                else:
+                                    try:
+                                        raise FileNotFoundError(f"file {a} could not be attached.")
+                                    except FileNotFoundError as e:
+                                        self._logger.error(e, exc_info=True)
+                                        raise e
+                        else:
+                            try:
+                                raise FileNotFoundError(f"file {a} could not be attached.")
+                            except FileNotFoundError as e:
+                                self._logger.error(e, exc_info=True)
+                                raise e
+                else:
+                    try:
+                        raise TypeError("attachments attribute must be a list")
+                    except TypeError as e:
+                        self._logger.error(e, exc_info=True)
+                        raise e
+            else:
+                self._logger.debug("no attachments detected")
+
+        try:
+            # set the params
+            _validate_attachments()
+            self.email.To = recipient
+            self.email.Subject = subject
+            self.email.HtmlBody = text
+
+            self._recipient = self.email.To
+            self._subject = self.email.Subject
+            self._text = self.email.HtmlBody
+
+            # print("New email set up successfully.")
+            self._logger.info("New email set up successfully. see debug for details")
+            self._logger.debug(f"Email recipient {recipient}, Subject {subject}, Message body {text}")
+            self._setup_was_run = True
+            return self.email
+
+        except Exception as e:
+            self._logger.error(e, exc_info=True)
+            raise e
+
+    def _display(self):
+        # print(f"Displaying the email in {self.email_app_name}, this window might open minimized.")
+        self._logger.info(f"Displaying the email in {self.email_app_name}, this window might open minimized.")
+        try:
+            self.email.Display(True)
+        except Exception as e:
+            self._logger.error(e, exc_info=True)
+            raise e
+
+    def _send(self):
+        try:
+            self.email.Send()
+            # print(f"Mail sent to {self._recipient}")
+            self._logger.info(f"Mail successfully sent to {self._recipient}")
+        except Exception as e:
+            self._logger.error(e, exc_info=True)
+            raise e
+
+    def _manual_send_loop(self):
+        while True:
+            yn = input("Send Mail? (y/n/q): ").lower()
+            if yn == 'y':
+                self._send()
+                break
+            elif yn == 'n':
+                self._logger.info(f"Mail not sent to {self._recipient}")
+                print(f"Mail not sent to {self._recipient}")
+                break
+            elif yn == 'q':
+                print("ok quitting!")
+                self._logger.warning("Quitting early due to user input.")
+                exit(-1)
+            else:
+                print("Please choose \'y\', \'n\' or \'q\'")
+
+    def SendOrDisplay(self):
+        if self._setup_was_run:
+            # print(f"Ready to send/display mail to/for {self._recipient}...")
+            self._logger.info(f"Ready to send/display mail to/for {self._recipient}...")
+            if self.send_emails and self.display_window:
+                send_and_display_warning = ("Sending email while also displaying the email "
+                                            "in the app is not possible. Defaulting to Display only")
+                # print(send_and_display_warning)
+                self._logger.warning(send_and_display_warning)
+                self.send_emails = False
+                self.display_window = True
+
+            if self.send_emails:
+                if self.auto_send:
+                    self._logger.info("Sending emails with auto_send...")
+                    self._send()
+                else:
+                    self._manual_send_loop()
+
+            elif self.display_window:
+                self._display()
+            else:
+                both_disabled_warning = ("Both sending and displaying the email are disabled. "
+                                         "No errors were encountered.")
+                self._logger.warning(both_disabled_warning)
+                # print(both_disabled_warning)
+        else:
+            try:
+                raise EmailerNotSetupError("Setup has not been run, sending or displaying an email cannot occur.")
+            except EmailerNotSetupError as e:
+                self._logger.error(e, exc_info=True)
+                raise e
+
+
+if __name__ == "__main__":
+    module_name = __file__.split('\\')[-1].split('.py')[0]
+
+    """emailer = PyEmailer(display_window=False, send_emails=True, auto_send=False)
+
+    r_dict = {
+        "subject": f"TEST: Your TEST "
+                   f"agreement expires in 30 days or less!",
+        "text": "testing to see if the attachment works",
+        "recipient": 'test',
+        "attachments": []
+    }
+    #   is the tab character for emails
+    emailer.SetupEmail(**r_dict)  # recipient="test", subject="test subject", text="test_body")
+    emailer.SendOrDisplay()"""

{PyEmailerAJM-0.1 → PyEmailerAJM-1.3}/PyEmailerAJM.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: PyEmailerAJM
-Version: 0.1
+Version: 1.3
 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/0.1.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.3.tar.gz
 Keywords: Outlook,Email,Automation
 Platform: UNKNOWN
 License-File: LICENSE.txt

PyEmailerAJM-1.3/README.md

@@ -0,0 +1,10 @@
+# <u>PyEmailerAJM</u>
+### <i>Makes automating Outlook emails quick and easy</i>
+
+- PyEmailerAJM uses pywin32 to automate the sending/reading of Outlook emails.
+
+<b>Import</b>
+
+import PyEmailer class using `from PyEmailerAJM.PyEmailerAJM import PyEmailer`
+
+see [OutlookPywin32Commands.xlsx](OutlookPywin32Commands.xlsx) for list of commands that can be used with a message object.

{PyEmailerAJM-0.1 → PyEmailerAJM-1.3}/setup.py

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

PyEmailerAJM-0.1/PyEmailerAJM/PyEmailerAJM.py

@@ -1,164 +0,0 @@
-#! python3
-"""
-PyEmailerAJM.py
-
-install win32 with pip install pywin32
-"""
-
-# imports
-
-# install win32 with pip install pywin32
-import win32com.client as win32
-# This is installed as part of pywin32
-from pythoncom import com_error
-from logging import Logger
-
-
-class EmailerNotSetupError(Exception):
-    ...
-
-
-class PyEmailer:
-    def __init__(self, display_window: bool,
-                 send_emails: bool, logger: Logger = None,
-                 auto_send: bool = False,
-                 email_app_name: str = 'outlook.application'):
-
-        if logger:
-            self._logger = logger
-        else:
-            self._logger = Logger("DUMMY")
-            # print("Dummy logger in use!")
-
-        self.email_app_name = email_app_name
-
-        self.display_window = display_window
-        self.auto_send = auto_send
-        self.send_emails = send_emails
-        self._setup_was_run = False
-
-        self._recipient = None
-        self._subject = None
-        self._text = None
-
-        try:
-            self.email_app = win32.Dispatch(self.email_app_name)
-            self.email = self.email_app.CreateItem(0)
-        except com_error as e:
-            self._logger.error(e, exc_info=True)
-            raise e
-
-    def SetupEmail(self, recipient: str, subject: str, text: str):
-        try:
-            # set the params
-            self.email.To = recipient
-            self.email.Subject = subject
-            self.email.HtmlBody = text
-
-            self._recipient = self.email.To
-            self._subject = self.email.Subject
-            self._text = self.email.HtmlBody
-
-            # print("New email set up successfully.")
-            self._logger.info("New email set up successfully. see debug for details")
-            self._logger.debug(f"Email recipient {recipient}, Subject {subject}, Message body {text}")
-            self._setup_was_run = True
-            return self.email
-
-        except Exception as e:
-            self._logger.error(e, exc_info=True)
-            raise e
-
-    def _display(self):
-        # print(f"Displaying the email in {self.email_app_name}, this window might open minimized.")
-        self._logger.info(f"Displaying the email in {self.email_app_name}, this window might open minimized.")
-        try:
-            self.email.Display(True)
-        except Exception as e:
-            self._logger.error(e, exc_info=True)
-            raise e
-
-    def _send(self):
-        try:
-            self.email.Send()
-            # print(f"Mail sent to {self._recipient}")
-            self._logger.info(f"Mail successfully sent to {self._recipient}")
-        except Exception as e:
-            self._logger.error(e, exc_info=True)
-            raise e
-
-    def _manual_send_loop(self):
-        while True:
-            yn = input("Send Mail? (y/n/q): ").lower()
-            if yn == 'y':
-                self._send()
-                break
-            elif yn == 'n':
-                self._logger.info(f"Mail not sent to {self._recipient}")
-                print(f"Mail not sent to {self._recipient}")
-                break
-            elif yn == 'q':
-                print("ok quitting!")
-                self._logger.warning("Quitting early due to user input.")
-                exit(-1)
-            else:
-                print("Please choose \'y\', \'n\' or \'q\'")
-
-    def SendOrDisplay(self):
-        if self._setup_was_run:
-            # print(f"Ready to send/display mail to/for {self._recipient}...")
-            self._logger.info(f"Ready to send/display mail to/for {self._recipient}...")
-            if self.send_emails and self.display_window:
-                send_and_display_warning = ("Sending email while also displaying the email "
-                                            "in the app is not possible. Defaulting to Display only")
-                # print(send_and_display_warning)
-                self._logger.warning(send_and_display_warning)
-                self.send_emails = False
-                self.display_window = True
-
-            if self.send_emails:
-                if self.auto_send:
-                    self._logger.info("Sending emails with auto_send...")
-                    self._send()
-                else:
-                    self._manual_send_loop()
-
-            elif self.display_window:
-                self._display()
-            else:
-                both_disabled_warning = ("Both sending and displaying the email are disabled. "
-                                         "No errors were encountered.")
-                self._logger.warning(both_disabled_warning)
-                # print(both_disabled_warning)
-        else:
-            try:
-                raise EmailerNotSetupError("Setup has not been run, sending or displaying an email cannot occur.")
-            except EmailerNotSetupError as e:
-                self._logger.error(e, exc_info=True)
-                raise e
-
-
-if __name__ == "__main__":
-    module_name = __file__.split('\\')[-1].split('.py')[0]
-
-    """emailer = PyEmailer(display_window=False, send_emails=True, auto_send=False)
-
-    r_dict = {
-        "subject": f"TEST: Your TEST "
-                   f"agreement expires in 30 days or less!",
-        "text": f"To whom it may concern,<br>"
-                f"&emsp; Your TEST "
-                f"agreement <b>expires in 30 days or less (your due date is TEST)</b>. "
-                f"Please renew the aforementioned by dropping off a hard copy to "
-                f"the Albany Water Department at 10 N Enterprise Dr.<br>"
-                f"Thank You,<br>"
-                f"AWD"
-                f"<br>"
-                f"<br>"
-                f"<br>"
-                f"This is an automated email, Please do not respond directly to it.",
-        "recipient": ''
-    }
-    # &emsp; is the tab character for emails
-    emailer.SetupEmail(**r_dict)  # recipient="amcsparron@albanyny.gov", subject="test subject", text="test_body")
-    emailer.SendOrDisplay()"""

PyEmailerAJM-0.1/README.md

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