@remit/mailbox-service 0.0.63 → 0.0.65

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/mailbox-service",
-  "version": "0.0.63",
+  "version": "0.0.65",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -25,9 +25,6 @@
     "test:e2e": "RUN_E2E_TESTS=1 node --env-file=../../localhost-test-e2e.env --import tsx --test --test-concurrency=1 'src/**/*.e2e.test.ts'",
     "test": "npm run test:typecheck && npm run test:run"
   },
-  "devDependencies": {
-    "@types/uuid": "^10.0.0"
-  },
   "dependencies": {
     "imapflow": "^1.3.3",
     "mailparser": "^3.9.14",

package/src/adversarial-mime.e2e.test.ts

@@ -16,8 +16,8 @@
  * 8-bit UTF-8 bodies, empty text/plain alternatives) — the same class of shape
  * that caused the body-sync regression in #394.
  *
- * Mapper unit-level defence lives in `test/fixtures/mime/`; this suite is the
- * integration-layer belt-and-braces against the same regression class.
+ * Mapper unit-level defence lives in `body-part-mapper.property.test.ts`; this
+ * suite is the integration-layer belt-and-braces against the same class.
  */
 
 import assert from "node:assert/strict";

package/src/mailbox-sync.test.ts

@@ -342,6 +342,152 @@ describe("MailboxSyncService.syncMailboxes — reconcile does not delete pending
 	});
 });
 
+describe("MailboxSyncService.syncMailboxes — a lookalike is not a folder the user keeps mail in (#837)", () => {
+	const namespaces: ImapNamespaces = {
+		personal: [{ prefix: "", delimiter: "/" }],
+		other: [],
+		shared: [],
+	};
+
+	const serverConnection = (
+		folders: Array<{ fullPath: string; attributes: string[] }>,
+	): IImapConnection =>
+		({
+			getNamespaces: async () => namespaces,
+			listMailboxes: async () =>
+				folders.map((folder) => ({
+					fullPath: folder.fullPath,
+					name: folder.fullPath.split("/").pop() ?? folder.fullPath,
+					delimiter: "/",
+					attributes: folder.attributes,
+					parentPath: null,
+				})),
+			getMailboxStatus: async () => ({
+				messages: 0,
+				recent: 0,
+				unseen: 0,
+				uidNext: 1,
+				uidValidity: 1,
+				highestModseq: "0",
+				deletedCount: 0,
+			}),
+		}) as unknown as IImapConnection;
+
+	const buildServices = (
+		existing: Array<{ mailboxId: string; fullPath: string }>,
+	) => {
+		const deleted: string[] = [];
+		const mailboxService = {
+			listByAccount: async () => ({
+				items: existing.map((m) => ({
+					mailboxId: m.mailboxId,
+					fullPath: m.fullPath,
+					uidNext: 1,
+					uidValidity: 1,
+					messageCount: 0,
+					unseenCount: 0,
+					deletedCount: 0,
+					highestModseq: "0",
+					specialUse: undefined,
+					syncStatus: MailboxSyncStatus.synced,
+				})),
+				continuationToken: undefined,
+			}),
+			update: async () => ({}),
+			delete: async (_accountId: string, mailboxId: string) => {
+				deleted.push(mailboxId);
+			},
+			create: async () => ({}),
+		} as unknown as IMailboxRepository;
+
+		const specialUseService = {
+			listByMailboxId: async () => [],
+			deleteByMailboxId: async () => undefined,
+			createMany: async () => undefined,
+		} as unknown as IMailboxSpecialUseRepository;
+
+		return { mailboxService, specialUseService, deleted };
+	};
+
+	const syncWith = async (
+		folders: Array<{ fullPath: string; attributes: string[] }>,
+		existing: Array<{ mailboxId: string; fullPath: string }>,
+	): Promise<string[]> => {
+		const { mailboxService, specialUseService, deleted } =
+			buildServices(existing);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
+		await service.syncMailboxes(
+			{ accountId: "acc-1" },
+			serverConnection(folders),
+		);
+		return deleted;
+	};
+
+	it("keeps a folder called Deleted beside the folder the server flagged", async () => {
+		// `deleted` and `bin` were Trash names in this file's own copy of the hint
+		// table long after #843 dropped them from the shared one. Every sync of an
+		// account holding a flagged Trash and a user folder called `Deleted` took
+		// the user's folder, and its mail, out of the client.
+		const deleted = await syncWith(
+			[
+				{ fullPath: "INBOX", attributes: [] },
+				{ fullPath: "Trash", attributes: ["\\Trash"] },
+				{ fullPath: "Deleted", attributes: [] },
+				{ fullPath: "Bin", attributes: [] },
+			],
+			[
+				{ mailboxId: "inbox", fullPath: "INBOX" },
+				{ mailboxId: "trash", fullPath: "Trash" },
+				{ mailboxId: "keepsakes", fullPath: "Deleted" },
+				{ mailboxId: "bin", fullPath: "Bin" },
+			],
+		);
+
+		assert.deepEqual(deleted, []);
+	});
+
+	it("still hides the unflagged twin of a folder the server flagged", async () => {
+		const deleted = await syncWith(
+			[
+				{ fullPath: "INBOX", attributes: [] },
+				{ fullPath: "[Gmail]/Trash", attributes: ["\\Trash"] },
+				{ fullPath: "Trash", attributes: [] },
+			],
+			[
+				{ mailboxId: "inbox", fullPath: "INBOX" },
+				{ mailboxId: "gmail-trash", fullPath: "[Gmail]/Trash" },
+				{ mailboxId: "lookalike", fullPath: "Trash" },
+			],
+		);
+
+		assert.deepEqual(deleted, ["lookalike"]);
+	});
+
+	it("keeps a folder that holds a role of its own", async () => {
+		// `all mail` is a conventional name for Archive as well as for All, and the
+		// account already has a flagged Archive. The folder holds the All role, so
+		// it is a folder in its own right rather than a lookalike of Archive.
+		const deleted = await syncWith(
+			[
+				{ fullPath: "INBOX", attributes: [] },
+				{ fullPath: "Archive", attributes: ["\\Archive"] },
+				{ fullPath: "INBOX/All Mail", attributes: [] },
+			],
+			[
+				{ mailboxId: "inbox", fullPath: "INBOX" },
+				{ mailboxId: "archive", fullPath: "Archive" },
+				{ mailboxId: "all-mail", fullPath: "INBOX/All Mail" },
+			],
+		);
+
+		assert.deepEqual(deleted, []);
+	});
+});
+
 /**
  * The folder set can also change under a running sweep: a delete asked for while
  * the account is enumerating lands between the LIST and one folder's STATUS.

package/src/mailbox-sync.ts

@@ -10,9 +10,15 @@ import type {
 	IMailboxSpecialUseRepository,
 	MailboxItem,
 } from "@remit/data-ports";
+import {
+	CANONICAL_ROLES,
+	type CanonicalMailboxRoleValue,
+	ROLE_NAME_HINTS,
+	ROLE_SPECIAL_USE,
+} from "@remit/data-ports/folder-role";
 import {
 	MailboxCursorState,
-	MailboxSpecialUse,
+	type MailboxSpecialUse,
 	MailboxSyncStatus,
 	NamespaceType,
 } from "@remit/domain-enums";
@@ -51,23 +57,27 @@ const areSpecialUseSetsEqual = (
 };
 
 /**
- * Map common folder names to their expected special-use designation.
- * Used to detect duplicate folders (e.g., "Trash" vs "[Gmail]/Trash").
+ * The role a folder's own leaf name is most conventionally for, read from the
+ * one hint table every special-folder lookup shares (`@remit/data-ports`,
+ * #837). A name that several roles list goes to the role that ranks it highest,
+ * so `All Mail` is an All folder rather than a lookalike of Archive.
+ *
+ * A second copy of these names lived here, and it is the one that could destroy
+ * something: it still called `Deleted` and `Bin` Trash names, which #843 dropped
+ * precisely because they are ordinary folders a user keeps mail in — and this
+ * lookup does not merely skip a folder, it deletes the row and everything the
+ * client can see in it.
  */
-const FOLDER_NAME_TO_SPECIAL_USE: Record<string, MailboxSpecialUseValue> = {
-	trash: MailboxSpecialUse.Trash,
-	"deleted items": MailboxSpecialUse.Trash,
-	deleted: MailboxSpecialUse.Trash,
-	bin: MailboxSpecialUse.Trash,
-	drafts: MailboxSpecialUse.Drafts,
-	draft: MailboxSpecialUse.Drafts,
-	sent: MailboxSpecialUse.Sent,
-	"sent items": MailboxSpecialUse.Sent,
-	"sent mail": MailboxSpecialUse.Sent,
-	junk: MailboxSpecialUse.Junk,
-	spam: MailboxSpecialUse.Junk,
-	archive: MailboxSpecialUse.Archive,
-	archives: MailboxSpecialUse.Archive,
+const roleForFolderName = (
+	name: string,
+): CanonicalMailboxRoleValue | undefined => {
+	let best: { role: CanonicalMailboxRoleValue; rank: number } | undefined;
+	for (const role of CANONICAL_ROLES) {
+		const rank = ROLE_NAME_HINTS[role]?.indexOf(name) ?? -1;
+		if (rank < 0) continue;
+		if (!best || rank < best.rank) best = { role, rank };
+	}
+	return best?.role;
 };
 
 /**
@@ -451,8 +461,8 @@ export class MailboxSyncService {
 
 		const mailbox = await this.mailboxService.create(input);
 
-		// Keep the MailboxSpecialUseEntry table in sync — other services (e.g.
-		// MessageMoveService.findTrashMailbox) still query by entry. Denormalized
+		// Keep the MailboxSpecialUseEntry table in sync — every backend and worker
+		// special-folder lookup reads it through MailboxSpecialUseRepo. Denormalized
 		// copy on Mailbox is the read-side optimization, the entries remain the
 		// authoritative join source for cross-mailbox lookups.
 		if (parsed.specialUse.length > 0) {
@@ -653,21 +663,28 @@ export class MailboxSyncService {
 		const folderName = mailbox.fullPath.split(mailbox.delimiter).pop() ?? "";
 		const normalizedName = folderName.toLowerCase();
 
-		// Check if this folder name maps to a special-use designation
-		const expectedSpecialUse = FOLDER_NAME_TO_SPECIAL_USE[normalizedName];
-		if (!expectedSpecialUse) {
+		// Check if this folder name is a conventional name for a role
+		const role = roleForFolderName(normalizedName);
+		if (!role) {
 			return false; // Not a special-use folder name
 		}
 
+		const expectedSpecialUse = ROLE_SPECIAL_USE[role];
+		if (!expectedSpecialUse) {
+			return false; // The role has no SPECIAL-USE flag to be a duplicate of
+		}
+
 		// Check if this mailbox has the special-use attribute
 		const parsed = parseImapAttributes(mailbox.attributes);
-		if (parsed.specialUse.includes(expectedSpecialUse)) {
+		if (parsed.specialUse.some((use) => use === expectedSpecialUse)) {
 			return false; // This IS the canonical folder
 		}
 
 		// Check if another folder already claimed this special-use
-		const claimedPath = claimedSpecialUse.get(expectedSpecialUse);
-		if (!claimedPath) {
+		const claimed = [...claimedSpecialUse].find(
+			([specialUse]) => specialUse === expectedSpecialUse,
+		);
+		if (!claimed) {
 			return false; // No other folder has this special-use
 		}
 
@@ -675,7 +692,7 @@ export class MailboxSyncService {
 		this.log.debug(
 			{
 				fullPath: mailbox.fullPath,
-				claimedPath,
+				claimedPath: claimed[1],
 				specialUse: expectedSpecialUse,
 			},
 			"Skipping duplicate folder",

package/test/fixtures/mime/01-flat-text-plain.bodyparts.json

@@ -1,8 +0,0 @@
-[
-  {
-    "partPath": "0",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "plain"
-  }
-]

package/test/fixtures/mime/01-flat-text-plain.eml

@@ -1,10 +0,0 @@
-From: alice@example.org
-To: bob@example.org
-Subject: Flat text/plain fixture 01
-Date: Thu, 28 May 2026 09:00:00 +0000
-Message-Id: <fixture-01@example.org>
-MIME-Version: 1.0
-Content-Type: text/plain; charset=us-ascii
-Content-Transfer-Encoding: 7bit
-
-Hello bob, this is a flat text/plain message.

package/test/fixtures/mime/01-flat-text-plain.expected.json

@@ -1,10 +0,0 @@
-{
-  "pairs": [
-    {
-      "partPath": "0",
-      "contentType": "text/plain",
-      "contentSha256": "55ac4ab155dd2b05e3d4ffb422c6fc2539484dfb07c7b5b5fac1d0035ac1f6db",
-      "contentLength": 46
-    }
-  ]
-}

package/test/fixtures/mime/02-flat-text-html.bodyparts.json

@@ -1,8 +0,0 @@
-[
-  {
-    "partPath": "0",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "html"
-  }
-]

package/test/fixtures/mime/02-flat-text-html.eml

@@ -1,10 +0,0 @@
-From: alice@example.org
-To: bob@example.org
-Subject: Flat text/html fixture 02
-Date: Thu, 28 May 2026 09:00:00 +0000
-Message-Id: <fixture-02@example.org>
-MIME-Version: 1.0
-Content-Type: text/html; charset=us-ascii
-Content-Transfer-Encoding: 7bit
-
-<html><body><p>Hello bob, this is a flat <b>text/html</b> message.</p></body></html>

package/test/fixtures/mime/02-flat-text-html.expected.json

@@ -1,10 +0,0 @@
-{
-  "pairs": [
-    {
-      "partPath": "0",
-      "contentType": "text/html",
-      "contentSha256": "4484f960dbbb61e252b8ac3dd516a3c651a90ed666781befe67c6e13d30f3b4e",
-      "contentLength": 85
-    }
-  ]
-}

package/test/fixtures/mime/03-alternative-text-html.bodyparts.json

@@ -1,20 +0,0 @@
-[
-  {
-    "partPath": "0",
-    "isMultipart": true,
-    "mediaType": "MULTIPART",
-    "mediaSubtype": "alternative"
-  },
-  {
-    "partPath": "1",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "plain"
-  },
-  {
-    "partPath": "2",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "html"
-  }
-]

package/test/fixtures/mime/03-alternative-text-html.eml

@@ -1,19 +0,0 @@
-From: alice@example.org
-To: bob@example.org
-Subject: Alternative text+html fixture 03
-Date: Thu, 28 May 2026 09:00:00 +0000
-Message-Id: <fixture-03@example.org>
-MIME-Version: 1.0
-Content-Type: multipart/alternative; boundary="=_boundary_03_="
-
---=_boundary_03_=
-Content-Type: text/plain; charset=us-ascii
-Content-Transfer-Encoding: 7bit
-
-Hello bob, plain text body.
---=_boundary_03_=
-Content-Type: text/html; charset=us-ascii
-Content-Transfer-Encoding: 7bit
-
-<html><body><p>Hello bob, html body.</p></body></html>
---=_boundary_03_=--

package/test/fixtures/mime/03-alternative-text-html.expected.json

@@ -1,16 +0,0 @@
-{
-  "pairs": [
-    {
-      "partPath": "1",
-      "contentType": "text/plain",
-      "contentSha256": "54178e683cea517723189e2851efd8449bac73f2b57c50bd81a0c8a6df4ce7c8",
-      "contentLength": 27
-    },
-    {
-      "partPath": "2",
-      "contentType": "text/html",
-      "contentSha256": "71744f8d83087de2acde32d5b9ec93ecfe1b5ba677f760655643dabfd0ce661d",
-      "contentLength": 54
-    }
-  ]
-}

package/test/fixtures/mime/04-mixed-html-pdf-attachment.bodyparts.json

@@ -1,22 +0,0 @@
-[
-  {
-    "partPath": "0",
-    "isMultipart": true,
-    "mediaType": "MULTIPART",
-    "mediaSubtype": "mixed"
-  },
-  {
-    "partPath": "1",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "html"
-  },
-  {
-    "partPath": "2",
-    "isMultipart": false,
-    "mediaType": "APPLICATION",
-    "mediaSubtype": "pdf",
-    "dispositionFilename": "invoice.pdf",
-    "disposition": "attachment"
-  }
-]

package/test/fixtures/mime/04-mixed-html-pdf-attachment.eml

@@ -1,20 +0,0 @@
-From: alice@example.org
-To: bob@example.org
-Subject: Mixed html + pdf fixture 04
-Date: Thu, 28 May 2026 09:00:00 +0000
-Message-Id: <fixture-04@example.org>
-MIME-Version: 1.0
-Content-Type: multipart/mixed; boundary="=_boundary_04_="
-
---=_boundary_04_=
-Content-Type: text/html; charset=us-ascii
-Content-Transfer-Encoding: 7bit
-
-<html><body><p>See attached invoice.</p></body></html>
---=_boundary_04_=
-Content-Type: application/pdf; name="invoice.pdf"
-Content-Transfer-Encoding: base64
-Content-Disposition: attachment; filename="invoice.pdf"
-
-JVBERi0xLjQKJWZha2UgcGRmIGZvciBmaXh0dXJlIDA0CiVFT0YK
---=_boundary_04_=--

package/test/fixtures/mime/04-mixed-html-pdf-attachment.expected.json

@@ -1,16 +0,0 @@
-{
-  "pairs": [
-    {
-      "partPath": "1",
-      "contentType": "text/html",
-      "contentSha256": "d8d4d207e4f8d121a1d60fe74922da8b562ebada6a4a58b2d0f2b1bcac2ae5d7",
-      "contentLength": 54
-    },
-    {
-      "partPath": "2",
-      "contentType": "application/pdf",
-      "contentSha256": "1e82c5ee13ccddf36b4abc368c682a08ed1bc5671101c76062183c8e9914fb41",
-      "contentLength": 39
-    }
-  ]
-}

package/test/fixtures/mime/05-mixed-html-octet-stream-pdf.bodyparts.json

@@ -1,22 +0,0 @@
-[
-  {
-    "partPath": "0",
-    "isMultipart": true,
-    "mediaType": "MULTIPART",
-    "mediaSubtype": "mixed"
-  },
-  {
-    "partPath": "1",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "html"
-  },
-  {
-    "partPath": "2",
-    "isMultipart": false,
-    "mediaType": "APPLICATION",
-    "mediaSubtype": "octet-stream",
-    "dispositionFilename": "contract.pdf",
-    "disposition": "attachment"
-  }
-]

package/test/fixtures/mime/05-mixed-html-octet-stream-pdf.eml

@@ -1,21 +0,0 @@
-From: alice@example.org
-To: bob@example.org
-Subject: Mixed html + octet-stream PDF fixture 05 (Odido bug)
-Date: Thu, 28 May 2026 09:00:00 +0000
-Message-Id: <fixture-05@example.org>
-MIME-Version: 1.0
-Content-Type: multipart/mixed; boundary="=_boundary_05_="
-
---=_boundary_05_=
-Content-Type: text/html; charset=us-ascii
-Content-Transfer-Encoding: 7bit
-
-<html><body><p>Your contract PDF is attached.</p></body></html>
---=_boundary_05_=
-Content-Type: application/octet-stream; name="contract.pdf"
-Content-Transfer-Encoding: base64
-Content-Disposition: attachment; filename="contract.pdf"
-
-JVBERi0xLjQKJWZha2UgcGRmIGZvciBmaXh0dXJlIDA1IG9jdGV0LXN0cmVhbQol
-RU9GCg==
---=_boundary_05_=--

package/test/fixtures/mime/05-mixed-html-octet-stream-pdf.expected.json

@@ -1,16 +0,0 @@
-{
-  "pairs": [
-    {
-      "partPath": "1",
-      "contentType": "text/html",
-      "contentSha256": "9fd8608290b5e5c88848e336235fbcf48d4797290c631b9f73bb9f13c7ce3515",
-      "contentLength": 63
-    },
-    {
-      "partPath": "2",
-      "contentType": "application/octet-stream",
-      "contentSha256": "649331fa0bcf7487ba5529a34be1b2629f76e7906548321283d9255ad4ef53eb",
-      "contentLength": 52
-    }
-  ]
-}

package/test/fixtures/mime/06-related-html-cid-image.bodyparts.json

@@ -1,23 +0,0 @@
-[
-  {
-    "partPath": "0",
-    "isMultipart": true,
-    "mediaType": "MULTIPART",
-    "mediaSubtype": "related"
-  },
-  {
-    "partPath": "1",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "html"
-  },
-  {
-    "partPath": "2",
-    "isMultipart": false,
-    "mediaType": "IMAGE",
-    "mediaSubtype": "png",
-    "contentId": "logo@example.org",
-    "dispositionFilename": "logo.png",
-    "disposition": "inline"
-  }
-]

package/test/fixtures/mime/06-related-html-cid-image.eml

@@ -1,21 +0,0 @@
-From: alice@example.org
-To: bob@example.org
-Subject: Related html + cid image fixture 06
-Date: Thu, 28 May 2026 09:00:00 +0000
-Message-Id: <fixture-06@example.org>
-MIME-Version: 1.0
-Content-Type: multipart/related; boundary="=_boundary_06_="; type="text/html"
-
---=_boundary_06_=
-Content-Type: text/html; charset=us-ascii
-Content-Transfer-Encoding: 7bit
-
-<html><body><p>Inline image: <img src="cid:logo@example.org"></p></body></html>
---=_boundary_06_=
-Content-Type: image/png; name="logo.png"
-Content-Transfer-Encoding: base64
-Content-Disposition: inline; filename="logo.png"
-Content-ID: <logo@example.org>
-
-iVBORw0KGgpmaXh0dXJlMDZwbmdieXRlcw==
---=_boundary_06_=--

package/test/fixtures/mime/06-related-html-cid-image.expected.json

@@ -1,16 +0,0 @@
-{
-  "pairs": [
-    {
-      "partPath": "1",
-      "contentType": "text/html",
-      "contentSha256": "212c7f36413be9efaf441c588da97719f947a2210f76c98d05f21ad7480f1c8a",
-      "contentLength": 117
-    },
-    {
-      "partPath": "2",
-      "contentType": "image/png",
-      "contentSha256": "c5a79659b71cb6866a73f688ef63a29e163065f6dbb6aba3da932bc872e475d6",
-      "contentLength": 25
-    }
-  ]
-}

package/test/fixtures/mime/07-mixed-alternative-related-attachment.bodyparts.json

@@ -1,55 +0,0 @@
-[
-  {
-    "partPath": "0",
-    "isMultipart": true,
-    "mediaType": "MULTIPART",
-    "mediaSubtype": "mixed"
-  },
-  {
-    "partPath": "1",
-    "isMultipart": true,
-    "mediaType": "MULTIPART",
-    "mediaSubtype": "alternative"
-  },
-  {
-    "partPath": "1.1",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "plain"
-  },
-  {
-    "partPath": "1.2",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "html"
-  },
-  {
-    "partPath": "2",
-    "isMultipart": true,
-    "mediaType": "MULTIPART",
-    "mediaSubtype": "related"
-  },
-  {
-    "partPath": "2.1",
-    "isMultipart": false,
-    "mediaType": "TEXT",
-    "mediaSubtype": "html"
-  },
-  {
-    "partPath": "2.2",
-    "isMultipart": false,
-    "mediaType": "IMAGE",
-    "mediaSubtype": "png",
-    "contentId": "hero@example.org",
-    "dispositionFilename": "hero.png",
-    "disposition": "inline"
-  },
-  {
-    "partPath": "3",
-    "isMultipart": false,
-    "mediaType": "APPLICATION",
-    "mediaSubtype": "pdf",
-    "dispositionFilename": "report.pdf",
-    "disposition": "attachment"
-  }
-]