Merge pull request #7 from sageteamorg/develop

Develop

CHANGELOG.md

@@ -1,3 +1,16 @@
+## Unreleased
+
+### Feat
+
+- **sage_imap**: enhance imap service
+- **IMAPMailboxService**: Add .eml file upload functionality to IMAP server
+- **sage_imap**: enhance EmailMessage dataclass
+
+### Fix
+
+- **sage_imap**: fix merge conflict
+- **utils**: add missing code on utils for previous commit
+
 ## v0.3.0 (2024-07-13)
 
 ### Feat

sage_imap/decorators.py

@@ -0,0 +1,13 @@
+from functools import wraps
+
+from sage_imap.exceptions import IMAPMailboxSelectionError
+
+
+def mailbox_selection_required(func):
+    @wraps(func)
+    def wrapper(self, *args, **kwargs):
+        if not self.current_selection:
+            raise IMAPMailboxSelectionError("No mailbox selected.")
+        return func(self, *args, **kwargs)
+
+    return wrapper

sage_imap/exceptions.py

@@ -1,9 +1,7 @@
 from typing import Optional
 
-
 class IMAPClientError(Exception):
     """Base class for all IMAP client exceptions."""
-
     status_code: int = 500
     default_detail: str = "A server error occurred."
     default_code: str = "error"
@@ -28,233 +26,175 @@ def __str__(self) -> str:
         return f"{self.detail} (Code: {self.code}, Status Code: {self.status_code})"
 
 
+# Configuration and connection errors
 class IMAPConfigurationError(IMAPClientError):
     """Exception raised for configuration errors."""
-
     status_code = 400
     default_detail = "Invalid IMAP configuration."
     default_code = "configuration_error"
 
-
 class IMAPConnectionError(IMAPClientError):
     """Exception raised for connection errors."""
-
     status_code = 502
     default_detail = "Failed to connect to IMAP server."
     default_code = "connection_error"
 
-
 class IMAPAuthenticationError(IMAPClientError):
     """Exception raised for authentication errors."""
-
     status_code = 401
     default_detail = "Failed to authenticate with IMAP server."
     default_code = "authentication_error"
 
 
+# Folder-related errors
 class IMAPFolderError(IMAPClientError):
     """Base class for IMAP folder errors."""
-
     status_code = 500
     default_detail = "A folder-related error occurred."
     default_code = "folder_error"
 
-
 class IMAPFolderOperationError(IMAPFolderError):
     """Exception raised for general folder operation errors."""
-
     status_code = 500
     default_detail = "Failed to perform folder operation."
     default_code = "folder_operation_error"
 
-
 class IMAPFolderNotFoundError(IMAPFolderError):
     """Exception raised when a folder is not found."""
-
     status_code = 404
     default_detail = "Folder not found."
     default_code = "folder_not_found_error"
 
-
 class IMAPFolderExistsError(IMAPFolderError):
     """Exception raised when a folder already exists."""
-
     status_code = 409
     default_detail = "Folder already exists."
     default_code = "folder_exists_error"
 
-
 class IMAPDefaultFolderError(IMAPFolderError):
     """Exception raised when trying to perform an operation on a default folder."""
-
     status_code = 403
     default_detail = "Operation not allowed on default folder."
     default_code = "default_folder_error"
 
 
+# Unexpected error
 class IMAPUnexpectedError(IMAPClientError):
     """Exception raised for unexpected IMAP errors."""
-
     status_code = 500
     default_detail = "An unexpected error occurred with the IMAP server."
     default_code = "unexpected_error"
 
 
+# Flag-related errors
 class IMAPFlagError(IMAPClientError):
     """Base class for IMAP flag errors."""
-
     status_code = 500
     default_detail = "A flag-related error occurred."
     default_code = "flag_error"
 
-
 class IMAPFlagOperationError(IMAPFlagError):
     """Exception raised for flag operation errors."""
-
     status_code = 500
     default_detail = "Failed to perform flag operation."
     default_code = "flag_operation_error"
 
 
+# Mailbox-related errors
 class IMAPMailboxError(IMAPClientError):
     """Base class for IMAP mailbox errors."""
-
     status_code = 500
     default_detail = "A mailbox-related error occurred."
     default_code = "mailbox_error"
 
-
 class IMAPMailboxSelectionError(IMAPMailboxError):
     """Exception raised for mailbox selection errors."""
-
     status_code = 500
     default_detail = "Failed to select mailbox."
     default_code = "mailbox_selection_error"
 
-
 class IMAPMailboxClosureError(IMAPMailboxError):
     """Exception raised for mailbox closure errors."""
-
     status_code = 500
     default_detail = "Failed to close mailbox."
     default_code = "mailbox_closure_error"
 
-
 class IMAPMailboxCheckError(IMAPMailboxError):
     """Exception raised for mailbox check errors."""
-
     status_code = 500
     default_detail = "Failed to perform mailbox check."
     default_code = "mailbox_check_error"
 
-
 class IMAPMailboxDeleteError(IMAPMailboxError):
     """Exception raised for delete errors."""
-
     status_code = 500
     default_detail = "Failed to delete email."
     default_code = "delete_error"
 
-
 class IMAPMailboxPermanentDeleteError(IMAPMailboxDeleteError):
     """Exception raised for permanent delete errors."""
-
     status_code = 500
     default_detail = "Failed to permanently delete email."
     default_code = "permanent_delete_error"
 
-
 class IMAPMailboxMoveError(IMAPMailboxError):
     """Exception raised for move errors."""
-
     status_code = 500
     default_detail = "Failed to move email."
     default_code = "move_error"
 
-
 class IMAPSearchError(IMAPMailboxError):
     """Exception raised for search errors."""
-
     status_code = 500
     default_detail = "Failed to search emails."
     default_code = "search_error"
 
-
 class IMAPMailboxSaveSentError(IMAPMailboxError):
     """Exception raised for errors while saving sent emails."""
-
     status_code = 500
     default_detail = "Failed to save sent email."
     default_code = "save_sent_error"
 
-
 class IMAPMailboxStatusError(IMAPMailboxError):
     """Exception raised for errors while getting mailbox status."""
-
     status_code = 500
     default_detail = "Failed to get mailbox status."
     default_code = "status_error"
 
-
 class IMAPMailboxFetchError(IMAPMailboxError):
     """Exception raised for fetch operation errors."""
-
     status_code = 500
     default_detail = "Failed to fetch email messages."
     default_code = "fetch_error"
 
-
-class IMAPEmptyFileError(IMAPClientError):
-    """Exception raised when the specified file is empty."""
-
-    status_code = 400
-    default_detail = "The specified file is empty."
-    default_code = "empty_file_error"
-
-class IMAPInvalidEmailDateError(IMAPClientError):
-    """Exception raised when the email does not have a valid Date header."""
-
-    status_code = 400
-    default_detail = "The email does not have a valid Date header."
-    default_code = "invalid_email_date_error"
-
 class IMAPAppendError(IMAPMailboxError):
     """Exception raised when appending to the IMAP server fails."""
-
     status_code = 500
     default_detail = "Failed to append to the IMAP server."
     default_code = "imap_append_error"
 
 class IMAPMailboxUploadError(IMAPMailboxError):
-    """Exception raised for upload file"""
-
+    """Exception raised for upload file."""
     status_code = 500
     default_detail = "Failed to upload email file."
     default_code = "upload_error"
 
+class IMAPThreadError(IMAPMailboxError):
+    """Exception raised for thread errors."""
+    status_code = 500
+    default_detail = "Thread error."
+    default_code = "thread_error"
 
-class EmailException(Exception):
-    """Custom exception for email related errors."""
-
-    status_code: int = 500
-    default_detail: str = "A server error occurred."
-    default_code: str = "error"
 
-    def __init__(
-        self,
-        detail: Optional[str] = None,
-        code: Optional[str] = None,
-        status_code: Optional[int] = None,
-    ):
-        if detail is None:
-            detail = self.default_detail
-        if code is None:
-            code = self.default_code
-        if status_code is None:
-            status_code = self.status_code
-        self.detail: str = detail
-        self.code: str = code
-        self.status_code: int = status_code
+# Other errors
+class IMAPEmptyFileError(IMAPClientError):
+    """Exception raised when the specified file is empty."""
+    status_code = 400
+    default_detail = "The specified file is empty."
+    default_code = "empty_file_error"
 
-    def __str__(self) -> str:
-        return f"{self.detail} (Code: {self.code}, Status Code: {self.status_code})"
+class IMAPInvalidEmailDateError(IMAPClientError):
+    """Exception raised when the email does not have a valid Date header."""
+    status_code = 400
+    default_detail = "The email does not have a valid Date header."
+    default_code = "invalid_email_date_error"