PyEmailerAJM 1.6__tar.gz → 1.7__tar.gz

{pyemailerajm-1.6 → pyemailerajm-1.7}/PKG-INFO

@@ -1,15 +1,18 @@
 Metadata-Version: 2.4
 Name: PyEmailerAJM
-Version: 1.6
+Version: 1.7
 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
-Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.6.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.7.tar.gz
 Author: Amcsparron
 Author-email: amcsparron@albanyny.gov
 License: MIT License
 Keywords: Outlook,Email,Automation
 License-File: LICENSE.txt
 Requires-Dist: pywin32
+Requires-Dist: extract_msg
+Requires-Dist: email_validator
+Requires-Dist: questionary
 Dynamic: author
 Dynamic: author-email
 Dynamic: download-url

pyemailerajm-1.7/PyEmailerAJM/__init__.py

@@ -0,0 +1,8 @@
+from PyEmailerAJM.backend import deprecated
+from PyEmailerAJM.backend.errs import EmailerNotSetupError, DisplayManualQuit
+from PyEmailerAJM.msg import Msg, FailedMsg
+from PyEmailerAJM.searchers import BaseSearcher, SubjectSearcher
+from PyEmailerAJM.py_emailer_ajm import PyEmailer, EmailerInitializer
+
+__all__ = ['EmailerNotSetupError', 'DisplayManualQuit', 'deprecated',
+           'Msg', 'FailedMsg', 'PyEmailer', 'EmailerInitializer']

pyemailerajm-1.7/PyEmailerAJM/_version.py

@@ -0,0 +1 @@
+__version__ = '1.7'

{pyemailerajm-1.6 → pyemailerajm-1.7}/PyEmailerAJM/py_emailer_ajm.py

@@ -5,11 +5,9 @@ py_emailer_ajm.py
 install win32 with pip install pywin32
 """
 # imports
-from abc import abstractmethod
 from os import environ
 from os.path import isfile, join, isdir
 from tempfile import gettempdir
-from typing import List
 
 # install win32 with pip install pywin32
 import win32com.client as win32
@@ -23,11 +21,12 @@ import questionary
 # this is usually thrown when questionary is used in the dev/Non Win32 environment
 # noinspection PyProtectedMember
 from prompt_toolkit.output.win32 import NoConsoleScreenBufferError
-from win32com.client import CDispatch
 
-from PyEmailerAJM import EmailerNotSetupError, DisplayManualQuit
-from PyEmailerAJM import BasicEmailFolderChoices, deprecated
-from PyEmailerAJM import Msg, FailedMsg
+from PyEmailerAJM import (EmailerNotSetupError, DisplayManualQuit,
+                          deprecated,
+                          Msg, FailedMsg)
+from PyEmailerAJM.backend import BasicEmailFolderChoices
+from PyEmailerAJM.searchers import SubjectSearcher
 
 
 class EmailerInitializer:
@@ -52,6 +51,7 @@ class EmailerInitializer:
         self.auto_send = auto_send
         self.send_emails = send_emails
 
+    # TODO: replace me with EasyLoggerAJM
     def _initialize_logger(self, logger=None, **kwargs):
         if logger:
             self._logger = logger
@@ -121,74 +121,7 @@ class EmailerInitializer:
         return self.email_app, self.namespace
 
 
-class _SubjectSearcher:
-    # Constants for prefixes
-    FW_PREFIXES = ['FW:', 'FWD:']
-    RE_PREFIX = 'RE:'
-
-    @abstractmethod
-    def GetMessages(self):
-        ...
-
-    def find_messages_by_subject(self, search_subject: str, include_fw: bool = True, include_re: bool = True,
-                                 partial_match_ok: bool = False) -> List[CDispatch]:
-        """Returns a list of messages matching the given subject, ignoring prefixes based on flags."""
-
-        # Normalize search subject
-        normalized_subject = self._normalize_subject(search_subject)
-        matched_messages = []
-        print("partial match ok: ", partial_match_ok)
-
-        for message in self.GetMessages():
-            normalized_message_subject = self._normalize_subject(message.subject)
-
-            if (self._is_exact_match(normalized_message_subject, normalized_subject) or
-                    (partial_match_ok and self._is_partial_match(normalized_message_subject,
-                                                                 normalized_subject))):
-                matched_messages.append(message)
-                continue
-
-            if include_fw and self._matches_prefix(normalized_message_subject,
-                                                   self.__class__.FW_PREFIXES,
-                                                   normalized_subject,
-                                                   partial_match_ok):
-                matched_messages.append(message)
-                continue
-
-            if include_re and self._matches_prefix(normalized_message_subject,
-                                                   [self.__class__.RE_PREFIX],
-                                                   normalized_subject,
-                                                   partial_match_ok):
-                matched_messages.append(message)
-
-        return [m() for m in matched_messages]
-
-    @staticmethod
-    def _normalize_subject(subject: str) -> str:
-        """Normalize the given subject by converting to lowercase and stripping whitespace."""
-        return subject.lower().strip()
-
-    def _matches_prefix(self, message_subject: str, prefixes: list, search_subject: str,
-                        partial_match_ok: bool = False) -> bool:
-        """Checks if the message subject matches the search subject after removing a prefix."""
-        for prefix in prefixes:
-            if message_subject.startswith(prefix.lower()):
-                stripped_subject = message_subject.split(prefix.lower(), 1)[1].strip()
-                return (self._is_exact_match(stripped_subject, search_subject) if not partial_match_ok
-                        else self._is_partial_match(stripped_subject, search_subject))
-        return False
-
-    @staticmethod
-    def _is_exact_match(message_subject: str, search_subject: str) -> bool:
-        """Checks if the subject matches exactly."""
-        return message_subject == search_subject
-
-    @staticmethod
-    def _is_partial_match(message_subject: str, search_subject: str) -> bool:
-        return search_subject in message_subject
-
-
-class PyEmailer(EmailerInitializer, _SubjectSearcher):
+class PyEmailer(EmailerInitializer, SubjectSearcher):
     # the email tab_char
     tab_char = ' '
     signature_dir_path = join((environ['USERPROFILE']),
@@ -496,12 +429,14 @@ if __name__ == "__main__":
     module_name = __file__.split('\\')[-1].split('.py')[0]
 
     em = PyEmailer(display_window=False, send_emails=True, auto_send=False, use_default_logger=True)
-    m = em.find_messages_by_subject('Andrew', partial_match_ok=True, include_re=True, include_fw=True)
+    m = em.find_messages_by_subject('Andrew', partial_match_ok=True)
     print([type(x) for x in m])
     # __setup_and_send_test(em)
     # __failed_sends_test(em)
-    # x = emailer.find_messages_by_subject("Timecard", partial_match_ok=False, include_re=False)
-    # #print([(m.SenderEmailAddress, m.SenderEmailType, [x.name for x in m.ItemProperties]) for m in x])
+    x = em.find_messages_by_subject("GIS Request", partial_match_ok=True)
+    # [x.name for x in m.ItemProperties]
+    print([(m.__class__, m.sender, m.sender_email_type, m.subject)
+           for m in [Msg(y) for y in x]])  # for m in x])
     # property_accessor = x[0].PropertyAccessor
     # print(x[0].Sender.GetExchangeUser().PrimarySmtpAddress)
     # print(property_accessor.GetProperty("PR_EMAIL_ADDRESS"))

{pyemailerajm-1.6 → pyemailerajm-1.7}/PyEmailerAJM.egg-info/PKG-INFO

@@ -1,15 +1,18 @@
 Metadata-Version: 2.4
 Name: PyEmailerAJM
-Version: 1.6
+Version: 1.7
 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
-Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.6.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.7.tar.gz
 Author: Amcsparron
 Author-email: amcsparron@albanyny.gov
 License: MIT License
 Keywords: Outlook,Email,Automation
 License-File: LICENSE.txt
 Requires-Dist: pywin32
+Requires-Dist: extract_msg
+Requires-Dist: email_validator
+Requires-Dist: questionary
 Dynamic: author
 Dynamic: author-email
 Dynamic: download-url

{pyemailerajm-1.6 → pyemailerajm-1.7}/PyEmailerAJM.egg-info/SOURCES.txt

@@ -4,9 +4,7 @@ setup.cfg
 setup.py
 PyEmailerAJM/__init__.py
 PyEmailerAJM/_version.py
-PyEmailerAJM/errs.py
 PyEmailerAJM/helpers.py
-PyEmailerAJM/msg.py
 PyEmailerAJM/py_emailer_ajm.py
 PyEmailerAJM.egg-info/PKG-INFO
 PyEmailerAJM.egg-info/SOURCES.txt

pyemailerajm-1.7/PyEmailerAJM.egg-info/requires.txt

@@ -0,0 +1,4 @@
+pywin32
+extract_msg
+email_validator
+questionary

{pyemailerajm-1.6 → pyemailerajm-1.7}/setup.py

@@ -17,7 +17,7 @@ setup(
     url='https://github.com/amcsparron2793-Water/PyEmailer',
     download_url=f'https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/{get_property("__version__", project_name)}.tar.gz',
     keywords=["Outlook", "Email", "Automation"],
-    install_requires=['pywin32'],
+    install_requires=['pywin32', 'extract_msg', 'email_validator', 'questionary'],
     license='MIT License',
     author='Amcsparron',
     author_email='amcsparron@albanyny.gov',

pyemailerajm-1.6/PyEmailerAJM/__init__.py

@@ -1,8 +0,0 @@
-from PyEmailerAJM.errs import EmailerNotSetupError, DisplayManualQuit
-from PyEmailerAJM.helpers import deprecated, BasicEmailFolderChoices
-from PyEmailerAJM.msg import Msg, FailedMsg
-from PyEmailerAJM.py_emailer_ajm import PyEmailer, EmailerInitializer
-
-__all__ = ['EmailerNotSetupError', 'DisplayManualQuit', 'deprecated',
-           'BasicEmailFolderChoices', 'Msg', 'FailedMsg',
-           'PyEmailer', 'EmailerInitializer']

pyemailerajm-1.6/PyEmailerAJM/_version.py

@@ -1 +0,0 @@
-__version__ = '1.6'

pyemailerajm-1.6/PyEmailerAJM/errs.py

@@ -1,6 +0,0 @@
-class EmailerNotSetupError(Exception):
-    ...
-
-
-class DisplayManualQuit(Exception):
-    ...

pyemailerajm-1.6/PyEmailerAJM/msg.py

@@ -1,230 +0,0 @@
-from abc import abstractmethod
-from os.path import isfile, isabs, abspath, join
-from tempfile import gettempdir
-
-import win32com.client as win32
-import datetime
-import extract_msg
-from bs4 import BeautifulSoup
-from logging import Logger, getLogger, warning
-
-
-class _BasicMsgProperties:
-    def __init__(self, email_item: win32.CDispatch):
-        self.email_item = email_item
-
-    @classmethod
-    @abstractmethod
-    def _validate_and_add_attachments(cls, email_item: win32.CDispatch, attachment_list: list = None):
-        ...
-
-    @property
-    def sender(self):
-        if hasattr(self.email_item, 'SenderEmailType') and self.email_item.SenderEmailType == 'EX':
-            return self.email_item.Sender.GetExchangeUser().PrimarySmtpAddress
-        # return self.email_item.Sender if hasattr(self.email_item, 'Sender') else self.email_item.sender
-        else:
-            return self.email_item.SenderEmailAddress
-
-    @property
-    def sender_name(self):
-        return self.email_item.Sender if hasattr(self.email_item, 'Sender') else self.email_item.sender
-
-    @property
-    def to(self):
-        return self.email_item.To if hasattr(self.email_item, 'To') else self.email_item.to
-
-    def cc(self):
-        return self.email_item.CC if hasattr(self.email_item, 'CC') else self.email_item.cc
-
-    @property
-    def subject(self):
-        return self.email_item.Subject if hasattr(self.email_item, 'Subject') else self.email_item.subject
-
-    @property
-    def received_time(self):
-        #not_future = self.email_item.ReceivedTime.year < datetime.datetime.now().year
-        return self.email_item.ReceivedTime #if not_future else None
-
-    @property
-    def body(self):
-        return self.email_item.HTMLBody if hasattr(self.email_item, 'HTMLBody') else self.email_item.htmlBody
-
-    @property
-    def attachments(self):
-        return self.email_item.Attachments
-
-    @attachments.setter
-    def attachments(self, value: list):
-        self._validate_and_add_attachments(self.email_item, value)
-
-
-class Msg(_BasicMsgProperties):
-    def __init__(self, email_item: win32.CDispatch or extract_msg.Message, **kwargs):
-        super().__init__(email_item)
-        self._logger: Logger = kwargs.get('logger', getLogger(__name__))
-        self.send_success = False
-
-    def __call__(self, *args, **kwargs):
-        return self.email_item
-
-    @classmethod
-    def SetupMsg(cls, sender, recipient, subject, body, email_item: win32.CDispatch, attachments: list = None, **kwargs):
-        email_item.To = recipient
-        email_item.Sender = sender
-        email_item.Subject = subject
-        email_item.HtmlBody = body
-        email_item.cc = kwargs.get('cc', '')
-        email_item.Bcc = kwargs.get('bcc', '')
-
-        cls._validate_and_add_attachments(email_item, attachments)
-        return cls(email_item, **kwargs)
-
-    @classmethod
-    def _validate_and_add_attachments(cls, email_item: win32.CDispatch, attachment_list: list = None):
-        """ Validate and attach files to the email_item. """
-        if not attachment_list:
-            warning("No attachments detected")
-            return
-
-        if not isinstance(attachment_list, list):
-            raise TypeError("Attachments must be provided as a list")
-
-        def _absolute_file_path(file_path):
-            """Returns absolute path if valid; raises FileNotFoundError otherwise."""
-            if not isabs(file_path):
-                file_path = abspath(file_path)
-            if not isfile(file_path):
-                raise FileNotFoundError(f"File {file_path} could not be attached.")
-            return file_path
-
-        for attachment in attachment_list:
-            email_item.attachments.Add(_absolute_file_path(attachment))
-
-    def SaveAllEmailAttachments(self, save_dir_path):
-        all_attachment_paths = set()
-        for attachment in self.attachments:
-            full_save_path = join(save_dir_path, str(attachment))
-            try:
-                attachment.SaveAsFile(full_save_path)
-                all_attachment_paths.add(full_save_path)
-                self._logger.debug(f"{full_save_path} saved from email with subject {self.subject}")
-            except Exception as e:
-                self._logger.error(e, exc_info=True)
-                raise e
-        return all_attachment_paths
-
-    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().Display(True)
-        except Exception as e:
-            self._logger.error(e, exc_info=True)
-            raise e
-
-    def send(self):
-        try:
-            # if the send fails, self.to is NULL, so this needs to be saved in a local variable
-            attempted_recipient = self.to
-            self.send_success = False
-            self().Send()
-            # print(f"Mail sent to {self._recipient}")
-            self.send_success = True
-            self._logger.info(f"Mail successfully sent to {attempted_recipient}")
-        except Exception as e:
-            self._logger.error(e, exc_info=True)
-            raise e
-
-    def _ValidateResponseMsg(self):
-        if isinstance(self(), win32.CDispatch):
-            self._logger.debug("passed in msg is CDispatch instance")
-        if hasattr(self(), 'HtmlBody') or hasattr(self(), 'htmlBody'):
-            self._logger.debug("passed in msg has 'HtmlBody' or 'htmlBody' attr")
-
-        if (not isinstance(self(), win32.CDispatch)
-                or not hasattr(self(), ('HtmlBody' or 'htmlBody'))):
-            raise AttributeError("msg attr must have 'HtmlBody' attr AND be a CDispatch instance")
-        return self()
-
-    def _msg_is_recent(self, recent_days_cap=1):
-        if self.received_time is not None:
-            abs_diff = abs(self.received_time - datetime.datetime.now(tz=self.received_time.tzinfo))
-            return abs_diff <= datetime.timedelta(days=recent_days_cap)
-        print(f"msg with subject \'{self.email_item.Subject}\' has no received time. defaulting to false")
-        self._logger.debug(f"msg with subject \'{self.email_item.Subject}\' has no received time. defaulting to false")
-        return False
-
-    def return_as_failed_send(self):
-        return FailedMsg(self())
-
-
-class FailedMsg(Msg):
-    ERR_SKIP_STRING = "err {}: skipping this message"
-    DEFAULT_TEMP_SAVE_PATH = gettempdir()
-
-    def _message_filter_checks(self, **kwargs) -> bool:
-        recent_days_cap = kwargs.get('recent_days_cap', 1)
-        return self._msg_is_recent(recent_days_cap)
-
-    def _fetch_failed_msg_details(self, **kwargs):
-        temp_attachment_save_path = kwargs.get('temp_attachment_save_path',
-                                               self.__class__.DEFAULT_TEMP_SAVE_PATH)
-        try:
-            attachment_msg_path = self.SaveAllEmailAttachments(temp_attachment_save_path)
-            print('saved_attachments')
-        except Exception as e:
-            self._logger.warning(self.__class__.ERR_SKIP_STRING.format(f'({e})'))
-            return e
-        if len(attachment_msg_path) == 1:
-            return next(iter(attachment_msg_path))
-        return attachment_msg_path
-
-    def process_failed_msg(self, post_master_msg, **kwargs):
-        recent_days_cap = kwargs.get('recent_days_cap', 1)
-        try:
-            self.email_item = post_master_msg
-            self._ValidateResponseMsg()
-        except AttributeError as e:
-            self._logger.warning(self.__class__.ERR_SKIP_STRING.format(f'({e})'))
-            return e, None, None
-
-        if self._msg_is_recent(recent_days_cap):
-            attachment_msg = self._fetch_failed_msg_details()
-            if isinstance(attachment_msg, Exception):
-                return attachment_msg, None, None
-            else:
-                if isinstance(attachment_msg, str):
-                    fmd = _FailedMessageDetails.extract_msg_from_attachment(attachment_msg)
-                    return fmd.process_failed_details_msg() #self._process_failed_details_msg(attachment_msg)
-        return None, None, None
-
-
-class _FailedMessageDetails(FailedMsg):
-    @classmethod
-    def extract_msg_from_attachment(cls, parent_msg: str):
-        return cls(extract_msg.Message(parent_msg))
-
-    def _extract_from_failed_details_msg(self, para):
-        email_of_err = para.findNext('p').get_text().strip().split('(')[0].strip()
-        err_reason = para.findNext('p').findNext('p').get_text()
-        send_time = self().date.ctime()
-        failed_subject = self.subject
-
-        err_details = {'email_of_err': email_of_err, 'err_reason': err_reason,
-                       'send_time': send_time, 'failed_subject': failed_subject}
-        # print(f"Email of err: {email_of_err},\nErr reason: {err_reason}\nSend time: {send_time}")
-        return err_details #email_of_err, err_reason, send_time
-
-    def process_failed_details_msg(self, **kwargs):
-        detail_marker_string = kwargs.get('detail_marker_string',
-                                          "Delivery has failed to these recipients or groups:")
-
-        soup = BeautifulSoup(self.body, features="html.parser")
-
-        all_p = soup.find_all(name='p')  # , attrs={'class': 'MsoNormal'})
-
-        for para in all_p:
-            if detail_marker_string in para.get_text():
-                return {** self._extract_from_failed_details_msg(para)}
-        return None, None, None

pyemailerajm-1.6/PyEmailerAJM.egg-info/requires.txt

@@ -1 +0,0 @@
-pywin32