@remit/mailbox-service 0.0.111 → 0.0.113

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (298) hide show
  1. package/dist/account-credentials.d.ts +83 -0
  2. package/dist/account-credentials.js +104 -0
  3. package/dist/attribute-mapper.d.ts +36 -0
  4. package/dist/attribute-mapper.js +119 -0
  5. package/dist/body-parse.d.ts +28 -0
  6. package/{src/body-parse.ts → dist/body-parse.js} +18 -26
  7. package/dist/body-part-mapper.d.ts +92 -0
  8. package/dist/body-part-mapper.js +301 -0
  9. package/dist/body-sync-queue.d.ts +59 -0
  10. package/dist/body-sync-queue.js +56 -0
  11. package/dist/body-sync-terminal.d.ts +58 -0
  12. package/dist/body-sync-terminal.js +95 -0
  13. package/dist/body-sync.d.ts +351 -0
  14. package/dist/body-sync.js +1204 -0
  15. package/dist/calendar-parts.d.ts +23 -0
  16. package/dist/calendar-parts.js +18 -0
  17. package/dist/classification-backfill.d.ts +91 -0
  18. package/dist/classification-backfill.js +180 -0
  19. package/dist/classify-message.d.ts +31 -0
  20. package/dist/classify-message.js +89 -0
  21. package/dist/connection-factory.d.ts +54 -0
  22. package/dist/connection-factory.js +54 -0
  23. package/dist/connection-test.d.ts +41 -0
  24. package/dist/connection-test.js +152 -0
  25. package/dist/external-move.d.ts +94 -0
  26. package/dist/external-move.js +173 -0
  27. package/dist/filter-operations.d.ts +42 -0
  28. package/dist/filter-operations.js +211 -0
  29. package/dist/filters/filter-config.d.ts +14 -0
  30. package/dist/filters/filter-config.js +10 -0
  31. package/{src/filters/list-id.ts → dist/filters/list-id.d.ts} +2 -16
  32. package/dist/filters/list-id.js +26 -0
  33. package/dist/filters/match.d.ts +69 -0
  34. package/dist/filters/match.js +165 -0
  35. package/dist/filters/pipeline.d.ts +64 -0
  36. package/dist/filters/pipeline.js +100 -0
  37. package/{src/flag-push-terminal.ts → dist/flag-push-terminal.d.ts} +19 -77
  38. package/dist/flag-push-terminal.js +63 -0
  39. package/dist/flag-push.d.ts +69 -0
  40. package/dist/flag-push.js +111 -0
  41. package/dist/flag-queue.d.ts +175 -0
  42. package/dist/flag-queue.js +291 -0
  43. package/dist/folder-operations.d.ts +39 -0
  44. package/dist/folder-operations.js +112 -0
  45. package/dist/folder-placement.d.ts +13 -0
  46. package/dist/folder-placement.js +23 -0
  47. package/dist/heuristics/authenticationResults.d.ts +10 -0
  48. package/dist/heuristics/authenticationResults.js +187 -0
  49. package/dist/heuristics/classifyByHeaders.d.ts +82 -0
  50. package/dist/heuristics/classifyByHeaders.js +365 -0
  51. package/dist/heuristics/classifyPlacement.d.ts +67 -0
  52. package/dist/heuristics/classifyPlacement.js +153 -0
  53. package/dist/heuristics/machineSenders.d.ts +21 -0
  54. package/{src/heuristics/machineSenders.ts → dist/heuristics/machineSenders.js} +34 -40
  55. package/dist/heuristics/senderMismatch.d.ts +81 -0
  56. package/dist/heuristics/senderMismatch.js +192 -0
  57. package/dist/heuristics/socialDomains.d.ts +14 -0
  58. package/{src/heuristics/socialDomains.ts → dist/heuristics/socialDomains.js} +9 -9
  59. package/dist/heuristics/transactionalDomains.d.ts +18 -0
  60. package/{src/heuristics/transactionalDomains.ts → dist/heuristics/transactionalDomains.js} +8 -8
  61. package/dist/imapflow-connection.d.ts +377 -0
  62. package/dist/imapflow-connection.js +1147 -0
  63. package/dist/index.d.ts +63 -0
  64. package/dist/index.js +65 -0
  65. package/dist/list-id-backfill.d.ts +83 -0
  66. package/dist/list-id-backfill.js +132 -0
  67. package/dist/mailbox-cursor-rebuild.d.ts +74 -0
  68. package/dist/mailbox-cursor-rebuild.js +71 -0
  69. package/{src/mailbox-cursor.ts → dist/mailbox-cursor.d.ts} +20 -98
  70. package/dist/mailbox-cursor.js +102 -0
  71. package/dist/mailbox-intent.d.ts +41 -0
  72. package/{src/mailbox-intent.ts → dist/mailbox-intent.js} +39 -63
  73. package/dist/mailbox-management.d.ts +240 -0
  74. package/dist/mailbox-management.js +576 -0
  75. package/dist/mailbox-presence.d.ts +52 -0
  76. package/{src/mailbox-presence.ts → dist/mailbox-presence.js} +19 -30
  77. package/dist/mailbox-queue.d.ts +126 -0
  78. package/dist/mailbox-queue.js +214 -0
  79. package/dist/mailbox-sync.d.ts +93 -0
  80. package/dist/mailbox-sync.js +490 -0
  81. package/dist/mailbox-upstream.d.ts +38 -0
  82. package/{src/mailbox-upstream.ts → dist/mailbox-upstream.js} +37 -47
  83. package/dist/message-category.d.ts +51 -0
  84. package/{src/message-category.ts → dist/message-category.js} +28 -71
  85. package/dist/message-move.d.ts +285 -0
  86. package/dist/message-move.js +858 -0
  87. package/dist/message-parser.d.ts +14 -0
  88. package/dist/message-parser.js +17 -0
  89. package/{src/message-presence.ts → dist/message-presence.d.ts} +1 -13
  90. package/dist/message-presence.js +29 -0
  91. package/dist/message-read.d.ts +51 -0
  92. package/dist/message-read.js +31 -0
  93. package/dist/message-sync.d.ts +345 -0
  94. package/dist/message-sync.js +1358 -0
  95. package/dist/mime-walker.d.ts +102 -0
  96. package/dist/mime-walker.js +198 -0
  97. package/dist/organize-job.d.ts +20 -0
  98. package/dist/organize-job.js +37 -0
  99. package/dist/outbox-attachment-content.d.ts +37 -0
  100. package/dist/outbox-attachment-content.js +50 -0
  101. package/dist/outbox-attachment-filename.d.ts +19 -0
  102. package/dist/outbox-attachment-filename.js +64 -0
  103. package/dist/outbox-attachment.d.ts +148 -0
  104. package/dist/outbox-attachment.js +273 -0
  105. package/dist/outbox-queue.d.ts +73 -0
  106. package/dist/outbox-queue.js +284 -0
  107. package/{src/outbox-status.ts → dist/outbox-status.d.ts} +1 -6
  108. package/dist/outbox-status.js +18 -0
  109. package/dist/ownership.d.ts +24 -0
  110. package/dist/ownership.js +83 -0
  111. package/dist/placement-move-terminal.d.ts +67 -0
  112. package/dist/placement-move-terminal.js +88 -0
  113. package/dist/placement-move.d.ts +83 -0
  114. package/dist/placement-move.js +216 -0
  115. package/{src/placement-settled.ts → dist/placement-settled.d.ts} +19 -50
  116. package/dist/placement-settled.js +75 -0
  117. package/dist/quarantine.d.ts +95 -0
  118. package/dist/quarantine.js +131 -0
  119. package/dist/refusal.d.ts +31 -0
  120. package/dist/refusal.js +3 -0
  121. package/{src/restore-source-placement.ts → dist/restore-source-placement.d.ts} +29 -101
  122. package/dist/restore-source-placement.js +79 -0
  123. package/dist/search-text-backfill.d.ts +15 -0
  124. package/dist/search-text-backfill.js +33 -0
  125. package/dist/snippet.d.ts +61 -0
  126. package/dist/snippet.js +129 -0
  127. package/dist/spam-report.d.ts +86 -0
  128. package/dist/spam-report.js +241 -0
  129. package/dist/sync-warning.d.ts +21 -0
  130. package/dist/sync-warning.js +26 -0
  131. package/dist/sync-watermarks.d.ts +138 -0
  132. package/dist/sync-watermarks.js +205 -0
  133. package/dist/test-helpers/fake-imap.d.ts +151 -0
  134. package/dist/test-helpers/fake-imap.js +508 -0
  135. package/dist/test-helpers/folder-roles.d.ts +34 -0
  136. package/dist/test-helpers/folder-roles.js +47 -0
  137. package/dist/test-helpers/mime-tree-generator.d.ts +82 -0
  138. package/dist/test-helpers/mime-tree-generator.js +329 -0
  139. package/dist/test-helpers/test-store.d.ts +69 -0
  140. package/dist/test-helpers/test-store.js +193 -0
  141. package/dist/text/normalizer.d.ts +20 -0
  142. package/dist/text/normalizer.js +102 -0
  143. package/dist/thread-message-rows.d.ts +69 -0
  144. package/dist/thread-message-rows.js +40 -0
  145. package/dist/thread-root.d.ts +7 -0
  146. package/dist/thread-root.js +25 -0
  147. package/dist/types.d.ts +343 -0
  148. package/dist/types.js +19 -0
  149. package/package.json +86 -73
  150. package/src/account-credentials.ts +0 -210
  151. package/src/adversarial-mime.e2e.test.ts +0 -307
  152. package/src/attribute-mapper.test.ts +0 -104
  153. package/src/attribute-mapper.ts +0 -148
  154. package/src/body-parse.test.ts +0 -55
  155. package/src/body-part-mapper.property.test.ts +0 -354
  156. package/src/body-part-mapper.ts +0 -360
  157. package/src/body-sync-auto-read-writeonce.test.ts +0 -219
  158. package/src/body-sync-calendar-suggestion.test.ts +0 -433
  159. package/src/body-sync-category-denormalize.test.ts +0 -352
  160. package/src/body-sync-category-override.test.ts +0 -501
  161. package/src/body-sync-category-writeonce.test.ts +0 -234
  162. package/src/body-sync-filter.test.ts +0 -237
  163. package/src/body-sync-message-gone.test.ts +0 -139
  164. package/src/body-sync-placement-flags.test.ts +0 -347
  165. package/src/body-sync-placement-writeonce.test.ts +0 -337
  166. package/src/body-sync-quarantine.test.ts +0 -276
  167. package/src/body-sync-queue.test.ts +0 -124
  168. package/src/body-sync-queue.ts +0 -131
  169. package/src/body-sync-resync.test.ts +0 -605
  170. package/src/body-sync-terminal.test.ts +0 -310
  171. package/src/body-sync-terminal.ts +0 -176
  172. package/src/body-sync-unclassifiable-once.test.ts +0 -260
  173. package/src/body-sync-unsubscribed-auto-read.test.ts +0 -176
  174. package/src/body-sync.ts +0 -1970
  175. package/src/calendar-parts.ts +0 -41
  176. package/src/classification-backfill.test.ts +0 -615
  177. package/src/classification-backfill.ts +0 -363
  178. package/src/classify-message.test.ts +0 -205
  179. package/src/classify-message.ts +0 -116
  180. package/src/connection-factory.ts +0 -102
  181. package/src/connection-test.ts +0 -208
  182. package/src/credentials.test.ts +0 -181
  183. package/src/external-move.test.ts +0 -369
  184. package/src/external-move.ts +0 -272
  185. package/src/filters/anchor-drift.ts +0 -55
  186. package/src/filters/filter-config.test.ts +0 -229
  187. package/src/filters/filter-config.ts +0 -69
  188. package/src/filters/list-id.test.ts +0 -50
  189. package/src/filters/match.test.ts +0 -429
  190. package/src/filters/match.ts +0 -274
  191. package/src/filters/message-embedder.test.ts +0 -39
  192. package/src/filters/message-embedder.ts +0 -33
  193. package/src/filters/pipeline.test.ts +0 -330
  194. package/src/filters/pipeline.ts +0 -284
  195. package/src/flag-push-terminal.test.ts +0 -209
  196. package/src/flag-push.test.ts +0 -408
  197. package/src/flag-push.ts +0 -198
  198. package/src/flag-queue-stars.test.ts +0 -171
  199. package/src/flag-queue.ts +0 -509
  200. package/src/folder-placement.ts +0 -56
  201. package/src/heuristics/authenticationResults.test.ts +0 -189
  202. package/src/heuristics/authenticationResults.ts +0 -212
  203. package/src/heuristics/classifyByHeaders.test.ts +0 -889
  204. package/src/heuristics/classifyByHeaders.ts +0 -467
  205. package/src/heuristics/classifyPlacement.test.ts +0 -366
  206. package/src/heuristics/classifyPlacement.ts +0 -211
  207. package/src/heuristics/classifyRealMail.test.ts +0 -242
  208. package/src/heuristics/machineSenders.test.ts +0 -101
  209. package/src/heuristics/senderMismatch.test.ts +0 -346
  210. package/src/heuristics/senderMismatch.ts +0 -259
  211. package/src/imapflow-connect-retry.test.ts +0 -134
  212. package/src/imapflow-connection.e2e.test.ts +0 -335
  213. package/src/imapflow-connection.integ.test.ts +0 -316
  214. package/src/imapflow-connection.test.ts +0 -469
  215. package/src/imapflow-connection.ts +0 -1475
  216. package/src/index.ts +0 -350
  217. package/src/list-id-backfill.test.ts +0 -573
  218. package/src/list-id-backfill.ts +0 -274
  219. package/src/mailbox-cursor-rebuild.test.ts +0 -171
  220. package/src/mailbox-cursor-rebuild.ts +0 -146
  221. package/src/mailbox-cursor.test.ts +0 -249
  222. package/src/mailbox-delete-intent.test.ts +0 -246
  223. package/src/mailbox-management.test.ts +0 -356
  224. package/src/mailbox-management.ts +0 -839
  225. package/src/mailbox-presence.test.ts +0 -72
  226. package/src/mailbox-queue.ts +0 -415
  227. package/src/mailbox-rename-intent.test.ts +0 -389
  228. package/src/mailbox-rename-subtree.test.ts +0 -664
  229. package/src/mailbox-sync.test.ts +0 -848
  230. package/src/mailbox-sync.ts +0 -724
  231. package/src/message-delete-junk-reconcile.test.ts +0 -117
  232. package/src/message-delete-no-trash.test.ts +0 -245
  233. package/src/message-delete-unsettled-placement.test.ts +0 -396
  234. package/src/message-move-copy.test.ts +0 -562
  235. package/src/message-move-empty-trash.test.ts +0 -326
  236. package/src/message-move-same-mailbox.test.ts +0 -139
  237. package/src/message-move-unsettled-placement.test.ts +0 -378
  238. package/src/message-move.ts +0 -1348
  239. package/src/message-parser.ts +0 -26
  240. package/src/message-presence.test.ts +0 -50
  241. package/src/message-sync-address-spoof.test.ts +0 -293
  242. package/src/message-sync-category.test.ts +0 -142
  243. package/src/message-sync-changedsince.test.ts +0 -840
  244. package/src/message-sync-flags.test.ts +0 -158
  245. package/src/message-sync-junk-harvest.test.ts +0 -244
  246. package/src/message-sync-quarantine.test.ts +0 -416
  247. package/src/message-sync-repoint.test.ts +0 -419
  248. package/src/message-sync.ts +0 -1963
  249. package/src/mime-walker.test.ts +0 -311
  250. package/src/mime-walker.ts +0 -305
  251. package/src/outbox-attachment-content.test.ts +0 -153
  252. package/src/outbox-attachment-content.ts +0 -104
  253. package/src/outbox-attachment-filename.test.ts +0 -132
  254. package/src/outbox-attachment-filename.ts +0 -76
  255. package/src/outbox-attachment.test.ts +0 -738
  256. package/src/outbox-attachment.ts +0 -536
  257. package/src/outbox-failed-recovery.test.ts +0 -370
  258. package/src/outbox-queue-settled-row.test.ts +0 -140
  259. package/src/outbox-queue.test.ts +0 -291
  260. package/src/outbox-queue.ts +0 -508
  261. package/src/pass-through-unit-of-work.ts +0 -17
  262. package/src/placement-move-terminal.test.ts +0 -300
  263. package/src/placement-move-terminal.ts +0 -148
  264. package/src/placement-move-unsettled.test.ts +0 -275
  265. package/src/placement-move.ts +0 -336
  266. package/src/placement-settled.test.ts +0 -147
  267. package/src/placement-transition-race.test.ts +0 -482
  268. package/src/quarantine.test.ts +0 -191
  269. package/src/quarantine.ts +0 -228
  270. package/src/snippet.test.ts +0 -213
  271. package/src/snippet.ts +0 -152
  272. package/src/spam-report.test.ts +0 -801
  273. package/src/spam-report.ts +0 -357
  274. package/src/stale-message-reconcile.test.ts +0 -82
  275. package/src/stale-message-reconcile.ts +0 -55
  276. package/src/sync-watermarks.test.ts +0 -409
  277. package/src/sync-watermarks.ts +0 -319
  278. package/src/system-flag-wire-format.test.ts +0 -77
  279. package/src/test-helpers/folder-roles.ts +0 -66
  280. package/src/test-helpers/isolated-mailbox.ts +0 -44
  281. package/src/test-helpers/mailfuzz-connection.ts +0 -27
  282. package/src/test-helpers/mime-tree-generator.ts +0 -461
  283. package/src/text/normalizer.test.ts +0 -223
  284. package/src/text/normalizer.ts +0 -140
  285. package/src/thread-message-rows.ts +0 -77
  286. package/src/types/mailparser-augment.d.ts +0 -15
  287. package/src/types/natural-porter-stemmer.d.ts +0 -50
  288. package/src/types/stopword.d.ts +0 -69
  289. package/src/types.ts +0 -371
  290. package/test/fixtures/mime-adversarial-e2e/01-octet-stream-pdf.eml +0 -21
  291. package/test/fixtures/mime-adversarial-e2e/02-nested-related-cid-image.eml +0 -31
  292. package/test/fixtures/mime-adversarial-e2e/03-calendar-invite.eml +0 -33
  293. package/test/fixtures/mime-adversarial-e2e/04-forwarded-rfc822-with-attachments.eml +0 -42
  294. package/test/fixtures/mime-adversarial-e2e/05-tnef-winmail.eml +0 -25
  295. package/test/fixtures/mime-adversarial-e2e/06-8bit-non-ascii.eml +0 -15
  296. package/test/fixtures/mime-adversarial-e2e/07-quoted-printable-soft-breaks.eml +0 -17
  297. package/test/fixtures/mime-adversarial-e2e/08-alternative-empty-text.eml +0 -18
  298. package/tsconfig.json +0 -8
@@ -1,104 +0,0 @@
1
- import assert from "node:assert";
2
- import { describe, it } from "node:test";
3
- import { MailboxAttribute, MailboxSpecialUse } from "@remit/domain-enums";
4
- import {
5
- hasChildren,
6
- isNoSelect,
7
- parseImapAttributes,
8
- } from "./attribute-mapper.js";
9
-
10
- describe("parseImapAttributes special-use", () => {
11
- it("maps an IMAP \\Junk attribute to the canonical bare enum value", () => {
12
- const parsed = parseImapAttributes(["\\Junk"]);
13
- assert.deepStrictEqual(parsed.specialUse, [MailboxSpecialUse.Junk]);
14
- assert.strictEqual(parsed.specialUse[0], "Junk");
15
- });
16
-
17
- it("normalizes case-insensitive special-use attributes", () => {
18
- const parsed = parseImapAttributes(["\\junk", "\\SENT", "\\Drafts"]);
19
- assert.deepStrictEqual(parsed.specialUse, [
20
- MailboxSpecialUse.Junk,
21
- MailboxSpecialUse.Sent,
22
- MailboxSpecialUse.Drafts,
23
- ]);
24
- });
25
-
26
- it("emits every value in the bare form the runtime stores and the spec validates", () => {
27
- const parsed = parseImapAttributes([
28
- "\\All",
29
- "\\Archive",
30
- "\\Drafts",
31
- "\\Flagged",
32
- "\\Junk",
33
- "\\Sent",
34
- "\\Trash",
35
- "\\Important",
36
- ]);
37
- assert.deepStrictEqual(parsed.specialUse, [
38
- "All",
39
- "Archive",
40
- "Drafts",
41
- "Flagged",
42
- "Junk",
43
- "Sent",
44
- "Trash",
45
- "Important",
46
- ]);
47
- assert.ok(parsed.specialUse.every((v) => !v.startsWith("\\")));
48
- });
49
-
50
- it("separates standard attributes from special-use", () => {
51
- const parsed = parseImapAttributes(["\\HasChildren", "\\Sent"]);
52
- assert.deepStrictEqual(parsed.specialUse, [MailboxSpecialUse.Sent]);
53
- assert.deepStrictEqual(parsed.attributes, ["\\HasChildren"]);
54
- });
55
-
56
- it("keeps standard attributes in the RFC 9051 backslash-prefixed form", () => {
57
- const parsed = parseImapAttributes([
58
- "\\NonExistent",
59
- "\\Noinferiors",
60
- "\\Noselect",
61
- "\\HasChildren",
62
- "\\HasNoChildren",
63
- "\\Marked",
64
- "\\Unmarked",
65
- "\\Subscribed",
66
- "\\Remote",
67
- ]);
68
- assert.deepStrictEqual(parsed.attributes, [
69
- "\\NonExistent",
70
- "\\Noinferiors",
71
- "\\Noselect",
72
- "\\HasChildren",
73
- "\\HasNoChildren",
74
- "\\Marked",
75
- "\\Unmarked",
76
- "\\Subscribed",
77
- "\\Remote",
78
- ]);
79
- assert.deepStrictEqual(parsed.attributes, Object.values(MailboxAttribute));
80
- });
81
-
82
- it("collects unknown attributes without dropping them", () => {
83
- const parsed = parseImapAttributes(["\\Junk", "\\SomethingNovel"]);
84
- assert.deepStrictEqual(parsed.specialUse, [MailboxSpecialUse.Junk]);
85
- assert.deepStrictEqual(parsed.unknown, ["\\SomethingNovel"]);
86
- });
87
-
88
- it("yields no special-use for a plain folder", () => {
89
- const parsed = parseImapAttributes(["\\HasNoChildren"]);
90
- assert.deepStrictEqual(parsed.specialUse, []);
91
- });
92
- });
93
-
94
- describe("attribute predicates", () => {
95
- it("detects no-select mailboxes", () => {
96
- assert.strictEqual(isNoSelect(["\\Noselect"]), true);
97
- assert.strictEqual(isNoSelect(["\\HasChildren"]), false);
98
- });
99
-
100
- it("detects mailboxes with children", () => {
101
- assert.strictEqual(hasChildren(["\\HasChildren"]), true);
102
- assert.strictEqual(hasChildren(["\\HasNoChildren"]), false);
103
- });
104
- });
@@ -1,148 +0,0 @@
1
- /**
2
- * Maps IMAP mailbox attributes to entity enum values
3
- */
4
-
5
- import { MailboxAttribute, MailboxSpecialUse } from "@remit/domain-enums";
6
-
7
- // Type for enum values
8
- type MailboxAttributeValue =
9
- (typeof MailboxAttribute)[keyof typeof MailboxAttribute];
10
- type MailboxSpecialUseValue =
11
- (typeof MailboxSpecialUse)[keyof typeof MailboxSpecialUse];
12
-
13
- /**
14
- * Map from IMAP attribute strings to MailboxAttribute enum values.
15
- * MailboxAttribute keeps the RFC 9051 backslash prefix; MailboxSpecialUse
16
- * below is a canonical bare designation, so only that map strips it.
17
- */
18
- const ATTRIBUTE_MAP: Record<string, MailboxAttributeValue> = {
19
- "\\NonExistent": MailboxAttribute.NonExistent,
20
- "\\Noinferiors": MailboxAttribute.NoInferiors,
21
- "\\Noselect": MailboxAttribute.NoSelect,
22
- "\\HasChildren": MailboxAttribute.HasChildren,
23
- "\\HasNoChildren": MailboxAttribute.HasNoChildren,
24
- "\\Marked": MailboxAttribute.Marked,
25
- "\\Unmarked": MailboxAttribute.Unmarked,
26
- "\\Subscribed": MailboxAttribute.Subscribed,
27
- "\\Remote": MailboxAttribute.Remote,
28
- };
29
-
30
- /**
31
- * Map from IMAP special-use attribute strings to MailboxSpecialUse enum values
32
- */
33
- const SPECIAL_USE_MAP: Record<string, MailboxSpecialUseValue> = {
34
- "\\All": MailboxSpecialUse.All,
35
- "\\Archive": MailboxSpecialUse.Archive,
36
- "\\Drafts": MailboxSpecialUse.Drafts,
37
- "\\Flagged": MailboxSpecialUse.Flagged,
38
- "\\Junk": MailboxSpecialUse.Junk,
39
- "\\Sent": MailboxSpecialUse.Sent,
40
- "\\Trash": MailboxSpecialUse.Trash,
41
- "\\Important": MailboxSpecialUse.Important,
42
- };
43
-
44
- /**
45
- * Set of all known special-use attributes for quick lookup
46
- */
47
- const SPECIAL_USE_ATTRS = new Set(Object.keys(SPECIAL_USE_MAP));
48
-
49
- /**
50
- * Result of parsing IMAP attributes
51
- */
52
- export interface ParsedAttributes {
53
- /** Standard mailbox attributes */
54
- attributes: MailboxAttributeValue[];
55
- /** Special-use designations */
56
- specialUse: MailboxSpecialUseValue[];
57
- /** Unknown attributes that couldn't be mapped */
58
- unknown: string[];
59
- }
60
-
61
- /**
62
- * Parse IMAP mailbox attributes into our enum types
63
- *
64
- * IMAP attributes come as strings like "\\Noselect", "\\Drafts", etc.
65
- * This function categorizes them into:
66
- * - Standard attributes (MailboxAttribute)
67
- * - Special-use attributes (MailboxSpecialUse)
68
- * - Unknown attributes
69
- */
70
- export const parseImapAttributes = (attribs: string[]): ParsedAttributes => {
71
- const result: ParsedAttributes = {
72
- attributes: [],
73
- specialUse: [],
74
- unknown: [],
75
- };
76
-
77
- for (const attr of attribs) {
78
- // Normalize attribute (IMAP attributes are case-insensitive)
79
- const normalized = normalizeAttribute(attr);
80
-
81
- if (SPECIAL_USE_ATTRS.has(normalized)) {
82
- const specialUse = SPECIAL_USE_MAP[normalized];
83
- if (specialUse) {
84
- result.specialUse.push(specialUse);
85
- }
86
- } else if (ATTRIBUTE_MAP[normalized]) {
87
- result.attributes.push(ATTRIBUTE_MAP[normalized]);
88
- } else {
89
- result.unknown.push(attr);
90
- }
91
- }
92
-
93
- return result;
94
- };
95
-
96
- /**
97
- * Normalize an IMAP attribute to canonical form
98
- *
99
- * IMAP attributes are case-insensitive per RFC 9051.
100
- * We normalize to the canonical form used in the RFCs.
101
- */
102
- const normalizeAttribute = (attr: string): string => {
103
- // Handle common variations
104
- const lower = attr.toLowerCase();
105
-
106
- // Map common case variations to canonical form
107
- const canonicalMap: Record<string, string> = {
108
- "\\nonexistent": "\\NonExistent",
109
- "\\noinferiors": "\\Noinferiors",
110
- "\\noselect": "\\Noselect",
111
- "\\haschildren": "\\HasChildren",
112
- "\\hasnochildren": "\\HasNoChildren",
113
- "\\marked": "\\Marked",
114
- "\\unmarked": "\\Unmarked",
115
- "\\subscribed": "\\Subscribed",
116
- "\\remote": "\\Remote",
117
- "\\all": "\\All",
118
- "\\archive": "\\Archive",
119
- "\\drafts": "\\Drafts",
120
- "\\flagged": "\\Flagged",
121
- "\\junk": "\\Junk",
122
- "\\sent": "\\Sent",
123
- "\\trash": "\\Trash",
124
- "\\important": "\\Important",
125
- };
126
-
127
- return canonicalMap[lower] ?? attr;
128
- };
129
-
130
- /**
131
- * Check if an attribute indicates the mailbox cannot be selected
132
- */
133
- export const isNoSelect = (attribs: string[]): boolean => {
134
- return attribs.some((attr) => {
135
- const normalized = normalizeAttribute(attr);
136
- return normalized === "\\Noselect" || normalized === "\\NonExistent";
137
- });
138
- };
139
-
140
- /**
141
- * Check if an attribute indicates the mailbox has children
142
- */
143
- export const hasChildren = (attribs: string[]): boolean => {
144
- return attribs.some((attr) => {
145
- const normalized = normalizeAttribute(attr);
146
- return normalized === "\\HasChildren";
147
- });
148
- };
@@ -1,55 +0,0 @@
1
- /**
2
- * The boundary the whole quarantine feature rests on: a message defect is a
3
- * `BodyParseError`, everything else is not. If this type ever wraps something
4
- * that is not the parser's refusal, an outage becomes a pile of records saying
5
- * the user's mail is unreadable — and the cursor moves past it.
6
- */
7
-
8
- import assert from "node:assert/strict";
9
- import { describe, it } from "node:test";
10
- import { BodyParseError, parseMessageBody } from "./body-parse.js";
11
-
12
- const WELL_FORMED = Buffer.from(
13
- [
14
- "From: someone@example.com",
15
- "Subject: hello",
16
- "Content-Type: text/plain",
17
- "",
18
- "body",
19
- ].join("\r\n"),
20
- );
21
-
22
- describe("parseMessageBody", () => {
23
- it("returns the parsed message when the body is readable", async () => {
24
- const parsed = await parseMessageBody(WELL_FORMED);
25
- assert.equal(parsed.subject, "hello");
26
- });
27
-
28
- it("wraps a parser refusal so the catch site can attribute it", async () => {
29
- const error = await parseMessageBody(
30
- // A source the parser has to reject rather than tolerate.
31
- null as unknown as Buffer,
32
- ).then(
33
- () => null,
34
- (err: unknown) => err,
35
- );
36
-
37
- assert.ok(error instanceof BodyParseError);
38
- assert.equal(error.name, "BodyParseError");
39
- });
40
-
41
- it("names an unknown charset, because that defect is identifiable", () => {
42
- const error = new BodyParseError(new Error("Unknown charset: x-nonesuch"));
43
- assert.equal(error.failureCode, "UnknownCharset");
44
- });
45
-
46
- it("refuses to guess a code from parser prose it cannot read", () => {
47
- const error = new BodyParseError(new Error("something went sideways"));
48
- assert.equal(error.failureCode, "UnreadableBody");
49
- });
50
-
51
- it("keeps the parser's own words, which stay on screen and off a report", () => {
52
- const error = new BodyParseError(new Error("boundary never closed"));
53
- assert.equal(error.message, "boundary never closed");
54
- });
55
- });
@@ -1,354 +0,0 @@
1
- /**
2
- * Property test for the total body-part mapper (issue #395 PR C).
3
- *
4
- * Generates 10,000 random MIME trees (depth ≤ 4, mixed/alternative/related
5
- * multiparts, five leaf content types, optional filenames/contentIds,
6
- * occasional empty leaves), renders each to an `.eml`, parses it via
7
- * `simpleParser`, walks the synthetic tree into `MapperInput[]`, and runs
8
- * `mapBodyPartsToContent`.
9
- *
10
- * Per-iteration assertions:
11
- * 1. Totality — `pairs.length === leafCount`.
12
- * 2. Buffer-ness — every `pair.content` is a Buffer (never undefined/null).
13
- * 3. No-throw — wrapping the call site never escapes.
14
- * 4. PartPath cover — every leaf's `partPath` appears exactly once in `pairs`.
15
- *
16
- * Reproducibility: seed via `MAPPER_PROPERTY_SEED` env var. Defaults to
17
- * `0xC0DEC0DE` so CI runs are deterministic. The generator's per-iteration
18
- * RNG is derived from `(baseSeed ^ iterationIndex)` so a failure on
19
- * iteration `N` can be reproduced as a single-iteration run with the same
20
- * combined seed.
21
- *
22
- * Targeted property blocks below cover PR B reviewer's three gaps:
23
- * - Case-insensitive `dispositionFilename` matching.
24
- * - Negative routing: `application/octet-stream` without a filename
25
- * doesn't swallow a text/html attachment.
26
- * - Inline `cid:` casing + angle-bracket insensitivity.
27
- */
28
-
29
- import assert from "node:assert/strict";
30
- import { Buffer } from "node:buffer";
31
- import { describe, it } from "node:test";
32
- import { simpleParser } from "mailparser";
33
- import { type MapperInput, mapBodyPartsToContent } from "./body-part-mapper.js";
34
- import {
35
- createRng,
36
- generateMimeTree,
37
- type MultipartNode,
38
- renderEml,
39
- treeToBodyParts,
40
- } from "./test-helpers/mime-tree-generator.js";
41
-
42
- const DEFAULT_SEED = 0xc0dec0de;
43
- const ITERATIONS = 10_000;
44
-
45
- const parseSeed = (): number => {
46
- const raw = process.env.MAPPER_PROPERTY_SEED;
47
- if (!raw) return DEFAULT_SEED;
48
- const n = Number.parseInt(raw, 10);
49
- if (Number.isNaN(n)) {
50
- throw new Error(
51
- `MAPPER_PROPERTY_SEED is not a valid integer: ${JSON.stringify(raw)}`,
52
- );
53
- }
54
- return n | 0;
55
- };
56
-
57
- const collectLeafPaths = (parts: readonly MapperInput[]): string[] =>
58
- parts.filter((p) => !p.isMultipart).map((p) => p.partPath);
59
-
60
- describe("body-part-mapper property: random MIME trees", () => {
61
- it(`pairs every leaf for ${ITERATIONS} random trees (seed-reproducible)`, async () => {
62
- const baseSeed = parseSeed();
63
-
64
- for (let i = 0; i < ITERATIONS; i++) {
65
- const iterSeed = (baseSeed ^ i) | 0;
66
- const rng = createRng(iterSeed);
67
- const tree = generateMimeTree(rng);
68
- const eml = renderEml(tree, { seed: iterSeed });
69
- const bodyParts = treeToBodyParts(tree);
70
- const leafPaths = collectLeafPaths(bodyParts);
71
-
72
- let parsed: Awaited<ReturnType<typeof simpleParser>>;
73
- try {
74
- parsed = await simpleParser(eml);
75
- } catch (err) {
76
- // If mailparser can't parse, the generated EML is bad — surface
77
- // it loudly with the seed so we can reproduce.
78
- assert.fail(
79
- `simpleParser threw for seed=${iterSeed} (iteration ${i}): ${(err as Error).message}`,
80
- );
81
- throw err; // unreachable; satisfies the control-flow analysis below.
82
- }
83
-
84
- // Assertion 3: mapper never throws.
85
- let pairs: ReturnType<typeof mapBodyPartsToContent>;
86
- try {
87
- pairs = mapBodyPartsToContent(bodyParts, parsed);
88
- } catch (err) {
89
- assert.fail(
90
- `mapBodyPartsToContent threw for seed=${iterSeed} (iteration ${i}): ${(err as Error).message}`,
91
- );
92
- throw err; // unreachable
93
- }
94
-
95
- // Assertion 1: totality.
96
- assert.equal(
97
- pairs.length,
98
- leafPaths.length,
99
- `totality violated for seed=${iterSeed} (iteration ${i}): pairs=${pairs.length} leaves=${leafPaths.length}`,
100
- );
101
-
102
- // Assertion 2: every content is a Buffer.
103
- for (const p of pairs) {
104
- assert.ok(
105
- Buffer.isBuffer(p.content),
106
- `pair.content is not a Buffer for seed=${iterSeed} (iteration ${i}), partPath=${p.partPath}`,
107
- );
108
- }
109
-
110
- // Assertion 4: every leaf partPath appears exactly once.
111
- const seen = new Map<string, number>();
112
- for (const p of pairs)
113
- seen.set(p.partPath, (seen.get(p.partPath) ?? 0) + 1);
114
- for (const path of leafPaths) {
115
- assert.equal(
116
- seen.get(path),
117
- 1,
118
- `leaf partPath="${path}" not paired exactly once for seed=${iterSeed} (iteration ${i})`,
119
- );
120
- }
121
- }
122
- });
123
- });
124
-
125
- /* -------------------------------------------------------------------- */
126
- /* Targeted properties: PR B reviewer's three gaps */
127
- /* -------------------------------------------------------------------- */
128
-
129
- const TARGETED_ITERATIONS = 100;
130
-
131
- /**
132
- * Random-case filename matching. Generates a tree with one html leaf and
133
- * one PDF attachment whose filename has a random mix of upper/lower-case
134
- * letters. The BODYSTRUCTURE row records the filename verbatim; mailparser
135
- * preserves the same string on the attachment. The dispositionFilename
136
- * fallback must match case-insensitively (PR B's `findByFilename` lowercases
137
- * both sides). With `partId === partPath` doing structural pairing first
138
- * this looks easy — but if mailparser ever drifts on partId we want the
139
- * filename fallback to keep working.
140
- */
141
- describe("body-part-mapper property: case-insensitive filename match", () => {
142
- it("pairs a PDF leaf when the filename has random-case extension", async () => {
143
- const baseSeed = parseSeed() ^ 0xa1a1a1a1;
144
-
145
- for (let i = 0; i < TARGETED_ITERATIONS; i++) {
146
- const rng = createRng((baseSeed ^ i) | 0);
147
- const randomCase = (s: string): string =>
148
- [...s]
149
- .map((c) => (rng.bool(0.5) ? c.toUpperCase() : c.toLowerCase()))
150
- .join("");
151
- const filename = randomCase("invoice.pdf");
152
-
153
- const tree: MultipartNode = {
154
- kind: "multipart",
155
- subtype: "mixed",
156
- children: [
157
- {
158
- kind: "leaf",
159
- contentType: "text/html",
160
- bytes: Buffer.from("<p>see attached</p>", "utf8"),
161
- },
162
- {
163
- kind: "leaf",
164
- // BODYSTRUCTURE will declare octet-stream; mailparser sniffs PDF
165
- // from the filename. Filename-case insensitivity is the
166
- // load-bearing step.
167
- contentType: "application/octet-stream",
168
- bytes: Buffer.from("%PDF-fake-bytes", "utf8"),
169
- filename,
170
- disposition: "attachment",
171
- },
172
- ],
173
- };
174
-
175
- const seed = (baseSeed ^ i) | 0;
176
- const eml = renderEml(tree, { seed });
177
- const bodyParts = treeToBodyParts(tree);
178
- const parsed = await simpleParser(eml);
179
- const pairs = mapBodyPartsToContent(bodyParts, parsed);
180
-
181
- assert.equal(pairs.length, 2, `seed=${seed}: expected 2 pairs`);
182
- const pdfPair = pairs.find((p) => p.partPath === "2");
183
- assert.ok(pdfPair, `seed=${seed}: missing partPath=2 pair`);
184
- // PDF bytes (from mailparser's attachment) — must equal the rendered
185
- // leaf body, not an empty buffer and not the html bytes.
186
- assert.equal(
187
- pdfPair.content.toString("utf8"),
188
- "%PDF-fake-bytes",
189
- `seed=${seed}: PDF pair bytes mismatch (filename=${filename})`,
190
- );
191
- }
192
- });
193
- });
194
-
195
- /**
196
- * Negative routing: an `application/octet-stream` leaf with no filename
197
- * must not consume a `text/html` attachment from mailparser. With PR B's
198
- * mapper, the html leaf is routed via `parsed.html` (text-routing slot)
199
- * before the octet-stream leaf reaches the non-text pairing pipeline,
200
- * so the html bytes stay with their proper leaf.
201
- *
202
- * Shape: multipart/mixed with [html-leaf, octet-stream-leaf]. The
203
- * octet-stream has no filename, no contentId — only the positional
204
- * fallback can pair it. We assert that the octet-stream pair does NOT
205
- * receive the html body's bytes.
206
- */
207
- describe("body-part-mapper property: negative routing for octet-stream", () => {
208
- it("does not pair an unnamed octet-stream leaf with html bytes", async () => {
209
- const baseSeed = parseSeed() ^ 0xb2b2b2b2;
210
-
211
- for (let i = 0; i < TARGETED_ITERATIONS; i++) {
212
- const seed = (baseSeed ^ i) | 0;
213
- const rng = createRng(seed);
214
-
215
- const htmlBody = `<html><body><p>seed-${seed}-${randomTag(rng)}</p></body></html>`;
216
- const octetBody = `octet-${seed}-${randomTag(rng)}`;
217
-
218
- const tree: MultipartNode = {
219
- kind: "multipart",
220
- subtype: "mixed",
221
- children: [
222
- {
223
- kind: "leaf",
224
- contentType: "text/html",
225
- bytes: Buffer.from(htmlBody, "utf8"),
226
- },
227
- {
228
- kind: "leaf",
229
- contentType: "application/octet-stream",
230
- bytes: Buffer.from(octetBody, "utf8"),
231
- // no filename, no contentId, no disposition
232
- },
233
- ],
234
- };
235
-
236
- const eml = renderEml(tree, { seed });
237
- const bodyParts = treeToBodyParts(tree);
238
- const parsed = await simpleParser(eml);
239
- const pairs = mapBodyPartsToContent(bodyParts, parsed);
240
-
241
- assert.equal(pairs.length, 2, `seed=${seed}: expected 2 pairs`);
242
-
243
- const htmlPair = pairs.find((p) => p.partPath === "1");
244
- const octetPair = pairs.find((p) => p.partPath === "2");
245
- assert.ok(htmlPair, `seed=${seed}: missing html pair`);
246
- assert.ok(octetPair, `seed=${seed}: missing octet pair`);
247
-
248
- // html leaf gets the html body (text-routing slot).
249
- const htmlStr = htmlPair.content.toString("utf8");
250
- assert.ok(
251
- htmlStr.includes(`seed-${seed}-`),
252
- `seed=${seed}: html pair lost its body (got "${htmlStr.slice(0, 80)}")`,
253
- );
254
-
255
- // octet leaf must NOT contain the html body's marker.
256
- const octetStr = octetPair.content.toString("utf8");
257
- assert.ok(
258
- !octetStr.includes("<html>"),
259
- `seed=${seed}: octet pair swallowed html bytes (got "${octetStr.slice(0, 80)}")`,
260
- );
261
- }
262
- });
263
- });
264
-
265
- /**
266
- * Inline `cid:` casing + angle-bracket insensitivity. PR B's
267
- * `findByContentId` strips angle brackets and lowercases both sides, so a
268
- * BODYSTRUCTURE row with `contentId: "Logo@Example.ORG"` should still pair
269
- * with a mailparser attachment whose `cid` is `<logo@example.org>` (or any
270
- * mixed-case variant with/without brackets). We assert the image leaf
271
- * receives the image bytes — not the html ones — across random
272
- * permutations.
273
- */
274
- describe("body-part-mapper property: cid casing + angle-bracket insensitivity", () => {
275
- it("pairs inline image with mixed-case bracketed contentId", async () => {
276
- const baseSeed = parseSeed() ^ 0xc3c3c3c3;
277
-
278
- for (let i = 0; i < TARGETED_ITERATIONS; i++) {
279
- const seed = (baseSeed ^ i) | 0;
280
- const rng = createRng(seed);
281
-
282
- const localPart = `hero-${randomTag(rng)}`;
283
- const domain = "example.org";
284
- const baseCid = `${localPart}@${domain}`;
285
-
286
- // Random-case for the BodyPart row's contentId. Sometimes wrapped in
287
- // `< >`, sometimes not. The leaf's actual Content-ID header (rendered
288
- // into the EML) is always lower-case with angles — that's what
289
- // mailparser sees.
290
- const rowCid = (() => {
291
- const cased = [...baseCid]
292
- .map((c) => (rng.bool(0.4) ? c.toUpperCase() : c.toLowerCase()))
293
- .join("");
294
- return rng.bool(0.5) ? `<${cased}>` : cased;
295
- })();
296
-
297
- const imageBytes = Buffer.from(`png-${seed}-${randomTag(rng)}`, "utf8");
298
-
299
- const tree: MultipartNode = {
300
- kind: "multipart",
301
- subtype: "related",
302
- children: [
303
- {
304
- kind: "leaf",
305
- contentType: "text/html",
306
- bytes: Buffer.from(`<img src="cid:${baseCid}">`, "utf8"),
307
- },
308
- {
309
- kind: "leaf",
310
- contentType: "image/png",
311
- bytes: imageBytes,
312
- contentId: baseCid, // leaf header always normalised; mailparser sees this
313
- disposition: "inline",
314
- },
315
- ],
316
- };
317
-
318
- const eml = renderEml(tree, { seed });
319
- // Swap the row's contentId for the random-cased / bracketed variant —
320
- // simulating what BODYSTRUCTURE might persist after a sloppy sender.
321
- // MapperInput rows are typed as readonly via `Pick<BodyPartItem,...>`
322
- // so we rebuild the row rather than mutating in place.
323
- const bodyParts = treeToBodyParts(tree).map((row) =>
324
- row.mediaType === "IMAGE" ? { ...row, contentId: rowCid } : row,
325
- );
326
- const imageRow = bodyParts.find((p) => p.mediaType === "IMAGE");
327
- assert.ok(imageRow, `seed=${seed}: missing image row in body parts`);
328
-
329
- const parsed = await simpleParser(eml);
330
- const pairs = mapBodyPartsToContent(bodyParts, parsed);
331
-
332
- assert.equal(pairs.length, 2, `seed=${seed}: expected 2 pairs`);
333
-
334
- const imagePair = pairs.find((p) => p.partPath === "2");
335
- assert.ok(imagePair, `seed=${seed}: missing image pair`);
336
- assert.equal(
337
- imagePair.content.toString("utf8"),
338
- imageBytes.toString("utf8"),
339
- `seed=${seed}: image pair did not receive image bytes (rowCid=${rowCid})`,
340
- );
341
- }
342
- });
343
- });
344
-
345
- /* -------------------------------------------------------------------- */
346
- /* Helpers */
347
- /* -------------------------------------------------------------------- */
348
-
349
- const randomTag = (rng: { int: (n: number) => number }): string => {
350
- const letters = "abcdefghijklmnopqrstuvwxyz";
351
- let s = "";
352
- for (let i = 0; i < 6; i++) s += letters[rng.int(letters.length)];
353
- return s;
354
- };