PyEmailerAJM 1.8.2__tar.gz → 1.8.4__tar.gz

{pyemailerajm-1.8.2 → pyemailerajm-1.8.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: PyEmailerAJM
-Version: 1.8.2
+Version: 1.8.4
 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.8.2.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.8.4.tar.gz
 Author: Amcsparron
 Author-email: amcsparron@albanyny.gov
 License: MIT License

{pyemailerajm-1.8.2 → pyemailerajm-1.8.4}/PyEmailerAJM/__init__.py

@@ -1,9 +1,4 @@
-from pathlib import Path
 from importlib import import_module
-# TODO: add these to other projects? and or EasyLogger?
-__project_root__ = Path(__file__).parent.parent
-__project_name__ = __project_root__.name
-print(f'logs for {__project_name__} found in {__project_root__ / "logs"}')
 
 
 def is_instance_of_dynamic(obj: object, base_class_path: str) -> bool:
@@ -29,5 +24,5 @@ from PyEmailerAJM.continuous_monitor.continuous_monitor import ContinuousMonitor
 __all__ = ['EmailerNotSetupError', 'DisplayManualQuit', 'deprecated',
            'Msg', 'FailedMsg', 'PyEmailer', 'EmailerInitializer',
            'BaseSearcher', 'SubjectSearcher', 'ContinuousMonitor',
-           '__project_root__', '__project_name__', 'is_instance_of_dynamic']
+           'is_instance_of_dynamic']
 

pyemailerajm-1.8.4/PyEmailerAJM/_version.py

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

{pyemailerajm-1.8.2 → pyemailerajm-1.8.4}/PyEmailerAJM/backend/logger.py

@@ -1,10 +1,8 @@
 from logging import Filter, DEBUG, ERROR, Handler, FileHandler, StreamHandler, Logger, WARNING
-from pathlib import Path
 from typing import Union
 
 from EasyLoggerAJM import EasyLogger, OutlookEmailHandler, StreamHandlerIgnoreExecInfo
 from PyEmailerAJM.msg import Msg
-from PyEmailerAJM import __project_name__, __project_root__
 
 
 class DupeDebugFilter(Filter):
@@ -31,8 +29,6 @@ class DupeDebugFilter(Filter):
 
 
 class PyEmailerLogger(EasyLogger):
-    ROOT_LOG_LOCATION_DEFAULT = Path(__project_root__, 'logs').resolve()
-
     def __call__(self):
         return self.logger
 
@@ -56,11 +52,12 @@ class PyEmailerLogger(EasyLogger):
         :return: None
         :rtype: None
         """
+        email_handler_class = kwargs.get('email_handler_class', OutlookEmailHandler)
         # noinspection PyTypeChecker
-        OutlookEmailHandler.VALID_EMAIL_MSG_TYPES = [Msg]
+        email_handler_class.VALID_EMAIL_MSG_TYPES = [Msg]
         try:
             # noinspection PyTypeChecker
-            email_handler = OutlookEmailHandler(email_msg=kwargs.get('email_msg', None),
+            email_handler = email_handler_class(email_msg=kwargs.get('email_msg', None),
                                                 project_name=self.project_name,
                                                 logger_dir_path=self.log_location,
                                                 recipient=kwargs.get('logger_admins', None))
@@ -78,16 +75,6 @@ class PyEmailerLogger(EasyLogger):
     def _add_filter_to_stream_handler(self, handler: StreamHandler):
         self._add_dupe_debug_to_handler(handler)
 
-    @property
-    def project_name(self):
-        return super().project_name
-
-    @project_name.setter
-    def project_name(self, value):
-        if value is None:
-            value = __project_name__
-        super().__setattr__('_project_name', value)
-
     def create_stream_handler(self, log_level_to_stream=WARNING, **kwargs):
         stream_handler = kwargs.get('stream_handler_instance', StreamHandlerIgnoreExecInfo())
         super().create_stream_handler(log_level_to_stream=log_level_to_stream,

{pyemailerajm-1.8.2 → pyemailerajm-1.8.4}/PyEmailerAJM/py_emailer_ajm.py

@@ -30,6 +30,15 @@ from PyEmailerAJM.searchers import SubjectSearcher
 
 
 class EmailerInitializer:
+    """
+        A class responsible for initializing and handling email-related operations through a specified
+        email application and namespace. The class uses COM (Component Object Model) to interact with
+        the email application and provides mechanisms for logging and email management.
+
+        Attributes:
+            DEFAULT_EMAIL_APP_NAME (str): Default application name for email, set to 'outlook.application'.
+            DEFAULT_NAMESPACE_NAME (str): Default namespace name for the email application, set to 'MAPI'.
+    """
     DEFAULT_EMAIL_APP_NAME = 'outlook.application'
     DEFAULT_NAMESPACE_NAME = 'MAPI'
 
@@ -80,6 +89,40 @@ class EmailerInitializer:
 
 
 class PyEmailer(EmailerInitializer, SubjectSearcher):
+    """
+    The `PyEmailer` class is designed for managing and handling email-related operations.
+    It initializes email client settings, manages email folders, handles email messages,
+    and supports common email-related functionalities such as tracking, setting up emails,
+    and saving attachments.
+    The class extends functionality from `EmailerInitializer` and `SubjectSearcher`.
+
+    Attributes:
+    - `tab_char`: Specifies the tab character to be used.
+    - `signature_dir_path`: Defines the file path to the email signature directory.
+    - `DisplayEmailSendTrackingWarning`: Warning message displayed when email tracking cannot ensure delivery success.
+    - `FAILED_SEND_LOGGER_STRING`: Format string for logging failed email sends.
+    - `DEFAULT_TEMP_SAVE_PATH`: Default temporary directory for saving temporary files.
+    - `VALID_EMAIL_FOLDER_CHOICES`: List of valid folder indices for email directories.
+
+    Methods:
+    - `__init__`: Initializes an instance of the `PyEmailer` class with specified settings and optional arguments.
+    - `current_user_email`: Getter and setter for retrieving or setting the current user's email address.
+    - `email_signature`: Property that retrieves the email signature from a specified signature file.
+    - `send_success`: Getter and setter to track the send status of an email.
+    - `_display_tracking_warning_confirm`: Handles display and confirmation of email tracking warnings interactively.
+    - `display_tracker_check`: Prompts the user to confirm understanding of the email tracking warning; raises an exception if canceled.
+    - `_get_default_folder_for_email_dir`: Retrieves the default folder for a specified email directory index.
+    - `_GetReadFolder`: Helper method that retrieves the specified email folder or default folder, along with an optional subfolder.
+    - `GetMessages`: Retrieves messages from a specified folder or the currently set folder.
+    - `GetEmailMessageBody`: Deprecated method to retrieve the body of an email message; use the `Msg` class's `body` attribute instead.
+    - `FindMsgBySubject`: Deprecated method to search for messages by subject; use `find_messages_by_subject`.
+    - `SaveAllEmailAttachments`: Saves all attachments of a specified email to a given directory path.
+    - `SetupEmail`: Configures an email with recipient, subject, text, and optional attachments.
+    - `_manual_send_loop`: Handles an interactive loop to allow the manual sending of an email.
+
+    This class provides comprehensive methods and attributes for streamlining email-related workflows.
+    It emphasizes interaction, logging, and error handling for robust functionality.
+    """
     # the email tab_char
     tab_char = ' '
     signature_dir_path = join((environ['USERPROFILE']),

{pyemailerajm-1.8.2 → pyemailerajm-1.8.4}/PyEmailerAJM/searchers/searchers.py

@@ -48,6 +48,8 @@ class BaseSearcher:
             if msg:
                 matched_messages.append(msg)
                 continue
+        self.logger.info(f"{len(matched_messages)} messages found!")#, print_msg=True)
+        self.logger.info("Search Complete, returning Msg's")
         return [m() for m in matched_messages]
 
     def _search_for_match(self, normalized_search_str: str, message: CDispatch, normalized_message_attr: str,

{pyemailerajm-1.8.2 → pyemailerajm-1.8.4}/PyEmailerAJM.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: PyEmailerAJM
-Version: 1.8.2
+Version: 1.8.4
 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.8.2.tar.gz
+Download-URL: https://github.com/amcsparron2793-Water/PyEmailer/archive/refs/tags/1.8.4.tar.gz
 Author: Amcsparron
 Author-email: amcsparron@albanyny.gov
 License: MIT License

pyemailerajm-1.8.2/PyEmailerAJM/_version.py

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