@remit/mailbox-service 0.0.101 → 0.0.103

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/mailbox-service",
-  "version": "0.0.101",
+  "version": "0.0.103",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/body-sync-auto-read-writeonce.test.ts

@@ -160,7 +160,7 @@ describe("unsubscribed auto-mark-read is decided once (issue #499)", () => {
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => bodyConnection(),
 		);
 
@@ -181,7 +181,7 @@ describe("unsubscribed auto-mark-read is decided once (issue #499)", () => {
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => bodyConnection(),
 		);
 
@@ -204,7 +204,7 @@ describe("unsubscribed auto-mark-read is decided once (issue #499)", () => {
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => bodyConnection(),
 			true,
 		);

package/src/body-sync-calendar-suggestion.test.ts

@@ -346,7 +346,7 @@ const readBody = async (
 		messageId,
 		"acc-1",
 		"cfg-1",
-		"INBOX",
+		{ fullPath: "INBOX", placement: "inbox" },
 		async () => connection,
 	);
 };

package/src/body-sync-category-denormalize.test.ts

@@ -195,7 +195,7 @@ const syncBatch = (harness: Harness) =>
 		["m-1"],
 		"acc-1",
 		"cfg-1",
-		"INBOX",
+		{ fullPath: "INBOX", placement: "inbox" },
 		async () =>
 			({
 				openBox: async () => {},
@@ -212,7 +212,7 @@ const syncFromImap = (harness: Harness) =>
 		"m-1",
 		"acc-1",
 		"cfg-1",
-		"INBOX",
+		{ fullPath: "INBOX", placement: "inbox" },
 		async () =>
 			({
 				openBox: async () => {},

package/src/body-sync-category-override.test.ts

@@ -199,7 +199,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 
@@ -229,7 +229,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 
@@ -251,7 +251,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 
@@ -276,7 +276,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 
@@ -296,7 +296,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () =>
 				({
 					openBox: async () => {},
@@ -336,7 +336,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => {
 				throw new Error("an examined message must not be fetched again");
 			},
@@ -376,7 +376,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 				"m-1",
 				"acc-1",
 				"cfg-1",
-				"INBOX",
+				{ fullPath: "INBOX", placement: "inbox" },
 				async () => connection,
 			);
 
@@ -413,7 +413,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 				["m-1"],
 				"acc-1",
 				"cfg-1",
-				"INBOX",
+				{ fullPath: "INBOX", placement: "inbox" },
 				async () => connection,
 				true,
 			);
@@ -492,7 +492,7 @@ describe("Address.flags.category overrides classification at sync time (issue #2
 				"m-1",
 				"acc-1",
 				"cfg-1",
-				"INBOX",
+				{ fullPath: "INBOX", placement: "inbox" },
 				async () => connection,
 			),
 			/ProvisionedThroughputExceededException/,

package/src/body-sync-category-writeonce.test.ts

@@ -150,7 +150,7 @@ describe("Message.category survives a re-entrant classification pass", () => {
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 
@@ -188,7 +188,7 @@ describe("Message.category survives a re-entrant classification pass", () => {
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 			true,
 		);
@@ -220,7 +220,7 @@ describe("Message.category survives a re-entrant classification pass", () => {
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 

package/src/body-sync-filter.test.ts

@@ -181,7 +181,7 @@ const readBody = async (service: BodySyncService, mailboxPath = "INBOX") => {
 		"m-1",
 		"acc-1",
 		"cfg-1",
-		mailboxPath,
+		{ fullPath: mailboxPath, placement: "other" },
 		async () => connection,
 	);
 };

package/src/body-sync-placement-flags.test.ts

@@ -161,7 +161,7 @@ const readBody = async (
 		"m-1",
 		"acc-1",
 		"cfg-1",
-		mailboxPath,
+		{ fullPath: mailboxPath, placement: "other" },
 		async () => connection,
 	);
 };

package/src/body-sync-placement-writeonce.test.ts

@@ -187,7 +187,7 @@ describe("placement survives a re-entrant computePlacement pass (issue #383)", (
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 
@@ -233,7 +233,7 @@ describe("placement survives a re-entrant computePlacement pass (issue #383)", (
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 			true,
 		);
@@ -268,7 +268,7 @@ describe("placement survives a re-entrant computePlacement pass (issue #383)", (
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 
@@ -309,7 +309,7 @@ describe("placement survives a re-entrant computePlacement pass (issue #383)", (
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 		);
 

package/src/body-sync-quarantine.test.ts

@@ -162,8 +162,12 @@ const connection = () =>
 	}) as unknown as IImapConnection;
 
 const sync = (service: BodySyncService) =>
-	service.syncBodies(["m-1"], "acc-1", "cfg-1", "INBOX", async () =>
-		connection(),
+	service.syncBodies(
+		["m-1"],
+		"acc-1",
+		"cfg-1",
+		{ fullPath: "INBOX", placement: "inbox" },
+		async () => connection(),
 	);
 
 const parseRefusal = () =>
@@ -258,7 +262,7 @@ describe("body sync skips what is already quarantined", () => {
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => {
 				throw new Error("a quarantined message must not be fetched again");
 			},

package/src/body-sync-resync.test.ts

@@ -275,7 +275,7 @@ describe("issue #1011: forced re-store does not re-fire standing rules", () => {
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 			true,
 		);
@@ -330,7 +330,7 @@ describe("issue #1011: forced re-store does not re-fire standing rules", () => {
 			["m-1"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 			true,
 		);
@@ -374,7 +374,7 @@ describe("issue #1011: forced re-store does not re-fire standing rules", () => {
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => noSuchKeyConn(DEMOTE_EML),
 		);
 
@@ -415,7 +415,7 @@ describe("issue #1011: forced re-store does not re-fire standing rules", () => {
 			"m-1",
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => noSuchKeyConn(INVITATION_EML),
 		);
 
@@ -569,7 +569,7 @@ describe("issue #1011: forced re-store does not re-fire standing rules", () => {
 			["m-stored", "m-new"],
 			"acc-1",
 			"cfg-1",
-			"INBOX",
+			{ fullPath: "INBOX", placement: "inbox" },
 			async () => connection,
 			true,
 		);

package/src/body-sync-unclassifiable-once.test.ts

@@ -167,8 +167,12 @@ const imapConnection = () =>
 	}) as unknown as IImapConnection;
 
 const syncPass = (harness: Harness) =>
-	harness.service.syncBodies(["m-1"], "acc-1", "cfg-1", "INBOX", async () =>
-		imapConnection(),
+	harness.service.syncBodies(
+		["m-1"],
+		"acc-1",
+		"cfg-1",
+		{ fullPath: "INBOX", placement: "inbox" },
+		async () => imapConnection(),
 	);
 
 describe("a body the classifier declined to categorize is examined once", () => {

package/src/body-sync-unsubscribed-auto-read.test.ts

@@ -129,7 +129,7 @@ const readBody = async (
 		"m-1",
 		"acc-1",
 		"cfg-1",
-		"INBOX",
+		{ fullPath: "INBOX", placement: "inbox" },
 		async () => connection,
 	);
 };

package/src/body-sync.ts

@@ -51,6 +51,7 @@ import {
 	FilterPipeline,
 } from "./filters/pipeline.js";
 import type { FlagQueueService } from "./flag-queue.js";
+import { placementOf, resolveFolderRoleMailboxes } from "./folder-placement.js";
 import {
 	classifyPlacement,
 	type FolderPlacement,
@@ -239,6 +240,11 @@ export interface StoreBodyPartContentsResult {
 
 export type ConnectionGetter = () => Promise<IImapConnection>;
 
+export interface BodySyncFolder {
+	fullPath: string;
+	placement: FolderPlacement;
+}
+
 export interface PlacementConfig {
 	mailboxSpecialUseService: IMailboxSpecialUseRepository;
 	/**
@@ -332,7 +338,7 @@ export class BodySyncService {
 	 * @param messageIds - The message IDs to sync bodies for
 	 * @param accountId - The account ID (for storage path)
 	 * @param accountConfigId - The account config ID (for thread updates)
-	 * @param mailboxPath - The IMAP mailbox path
+	 * @param folder - The IMAP mailbox path and its folder placement
 	 * @param getConnection - Function to get a (lazy) IMAP connection
 	 * @param force - Bypass the "already stored" skip guard and re-fetch every
 	 * message in this batch even though `bodyStorageKey` is already set. Set
@@ -345,13 +351,17 @@ export class BodySyncService {
 		messageIds: string[],
 		accountId: string,
 		accountConfigId: string,
-		mailboxPath: string,
+		folder: BodySyncFolder,
 		getConnection: ConnectionGetter,
 		force = false,
 	): Promise<SyncBodiesResult> {
 		const syncedMessageIds: string[] = [];
 		let skippedCount = 0;
-		const location = { accountId, accountConfigId, mailboxPath };
+		const location = {
+			accountId,
+			accountConfigId,
+			mailboxPath: folder.fullPath,
+		};
 
 		// Resolve every message up front so we can issue ONE ranged FETCH for the
 		// whole batch (the desktop-client pattern) instead of a SELECT + download
@@ -420,7 +430,7 @@ export class BodySyncService {
 		const connection = await getConnection();
 		// Single SELECT for the whole batch. openBox is idempotent, so a warm
 		// connection already on this mailbox skips the SELECT entirely.
-		await connection.openBox(mailboxPath);
+		await connection.openBox(folder.fullPath);
 
 		let connectionLost = false;
 		try {
@@ -440,6 +450,7 @@ export class BodySyncService {
 						accountId,
 						accountConfigId,
 						source,
+						folder.placement,
 						reStoredMessageIds.has(messageId),
 					);
 				} catch (error) {
@@ -628,6 +639,7 @@ export class BodySyncService {
 		accountId: string,
 		accountConfigId: string,
 		source: Readable,
+		placement: FolderPlacement,
 		isReStore: boolean,
 	): Promise<void> {
 		const toStorage = new PassThrough();
@@ -672,6 +684,7 @@ export class BodySyncService {
 			{
 				uri: ref.uri,
 			},
+			placement,
 			isReStore,
 		);
 	}
@@ -704,6 +717,7 @@ export class BodySyncService {
 		accountConfigId: string,
 		body: Buffer,
 		bodyRef: { uri: string },
+		placement: FolderPlacement,
 		/**
 		 * Whether this call is a re-store of an already-classified message
 		 * rather than a first store. The two re-entrant paths (`force: true`
@@ -767,7 +781,11 @@ export class BodySyncService {
 		// `flags.category` override when one applies (issue #299). The derived
 		// fields are folded into the single Message update below — they are NOT
 		// written here.
-		const classification = await this.classifyMessage(accountConfigId, parsed);
+		const classification = await this.classifyMessage(
+			accountConfigId,
+			parsed,
+			placement,
+		);
 
 		// Decide the placement move from the in-memory classification before the
 		// write, so its `movedByRemit` flag and audit verdict join the same
@@ -984,7 +1002,7 @@ export class BodySyncService {
 	 * @param messageId - The message ID to fetch
 	 * @param accountId - The account ID (for storage path)
 	 * @param accountConfigId - The account config ID (for thread updates)
-	 * @param mailboxPath - The IMAP mailbox path
+	 * @param folder - The IMAP mailbox path and its folder placement
 	 * @param getConnection - Function to get a (lazy) IMAP connection
 	 * @returns Parsed text and HTML content
 	 */
@@ -992,7 +1010,7 @@ export class BodySyncService {
 		messageId: string,
 		accountId: string,
 		accountConfigId: string,
-		mailboxPath: string,
+		folder: BodySyncFolder,
 		getConnection: ConnectionGetter,
 	): Promise<FetchBodyResult> {
 		const message = await this.messageService.get(messageId);
@@ -1030,14 +1048,18 @@ export class BodySyncService {
 				needsStore = true;
 				body = await this.fetchFromImap(
 					message.uid,
-					mailboxPath,
+					folder.fullPath,
 					getConnection,
 				);
 			}
 		} else {
 			// Fetch from IMAP and store
 			needsStore = true;
-			body = await this.fetchFromImap(message.uid, mailboxPath, getConnection);
+			body = await this.fetchFromImap(
+				message.uid,
+				folder.fullPath,
+				getConnection,
+			);
 		}
 
 		let parsed: ParsedMail;
@@ -1062,6 +1084,7 @@ export class BodySyncService {
 				accountConfigId,
 				body,
 				{ uri: ref.uri },
+				folder.placement,
 				message.bodyStorageKey != null,
 			);
 		} else {
@@ -1097,8 +1120,14 @@ export class BodySyncService {
 	private async classifyMessage(
 		accountConfigId: string,
 		parsed: ParsedMail,
+		placement: FolderPlacement,
 	): Promise<UpdateMessageInput & { category: ThreadMessageCategory }> {
-		return classifyParsedMessage(this.addressService, accountConfigId, parsed);
+		return classifyParsedMessage(
+			this.addressService,
+			accountConfigId,
+			parsed,
+			placement,
+		);
 	}
 
 	private async incrementInboundCount(
@@ -1458,17 +1487,12 @@ export class BodySyncService {
 		// true)`) skip the decision steps entirely, so only the pass that first
 		// stores a body ever reaches this method.
 
-		const junkMailbox =
-			await mailboxSpecialUseService.findJunkMailbox(accountId);
-		const inboxMailbox =
-			await mailboxSpecialUseService.findInboxMailbox(accountId);
-
-		const placement: FolderPlacement =
-			junkMailbox && message.mailboxId === junkMailbox.mailboxId
-				? "junk"
-				: inboxMailbox && message.mailboxId === inboxMailbox.mailboxId
-					? "inbox"
-					: "other";
+		const roleMailboxes = await resolveFolderRoleMailboxes(
+			mailboxSpecialUseService,
+			accountId,
+		);
+		const { junkMailbox, inboxMailbox } = roleMailboxes;
+		const placement = placementOf(message.mailboxId, roleMailboxes);
 
 		const fromEmail = extractPrimaryFromEmail(parsed);
 		const signals = fromEmail

package/src/classification-backfill.test.ts

@@ -13,8 +13,10 @@ import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 import type {
 	AccountConfigItem,
+	AccountItem,
 	AddressItem,
 	IAccountConfigRepository,
+	IAccountRepository,
 	IAddressRepository,
 	IMessageRepository,
 	IThreadMessageRepository,
@@ -25,8 +27,10 @@ import type {
 	UpdateThreadMessageInput,
 } from "@remit/data-ports";
 import { NotFoundError } from "@remit/data-ports/errors";
+import { DisplayNameCorrespondence } from "@remit/domain-enums";
 import type { StorageService } from "@remit/storage-service";
 import { backfillClassifications } from "./classification-backfill.js";
+import type { FolderPlacementLookup } from "./folder-placement.js";
 
 const PLAIN_EML = Buffer.from(
 	[
@@ -52,6 +56,20 @@ const LIST_EML = Buffer.from(
 	].join("\r\n"),
 );
 
+const IMPERSONATION_EML = Buffer.from(
+	[
+		"From: InfoMedics <billing@serviceupdatebank.atlassian.net>",
+		"To: me@example.com",
+		"Subject: Openstaande factuur",
+		"DKIM-Signature: v=1; a=rsa-sha256; d=atlassian.net; s=sel; b=xxx",
+		"Content-Type: text/plain",
+		"",
+		"Betaal uw factuur",
+	].join("\r\n"),
+);
+
+const JUNK_MAILBOX_ID = "mb-junk";
+
 const row = (overrides: Partial<ThreadMessageItem>): ThreadMessageItem =>
 	({
 		threadMessageId: "tm-1",
@@ -97,6 +115,8 @@ const asAccount = (accountConfigId: string): AccountConfigItem =>
 
 interface Harness {
 	accountConfigService: Pick<IAccountConfigRepository, "listAll">;
+	accountService: Pick<IAccountRepository, "listAllByAccountConfig">;
+	mailboxSpecialUseService: FolderPlacementLookup;
 	addressService: Pick<IAddressRepository, "getAddress">;
 	threadMessageService: Pick<
 		IThreadMessageRepository,
@@ -134,6 +154,20 @@ const buildHarness = (options: {
 		listAll: async () => accounts,
 	};
 
+	const accountService: Pick<IAccountRepository, "listAllByAccountConfig"> = {
+		listAllByAccountConfig: async (accountConfigId: string) => [
+			{ accountId: `account-${accountConfigId}` } as unknown as AccountItem,
+		],
+	};
+
+	const mailboxSpecialUseService: FolderPlacementLookup = {
+		findJunkMailbox: async () => ({
+			mailboxId: JUNK_MAILBOX_ID,
+			fullPath: "Junk",
+		}),
+		findInboxMailbox: async () => ({ mailboxId: "mb-1", fullPath: "INBOX" }),
+	};
+
 	const addressService = {
 		getAddress: (async () => {
 			if (options.addressFlags === undefined)
@@ -203,6 +237,8 @@ const buildHarness = (options: {
 
 	return {
 		accountConfigService,
+		accountService,
+		mailboxSpecialUseService,
 		addressService,
 		threadMessageService,
 		messageService,
@@ -237,6 +273,42 @@ describe("backfillClassifications", () => {
 		);
 	});
 
+	it("compares the sender of a Junk row the provider rated clean, and not of an inbox row", async () => {
+		const harness = buildHarness({
+			rows: [
+				row({
+					threadMessageId: "tm-junk",
+					messageId: "m-junk",
+					mailboxId: JUNK_MAILBOX_ID,
+				}),
+				row({ threadMessageId: "tm-inbox", messageId: "m-inbox" }),
+			],
+			messages: [
+				message({
+					messageId: "m-junk",
+					mailboxId: JUNK_MAILBOX_ID,
+					bodyStorageKey: "s3://m-junk",
+				}),
+				message({ messageId: "m-inbox", bodyStorageKey: "s3://m-inbox" }),
+			],
+			retrieve: async () => IMPERSONATION_EML,
+		});
+
+		await backfillClassifications(harness);
+
+		const correspondence = new Map(
+			harness.messageUpdates.map((update) => [
+				update.messageId,
+				update.input.authenticity?.displayNameCorrespondence,
+			]),
+		);
+		assert.equal(
+			correspondence.get("m-junk"),
+			DisplayNameCorrespondence.Unrelated,
+		);
+		assert.equal(correspondence.get("m-inbox"), undefined);
+	});
+
 	it("denormalizes the classifier's answer onto the thread row", async () => {
 		const harness = buildHarness({
 			rows: [row({ threadMessageId: "tm-1", messageId: "m-1" })],