Refactor IMAP service functions to use parameter objects for better readability and maintainability

Signed-off-by: Shahm Najeeb <Shahm_Najeeb@outlook.com>

Author: DefinetlyNotAI

app/api/accounts/[accountId]/emails/[uid]/attachments/[partId]/route.ts

@@ -64,7 +64,12 @@ export async function GET(
         }
 
         // Get attachment
-        const attachment = await getAttachment(accountId, folder, uidNum, partId)
+        const attachment = await getAttachment({
+            accountId,
+            folderPath: folder,
+            uid: uidNum,
+            partId
+        })
 
         if (!attachment) {
             return NextResponse.json(

app/api/accounts/[accountId]/emails/[uid]/route.ts

@@ -86,7 +86,11 @@ export async function GET(request: NextRequest, {params}: { params: Promise<{ ac
         }
 
         // Get email
-        const email = await getEmail(accountId, folder, uidNum)
+        const email = await getEmail({
+            accountId,
+            folderPath: folder,
+            uid: uidNum
+        })
 
         if (!email) {
             return NextResponse.json(

app/api/accounts/[accountId]/emails/route.ts

@@ -75,7 +75,11 @@ export async function GET(request: NextRequest, {params}: { params: Promise<{ ac
         }
 
         // Get emails
-        const result = await listEmails(accountId, folder, {limit, offset})
+        const result = await listEmails({
+            accountId,
+            folderPath: folder,
+            options: {limit, offset}
+        })
 
         return NextResponse.json(
             result,

lib/imap-service.ts

@@ -14,7 +14,7 @@ import Imap from "imap"
 import {simpleParser} from "mailparser"
 import {getAccountById} from "./imap-config"
 import DOMPurify from "isomorphic-dompurify"
-import {EmailCount, EmailDetail, EmailFolder} from "@/types";
+import {EmailCount, EmailDetail, EmailFolder, GetAttachmentParams, GetEmailParams, ListEmailsParams} from "@/types";
 import {FolderSettings} from "./settings"
 
 /**
@@ -189,11 +189,8 @@ export async function listFolders(accountId: string): Promise<EmailFolder[]> {
  * List emails in a folder with pagination
  * Returns emails in reverse chronological order (newest first)
  */
-export async function listEmails(
-    accountId: string,
-    folderPath: string,
-    options: { limit?: number; offset?: number } = {},
-): Promise<EmailCount> {
+export async function listEmails(params: ListEmailsParams): Promise<EmailCount> {
+    const {accountId, folderPath, options = {}} = params
     let imap: Imap | null = null
 
     try {
@@ -307,7 +304,8 @@ export async function listEmails(
 /**
  * Get full email details including body
  */
-export async function getEmail(accountId: string, folderPath: string, uid: number): Promise<EmailDetail | null> {
+export async function getEmail(params: GetEmailParams): Promise<EmailDetail | null> {
+    const {accountId, folderPath, uid} = params
     let imap: Imap | null = null
 
     try {
@@ -436,12 +434,11 @@ export async function getEmail(accountId: string, folderPath: string, uid: numbe
  * Get email attachment
  * Returns the decoded attachment content from the parsed email
  */
-export async function getAttachment(
-    accountId: string,
-    folderPath: string,
-    uid: number,
-    partId: string
-): Promise<{ content: Buffer; contentType: string } | null> {
+export async function getAttachment(params: GetAttachmentParams): Promise<{
+    content: Buffer;
+    contentType: string
+} | null> {
+    const {accountId, folderPath, uid, partId} = params
     let imap: Imap | null = null
 
     try {

todo

@@ -1,4 +1,3 @@
-imap-service should have all input types for functions be a proper indexed @/type
 Many settings.ts are unused, please make them properly used
 Change the bcrypt to be base64(bcrypt), where the env file contains a base64 encoded string, and the runtime decodes the base64 to get the bcrypt hash
 Change setup-password to setup-env where it also runs 'openssl rand -base64 32' and also asks if you want to update/change imap config, which if yes allows a notepad to open with a temp.json file, which the user can edit, once it is complete it is then closed by user where the program transforms it into 1 line and puts in env var (the temp json must be the already existing env variable but formatted)

types/index.ts

@@ -103,4 +103,29 @@ export interface CacheItem<T> {
     data: T
     timestamp: number
     ttl: number
-}
+}
+
+// IMAP Service Function Parameter Types
+export interface ListEmailsOptions {
+    limit?: number
+    offset?: number
+}
+
+export interface GetEmailParams {
+    accountId: string
+    folderPath: string
+    uid: number
+}
+
+export interface GetAttachmentParams {
+    accountId: string
+    folderPath: string
+    uid: number
+    partId: string
+}
+
+export interface ListEmailsParams {
+    accountId: string
+    folderPath: string
+    options?: ListEmailsOptions
+}