(20241203) Mail sync'ing started. You can now hit a dedicated API endpoint to trigger a mail-sync process (in the background if you want) and save the mails to your database.

models/data/mail/sync.py

@@ -101,9 +101,16 @@ class MailSyncRequestHeaders(BaseModel):
 
 class MailSyncRequestData(BaseModel):
 
+    accountId: str = Field(
+        description = "the account identifier (Mongo ObjectId) granted by 'MailOAuthModel.get_account_identifier'",
+        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
     )
 
@@ -119,6 +126,11 @@ class MailSyncRequestData(BaseModel):
         frozen = True
     )
 
+    forceSync: bool = Field(
+        description = "use this to forcefully re-sync mails when you need to overwrite existing data in mongodb",
+        default = False
+    )
+
     # ┏┓    ┏•
     # ┃ ┏┓┏┓╋┓┏┓
     # ┗┛┗┛┛┗┛┗┗┫
@@ -141,6 +153,69 @@ class MailSyncRequestData(BaseModel):
         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
+    )
+
+    # ┏┓    ┏•
+    # ┃ ┏┓┏┓╋┓┏┓
+    # ┗┛┗┛┛┗┛┗┗┫
+    #          ┛
+
+    class Config:
+        extra = "forbid"
+
+
 #   *****************************************************************************************************************
 #  *****                                                                                                          ****
 # ***                                               MAIN PROGRAM                                                    ***