(20241203) Mails sync'ing, listing, and fetching done.

models/data/mail/retrieve.py

@@ -6,11 +6,11 @@
 
     DATE:
 
-        Monday, 2nd Dec., 2024.
+        Tuesday, 3rd Dec., 2024.
 
     OBJECTIVE:
 
-        To provide the structure for the request that will come in to sync the mails of a particular user.
+        To provide a structure to query the full payload of an email.
 
     REFERENCES:
 
@@ -75,7 +75,7 @@ REGEX_SESSION_TOKEN = r"^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]
 #   *****************************************************************************************************************
 
 
-class MailSyncRequestHeaders(BaseModel):
+class MailGetRequestHeaders(BaseModel):
 
     sessionToken: str = Field(
         description = "the session token of the user who is requesting the service",
@@ -99,114 +99,13 @@ class MailSyncRequestHeaders(BaseModel):
 # ---------------------------------------------------------------------------------------------------------------------
 
 
-class MailSyncRequestData(BaseModel):
+class MailGetRequestData(BaseModel):
 
-    accountId: str = Field(
-        description = "the account identifier (Mongo ObjectId) granted by 'MailOAuthModel.get_account_identifier'",
+    mailId: str = Field(
+        description = "the mail identifier (Mongo ObjectId) of the document that holds the mail",
         frozen = True
     )
 
-    maxCount: int = Field(
-        description = "the max. no. of e-mails to sync at a given time",
-        default = 100,
-        ge = 1,
-        le = 100,
-        frozen = True
-    )
-
-    startDate: PastDatetime = Field(
-        description = "the starting date from which the user wants to sync their mail",
-        default_factory = lambda: date_time.get_current_utc_date_time() - datetime.timedelta(days = 1),
-        frozen = True
-    )
-
-    endDate: PastDatetime = Field(
-        description = "the ending date till which the user wants to sync their mail",
-        default_factory = lambda: date_time.get_current_utc_date_time() - datetime.timedelta(seconds = 1),
-        frozen = True
-    )
-
-    forceSync: bool = Field(
-        description = "use this to forcefully re-sync mails when you need to overwrite existing data in mongodb",
-        default = False
-    )
-
-    # ┏┓    ┏•
-    # ┃ ┏┓┏┓╋┓┏┓
-    # ┗┛┗┛┛┗┛┗┗┫
-    #          ┛
-
-    class Config:
-        extra = "forbid"
-
-    # ┓┏  ┓• ┓   •
-    # ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
-    # ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗
-
-    @field_validator("startDate", "endDate", mode = "before")
-    def to_datetime(cls, value):
-        if not isinstance(value, datetime.datetime):
-            value = date_time.parse_date_time(
-                input_value = value,
-                timezone = date_time.TIMEZONE_UTC
-            )
-        return value
-
-
-# ---------------------------------------------------------------------------------------------------------------------
-
-
-class MailSyncOneResult(BaseModel):
-
-    success: bool = Field(
-        description = "whether, or not, the mail was successfully sync'd",
-        default = False
-    )
-
-    message: str | None = Field(
-        description = "a brief message to summarize the result of the process",
-        default = None
-    )
-
-    mailMessage: dict | None = Field(
-        description = "the actual data of the mail; can be null in a successful process if the mail is already sync'd",
-        default = None
-    )
-
-    # ┏┓    ┏•
-    # ┃ ┏┓┏┓╋┓┏┓
-    # ┗┛┗┛┛┗┛┗┗┫
-    #          ┛
-
-    class Config:
-        extra = "forbid"
-
-
-# ---------------------------------------------------------------------------------------------------------------------
-
-
-class MailSyncManyResults(BaseModel):
-
-    totalCount: int = Field(
-        description = "the total no. of mails that were to be sync'd",
-        default = 0
-    )
-
-    successCount: int = Field(
-        description = "the no. of mails that were successfully sync'd",
-        default = 0
-    )
-
-    failureCount: int = Field(
-        description = "the no. of mails that were successfully sync'd",
-        default = 0
-    )
-
-    message: str = Field(
-        description = "a brief message to summarize the results of the process",
-        default = None
-    )
-
     # ┏┓    ┏•
     # ┃ ┏┓┏┓╋┓┏┓
     # ┗┛┗┛┛┗┛┗┗┫