@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.
- package/dist/account-credentials.d.ts +83 -0
- package/dist/account-credentials.js +104 -0
- package/dist/attribute-mapper.d.ts +36 -0
- package/dist/attribute-mapper.js +119 -0
- package/dist/body-parse.d.ts +28 -0
- package/{src/body-parse.ts → dist/body-parse.js} +18 -26
- package/dist/body-part-mapper.d.ts +92 -0
- package/dist/body-part-mapper.js +301 -0
- package/dist/body-sync-queue.d.ts +59 -0
- package/dist/body-sync-queue.js +56 -0
- package/dist/body-sync-terminal.d.ts +58 -0
- package/dist/body-sync-terminal.js +95 -0
- package/dist/body-sync.d.ts +351 -0
- package/dist/body-sync.js +1204 -0
- package/dist/calendar-parts.d.ts +23 -0
- package/dist/calendar-parts.js +18 -0
- package/dist/classification-backfill.d.ts +91 -0
- package/dist/classification-backfill.js +180 -0
- package/dist/classify-message.d.ts +31 -0
- package/dist/classify-message.js +89 -0
- package/dist/connection-factory.d.ts +54 -0
- package/dist/connection-factory.js +54 -0
- package/dist/connection-test.d.ts +41 -0
- package/dist/connection-test.js +152 -0
- package/dist/external-move.d.ts +94 -0
- package/dist/external-move.js +173 -0
- package/dist/filter-operations.d.ts +42 -0
- package/dist/filter-operations.js +211 -0
- package/dist/filters/filter-config.d.ts +14 -0
- package/dist/filters/filter-config.js +10 -0
- package/{src/filters/list-id.ts → dist/filters/list-id.d.ts} +2 -16
- package/dist/filters/list-id.js +26 -0
- package/dist/filters/match.d.ts +69 -0
- package/dist/filters/match.js +165 -0
- package/dist/filters/pipeline.d.ts +64 -0
- package/dist/filters/pipeline.js +100 -0
- package/{src/flag-push-terminal.ts → dist/flag-push-terminal.d.ts} +19 -77
- package/dist/flag-push-terminal.js +63 -0
- package/dist/flag-push.d.ts +69 -0
- package/dist/flag-push.js +111 -0
- package/dist/flag-queue.d.ts +175 -0
- package/dist/flag-queue.js +291 -0
- package/dist/folder-operations.d.ts +39 -0
- package/dist/folder-operations.js +112 -0
- package/dist/folder-placement.d.ts +13 -0
- package/dist/folder-placement.js +23 -0
- package/dist/heuristics/authenticationResults.d.ts +10 -0
- package/dist/heuristics/authenticationResults.js +187 -0
- package/dist/heuristics/classifyByHeaders.d.ts +82 -0
- package/dist/heuristics/classifyByHeaders.js +365 -0
- package/dist/heuristics/classifyPlacement.d.ts +67 -0
- package/dist/heuristics/classifyPlacement.js +153 -0
- package/dist/heuristics/machineSenders.d.ts +21 -0
- package/{src/heuristics/machineSenders.ts → dist/heuristics/machineSenders.js} +34 -40
- package/dist/heuristics/senderMismatch.d.ts +81 -0
- package/dist/heuristics/senderMismatch.js +192 -0
- package/dist/heuristics/socialDomains.d.ts +14 -0
- package/{src/heuristics/socialDomains.ts → dist/heuristics/socialDomains.js} +9 -9
- package/dist/heuristics/transactionalDomains.d.ts +18 -0
- package/{src/heuristics/transactionalDomains.ts → dist/heuristics/transactionalDomains.js} +8 -8
- package/dist/imapflow-connection.d.ts +377 -0
- package/dist/imapflow-connection.js +1147 -0
- package/dist/index.d.ts +63 -0
- package/dist/index.js +65 -0
- package/dist/list-id-backfill.d.ts +83 -0
- package/dist/list-id-backfill.js +132 -0
- package/dist/mailbox-cursor-rebuild.d.ts +74 -0
- package/dist/mailbox-cursor-rebuild.js +71 -0
- package/{src/mailbox-cursor.ts → dist/mailbox-cursor.d.ts} +20 -98
- package/dist/mailbox-cursor.js +102 -0
- package/dist/mailbox-intent.d.ts +41 -0
- package/{src/mailbox-intent.ts → dist/mailbox-intent.js} +39 -63
- package/dist/mailbox-management.d.ts +240 -0
- package/dist/mailbox-management.js +576 -0
- package/dist/mailbox-presence.d.ts +52 -0
- package/{src/mailbox-presence.ts → dist/mailbox-presence.js} +19 -30
- package/dist/mailbox-queue.d.ts +126 -0
- package/dist/mailbox-queue.js +214 -0
- package/dist/mailbox-sync.d.ts +93 -0
- package/dist/mailbox-sync.js +490 -0
- package/dist/mailbox-upstream.d.ts +38 -0
- package/{src/mailbox-upstream.ts → dist/mailbox-upstream.js} +37 -47
- package/dist/message-category.d.ts +51 -0
- package/{src/message-category.ts → dist/message-category.js} +28 -71
- package/dist/message-move.d.ts +285 -0
- package/dist/message-move.js +858 -0
- package/dist/message-parser.d.ts +14 -0
- package/dist/message-parser.js +17 -0
- package/{src/message-presence.ts → dist/message-presence.d.ts} +1 -13
- package/dist/message-presence.js +29 -0
- package/dist/message-read.d.ts +51 -0
- package/dist/message-read.js +31 -0
- package/dist/message-sync.d.ts +345 -0
- package/dist/message-sync.js +1358 -0
- package/dist/mime-walker.d.ts +102 -0
- package/dist/mime-walker.js +198 -0
- package/dist/organize-job.d.ts +20 -0
- package/dist/organize-job.js +37 -0
- package/dist/outbox-attachment-content.d.ts +37 -0
- package/dist/outbox-attachment-content.js +50 -0
- package/dist/outbox-attachment-filename.d.ts +19 -0
- package/dist/outbox-attachment-filename.js +64 -0
- package/dist/outbox-attachment.d.ts +148 -0
- package/dist/outbox-attachment.js +273 -0
- package/dist/outbox-queue.d.ts +73 -0
- package/dist/outbox-queue.js +284 -0
- package/{src/outbox-status.ts → dist/outbox-status.d.ts} +1 -6
- package/dist/outbox-status.js +18 -0
- package/dist/ownership.d.ts +24 -0
- package/dist/ownership.js +83 -0
- package/dist/placement-move-terminal.d.ts +67 -0
- package/dist/placement-move-terminal.js +88 -0
- package/dist/placement-move.d.ts +83 -0
- package/dist/placement-move.js +216 -0
- package/{src/placement-settled.ts → dist/placement-settled.d.ts} +19 -50
- package/dist/placement-settled.js +75 -0
- package/dist/quarantine.d.ts +95 -0
- package/dist/quarantine.js +131 -0
- package/dist/refusal.d.ts +31 -0
- package/dist/refusal.js +3 -0
- package/{src/restore-source-placement.ts → dist/restore-source-placement.d.ts} +29 -101
- package/dist/restore-source-placement.js +79 -0
- package/dist/search-text-backfill.d.ts +15 -0
- package/dist/search-text-backfill.js +33 -0
- package/dist/snippet.d.ts +61 -0
- package/dist/snippet.js +129 -0
- package/dist/spam-report.d.ts +86 -0
- package/dist/spam-report.js +241 -0
- package/dist/sync-warning.d.ts +21 -0
- package/dist/sync-warning.js +26 -0
- package/dist/sync-watermarks.d.ts +138 -0
- package/dist/sync-watermarks.js +205 -0
- package/dist/test-helpers/fake-imap.d.ts +151 -0
- package/dist/test-helpers/fake-imap.js +508 -0
- package/dist/test-helpers/folder-roles.d.ts +34 -0
- package/dist/test-helpers/folder-roles.js +47 -0
- package/dist/test-helpers/mime-tree-generator.d.ts +82 -0
- package/dist/test-helpers/mime-tree-generator.js +329 -0
- package/dist/test-helpers/test-store.d.ts +69 -0
- package/dist/test-helpers/test-store.js +193 -0
- package/dist/text/normalizer.d.ts +20 -0
- package/dist/text/normalizer.js +102 -0
- package/dist/thread-message-rows.d.ts +69 -0
- package/dist/thread-message-rows.js +40 -0
- package/dist/thread-root.d.ts +7 -0
- package/dist/thread-root.js +25 -0
- package/dist/types.d.ts +343 -0
- package/dist/types.js +19 -0
- package/package.json +86 -73
- package/src/account-credentials.ts +0 -210
- package/src/adversarial-mime.e2e.test.ts +0 -307
- package/src/attribute-mapper.test.ts +0 -104
- package/src/attribute-mapper.ts +0 -148
- package/src/body-parse.test.ts +0 -55
- package/src/body-part-mapper.property.test.ts +0 -354
- package/src/body-part-mapper.ts +0 -360
- package/src/body-sync-auto-read-writeonce.test.ts +0 -219
- package/src/body-sync-calendar-suggestion.test.ts +0 -433
- package/src/body-sync-category-denormalize.test.ts +0 -352
- package/src/body-sync-category-override.test.ts +0 -501
- package/src/body-sync-category-writeonce.test.ts +0 -234
- package/src/body-sync-filter.test.ts +0 -237
- package/src/body-sync-message-gone.test.ts +0 -139
- package/src/body-sync-placement-flags.test.ts +0 -347
- package/src/body-sync-placement-writeonce.test.ts +0 -337
- package/src/body-sync-quarantine.test.ts +0 -276
- package/src/body-sync-queue.test.ts +0 -124
- package/src/body-sync-queue.ts +0 -131
- package/src/body-sync-resync.test.ts +0 -605
- package/src/body-sync-terminal.test.ts +0 -310
- package/src/body-sync-terminal.ts +0 -176
- package/src/body-sync-unclassifiable-once.test.ts +0 -260
- package/src/body-sync-unsubscribed-auto-read.test.ts +0 -176
- package/src/body-sync.ts +0 -1970
- package/src/calendar-parts.ts +0 -41
- package/src/classification-backfill.test.ts +0 -615
- package/src/classification-backfill.ts +0 -363
- package/src/classify-message.test.ts +0 -205
- package/src/classify-message.ts +0 -116
- package/src/connection-factory.ts +0 -102
- package/src/connection-test.ts +0 -208
- package/src/credentials.test.ts +0 -181
- package/src/external-move.test.ts +0 -369
- package/src/external-move.ts +0 -272
- package/src/filters/anchor-drift.ts +0 -55
- package/src/filters/filter-config.test.ts +0 -229
- package/src/filters/filter-config.ts +0 -69
- package/src/filters/list-id.test.ts +0 -50
- package/src/filters/match.test.ts +0 -429
- package/src/filters/match.ts +0 -274
- package/src/filters/message-embedder.test.ts +0 -39
- package/src/filters/message-embedder.ts +0 -33
- package/src/filters/pipeline.test.ts +0 -330
- package/src/filters/pipeline.ts +0 -284
- package/src/flag-push-terminal.test.ts +0 -209
- package/src/flag-push.test.ts +0 -408
- package/src/flag-push.ts +0 -198
- package/src/flag-queue-stars.test.ts +0 -171
- package/src/flag-queue.ts +0 -509
- package/src/folder-placement.ts +0 -56
- package/src/heuristics/authenticationResults.test.ts +0 -189
- package/src/heuristics/authenticationResults.ts +0 -212
- package/src/heuristics/classifyByHeaders.test.ts +0 -889
- package/src/heuristics/classifyByHeaders.ts +0 -467
- package/src/heuristics/classifyPlacement.test.ts +0 -366
- package/src/heuristics/classifyPlacement.ts +0 -211
- package/src/heuristics/classifyRealMail.test.ts +0 -242
- package/src/heuristics/machineSenders.test.ts +0 -101
- package/src/heuristics/senderMismatch.test.ts +0 -346
- package/src/heuristics/senderMismatch.ts +0 -259
- package/src/imapflow-connect-retry.test.ts +0 -134
- package/src/imapflow-connection.e2e.test.ts +0 -335
- package/src/imapflow-connection.integ.test.ts +0 -316
- package/src/imapflow-connection.test.ts +0 -469
- package/src/imapflow-connection.ts +0 -1475
- package/src/index.ts +0 -350
- package/src/list-id-backfill.test.ts +0 -573
- package/src/list-id-backfill.ts +0 -274
- package/src/mailbox-cursor-rebuild.test.ts +0 -171
- package/src/mailbox-cursor-rebuild.ts +0 -146
- package/src/mailbox-cursor.test.ts +0 -249
- package/src/mailbox-delete-intent.test.ts +0 -246
- package/src/mailbox-management.test.ts +0 -356
- package/src/mailbox-management.ts +0 -839
- package/src/mailbox-presence.test.ts +0 -72
- package/src/mailbox-queue.ts +0 -415
- package/src/mailbox-rename-intent.test.ts +0 -389
- package/src/mailbox-rename-subtree.test.ts +0 -664
- package/src/mailbox-sync.test.ts +0 -848
- package/src/mailbox-sync.ts +0 -724
- package/src/message-delete-junk-reconcile.test.ts +0 -117
- package/src/message-delete-no-trash.test.ts +0 -245
- package/src/message-delete-unsettled-placement.test.ts +0 -396
- package/src/message-move-copy.test.ts +0 -562
- package/src/message-move-empty-trash.test.ts +0 -326
- package/src/message-move-same-mailbox.test.ts +0 -139
- package/src/message-move-unsettled-placement.test.ts +0 -378
- package/src/message-move.ts +0 -1348
- package/src/message-parser.ts +0 -26
- package/src/message-presence.test.ts +0 -50
- package/src/message-sync-address-spoof.test.ts +0 -293
- package/src/message-sync-category.test.ts +0 -142
- package/src/message-sync-changedsince.test.ts +0 -840
- package/src/message-sync-flags.test.ts +0 -158
- package/src/message-sync-junk-harvest.test.ts +0 -244
- package/src/message-sync-quarantine.test.ts +0 -416
- package/src/message-sync-repoint.test.ts +0 -419
- package/src/message-sync.ts +0 -1963
- package/src/mime-walker.test.ts +0 -311
- package/src/mime-walker.ts +0 -305
- package/src/outbox-attachment-content.test.ts +0 -153
- package/src/outbox-attachment-content.ts +0 -104
- package/src/outbox-attachment-filename.test.ts +0 -132
- package/src/outbox-attachment-filename.ts +0 -76
- package/src/outbox-attachment.test.ts +0 -738
- package/src/outbox-attachment.ts +0 -536
- package/src/outbox-failed-recovery.test.ts +0 -370
- package/src/outbox-queue-settled-row.test.ts +0 -140
- package/src/outbox-queue.test.ts +0 -291
- package/src/outbox-queue.ts +0 -508
- package/src/pass-through-unit-of-work.ts +0 -17
- package/src/placement-move-terminal.test.ts +0 -300
- package/src/placement-move-terminal.ts +0 -148
- package/src/placement-move-unsettled.test.ts +0 -275
- package/src/placement-move.ts +0 -336
- package/src/placement-settled.test.ts +0 -147
- package/src/placement-transition-race.test.ts +0 -482
- package/src/quarantine.test.ts +0 -191
- package/src/quarantine.ts +0 -228
- package/src/snippet.test.ts +0 -213
- package/src/snippet.ts +0 -152
- package/src/spam-report.test.ts +0 -801
- package/src/spam-report.ts +0 -357
- package/src/stale-message-reconcile.test.ts +0 -82
- package/src/stale-message-reconcile.ts +0 -55
- package/src/sync-watermarks.test.ts +0 -409
- package/src/sync-watermarks.ts +0 -319
- package/src/system-flag-wire-format.test.ts +0 -77
- package/src/test-helpers/folder-roles.ts +0 -66
- package/src/test-helpers/isolated-mailbox.ts +0 -44
- package/src/test-helpers/mailfuzz-connection.ts +0 -27
- package/src/test-helpers/mime-tree-generator.ts +0 -461
- package/src/text/normalizer.test.ts +0 -223
- package/src/text/normalizer.ts +0 -140
- package/src/thread-message-rows.ts +0 -77
- package/src/types/mailparser-augment.d.ts +0 -15
- package/src/types/natural-porter-stemmer.d.ts +0 -50
- package/src/types/stopword.d.ts +0 -69
- package/src/types.ts +0 -371
- package/test/fixtures/mime-adversarial-e2e/01-octet-stream-pdf.eml +0 -21
- package/test/fixtures/mime-adversarial-e2e/02-nested-related-cid-image.eml +0 -31
- package/test/fixtures/mime-adversarial-e2e/03-calendar-invite.eml +0 -33
- package/test/fixtures/mime-adversarial-e2e/04-forwarded-rfc822-with-attachments.eml +0 -42
- package/test/fixtures/mime-adversarial-e2e/05-tnef-winmail.eml +0 -25
- package/test/fixtures/mime-adversarial-e2e/06-8bit-non-ascii.eml +0 -15
- package/test/fixtures/mime-adversarial-e2e/07-quoted-printable-soft-breaks.eml +0 -17
- package/test/fixtures/mime-adversarial-e2e/08-alternative-empty-text.eml +0 -18
- package/tsconfig.json +0 -8
|
@@ -0,0 +1,365 @@
|
|
|
1
|
+
import { AuthResultVerdict, MessageCategory } from "@remit/domain-enums";
|
|
2
|
+
import { parseAuthenticationResults, } from "./authenticationResults.js";
|
|
3
|
+
import { hasMachineHeader, isMachineLocalPart } from "./machineSenders.js";
|
|
4
|
+
import { SOCIAL_DOMAINS } from "./socialDomains.js";
|
|
5
|
+
import { TRANSACTIONAL_DOMAINS } from "./transactionalDomains.js";
|
|
6
|
+
/**
|
|
7
|
+
* Header-only classification. Pure function. First match wins. Falls through
|
|
8
|
+
* to `personal` so misclassification stays in the safest bucket.
|
|
9
|
+
*
|
|
10
|
+
* Rules are ordered most-specific-signal first. Two properties drive the
|
|
11
|
+
* order, and both were violated by the original table (issue #45):
|
|
12
|
+
*
|
|
13
|
+
* - A signal that identifies WHO sent the mail (calendar part, allow-listed
|
|
14
|
+
* domain) outranks a signal that only says the mail was sent in bulk.
|
|
15
|
+
* - `Precedence` and `Auto-Submitted` say "a machine sent this", which is true
|
|
16
|
+
* of nearly every newsletter, marketing blast, and platform notification.
|
|
17
|
+
* Ranking them first collapsed `newsletter`, `marketing`, `social` and
|
|
18
|
+
* `transactional` into `automated`, leaving those buckets empty.
|
|
19
|
+
*
|
|
20
|
+
* 1. `Content-Type: text/calendar` part anywhere → `transactional`
|
|
21
|
+
* 2. From-domain in TRANSACTIONAL_DOMAINS → `transactional`
|
|
22
|
+
* 3. From-domain in SOCIAL_DOMAINS → `social`
|
|
23
|
+
* 4. `List-Unsubscribe` AND `List-Id` → `newsletter`
|
|
24
|
+
* 5. `List-Unsubscribe` only → `marketing`
|
|
25
|
+
* 6. `Auto-Submitted: auto-generated|auto-replied` → `automated`
|
|
26
|
+
* 7. `Precedence: bulk|list|junk` → `automated`
|
|
27
|
+
* 8. Machine sender (no-reply local-part, `Feedback-ID`,
|
|
28
|
+
* `X-Auto-Response-Suppress`) → `automated`
|
|
29
|
+
* 9. DKIM `d=` differs from From domain → `automated`
|
|
30
|
+
* 10. fallback → `personal`
|
|
31
|
+
*/
|
|
32
|
+
export const classifyByHeaders = (parsed) => {
|
|
33
|
+
const headers = parsed.headers;
|
|
34
|
+
const lines = parsed.headerLines;
|
|
35
|
+
if (hasCalendarPart(parsed.attachments))
|
|
36
|
+
return MessageCategory.transactional;
|
|
37
|
+
const fromDomain = getFromDomain(parsed);
|
|
38
|
+
if (fromDomain && domainMatches(fromDomain, TRANSACTIONAL_DOMAINS)) {
|
|
39
|
+
return MessageCategory.transactional;
|
|
40
|
+
}
|
|
41
|
+
if (fromDomain && domainMatches(fromDomain, SOCIAL_DOMAINS)) {
|
|
42
|
+
return MessageCategory.social;
|
|
43
|
+
}
|
|
44
|
+
const hasListUnsubscribe = hasHeaderLine(lines, "list-unsubscribe");
|
|
45
|
+
const hasListId = hasHeaderLine(lines, "list-id");
|
|
46
|
+
if (hasListUnsubscribe && hasListId)
|
|
47
|
+
return MessageCategory.newsletter;
|
|
48
|
+
if (hasListUnsubscribe)
|
|
49
|
+
return MessageCategory.marketing;
|
|
50
|
+
if (matchesAutoSubmitted(headers))
|
|
51
|
+
return MessageCategory.automated;
|
|
52
|
+
if (matchesPrecedence(headers))
|
|
53
|
+
return MessageCategory.automated;
|
|
54
|
+
if (isMachineSender(parsed, lines))
|
|
55
|
+
return MessageCategory.automated;
|
|
56
|
+
if (fromDomain &&
|
|
57
|
+
pickAlignedOrFirstMismatch(extractDkimDomains(headers, lines), fromDomain)
|
|
58
|
+
.mismatch) {
|
|
59
|
+
return MessageCategory.automated;
|
|
60
|
+
}
|
|
61
|
+
return MessageCategory.personal;
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* Extract the structured authenticity signal from parsed headers.
|
|
65
|
+
*
|
|
66
|
+
* Returns a `MessageAuthenticity` when at least one DKIM-Signature header
|
|
67
|
+
* is present (a comparison was possible). Returns `null` when there are no
|
|
68
|
+
* DKIM-Signature headers so callers can omit the field entirely — absence
|
|
69
|
+
* means "no signal", not "mismatch: false".
|
|
70
|
+
*
|
|
71
|
+
* The alignment rule exactly mirrors the category heuristic (rule 7) so the
|
|
72
|
+
* structured `dkimMismatch` boolean and the `automated` category can never
|
|
73
|
+
* disagree.
|
|
74
|
+
*/
|
|
75
|
+
export const extractAuthenticity = (parsed) => {
|
|
76
|
+
const headers = parsed.headers;
|
|
77
|
+
const lines = parsed.headerLines;
|
|
78
|
+
const fromDomain = getFromDomain(parsed);
|
|
79
|
+
if (!fromDomain)
|
|
80
|
+
return null;
|
|
81
|
+
const dkimDomains = extractDkimDomains(headers, lines);
|
|
82
|
+
if (dkimDomains.length === 0)
|
|
83
|
+
return null;
|
|
84
|
+
const picked = pickAlignedOrFirstMismatch(dkimDomains, fromDomain);
|
|
85
|
+
return {
|
|
86
|
+
fromDomain,
|
|
87
|
+
dkimDomain: picked.domain ?? undefined,
|
|
88
|
+
dkimMismatch: picked.mismatch,
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
const RESULTS_BY_FAVOURABILITY = [
|
|
92
|
+
"fail",
|
|
93
|
+
"softfail",
|
|
94
|
+
"neutral",
|
|
95
|
+
"none",
|
|
96
|
+
"unrecognised",
|
|
97
|
+
"pass",
|
|
98
|
+
];
|
|
99
|
+
const VERDICT_BY_RESULT = new Map([
|
|
100
|
+
["fail", AuthResultVerdict.Fail],
|
|
101
|
+
["softfail", AuthResultVerdict.Softfail],
|
|
102
|
+
["neutral", AuthResultVerdict.Neutral],
|
|
103
|
+
["none", AuthResultVerdict.None],
|
|
104
|
+
["pass", AuthResultVerdict.Pass],
|
|
105
|
+
]);
|
|
106
|
+
const isRankedResult = (result) => RESULTS_BY_FAVOURABILITY.includes(result);
|
|
107
|
+
const rankOf = (result) => RESULTS_BY_FAVOURABILITY.indexOf(isRankedResult(result) ? result : "unrecognised");
|
|
108
|
+
const leastFavourableVerdict = (results) => {
|
|
109
|
+
if (results.length === 0)
|
|
110
|
+
return undefined;
|
|
111
|
+
const worst = Math.min(...results.map((r) => rankOf(r.result)));
|
|
112
|
+
return VERDICT_BY_RESULT.get(RESULTS_BY_FAVOURABILITY[worst]);
|
|
113
|
+
};
|
|
114
|
+
const normaliseDomain = (value) => {
|
|
115
|
+
if (value === undefined)
|
|
116
|
+
return null;
|
|
117
|
+
const domain = value.trim().toLowerCase().replace(/\.$/, "");
|
|
118
|
+
return domain.length > 0 ? domain : null;
|
|
119
|
+
};
|
|
120
|
+
const identityDomain = (value) => {
|
|
121
|
+
if (value === undefined)
|
|
122
|
+
return null;
|
|
123
|
+
const at = value.lastIndexOf("@");
|
|
124
|
+
if (at < 0)
|
|
125
|
+
return null;
|
|
126
|
+
return normaliseDomain(value.slice(at + 1));
|
|
127
|
+
};
|
|
128
|
+
const dkimSigningDomain = (result) => {
|
|
129
|
+
const signing = normaliseDomain(result.properties.get("header.d"));
|
|
130
|
+
const hasIdentity = result.properties.has("header.i");
|
|
131
|
+
const identity = identityDomain(result.properties.get("header.i"));
|
|
132
|
+
if (hasIdentity && identity === null)
|
|
133
|
+
return null;
|
|
134
|
+
if (signing === null)
|
|
135
|
+
return identity;
|
|
136
|
+
if (identity === null)
|
|
137
|
+
return signing;
|
|
138
|
+
const identityWithinSigning = identity === signing || identity.endsWith(`.${signing}`);
|
|
139
|
+
return identityWithinSigning ? signing : null;
|
|
140
|
+
};
|
|
141
|
+
const dkimResultsForFrom = (results, fromDomain) => {
|
|
142
|
+
if (!fromDomain)
|
|
143
|
+
return results;
|
|
144
|
+
const aligned = results.filter((r) => {
|
|
145
|
+
const domain = dkimSigningDomain(r);
|
|
146
|
+
return domain !== null && domainsAligned(domain, fromDomain);
|
|
147
|
+
});
|
|
148
|
+
return aligned.length > 0 ? aligned : results;
|
|
149
|
+
};
|
|
150
|
+
export const extractAuthResult = (parsed) => {
|
|
151
|
+
const headers = parsed.headerLines
|
|
152
|
+
.filter((l) => l.key.toLowerCase() === "authentication-results")
|
|
153
|
+
.map((l) => parseAuthenticationResults(stripHeaderName(l.line)))
|
|
154
|
+
.filter((h) => h !== null);
|
|
155
|
+
if (headers.length === 0)
|
|
156
|
+
return null;
|
|
157
|
+
const fromDomain = getFromDomain(parsed);
|
|
158
|
+
const byMethod = (results, method) => results.filter((r) => r.method === method);
|
|
159
|
+
const acrossHeaders = (method) => headers.flatMap((h) => byMethod(h.results, method));
|
|
160
|
+
return {
|
|
161
|
+
dmarc: leastFavourableVerdict(acrossHeaders("dmarc")),
|
|
162
|
+
spf: leastFavourableVerdict(acrossHeaders("spf")),
|
|
163
|
+
dkim: leastFavourableVerdict(headers.flatMap((h) => dkimResultsForFrom(byMethod(h.results, "dkim"), fromDomain))),
|
|
164
|
+
};
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Extract provider spam-filter signal from X-SpamExperts-Class, X-Spam-Status,
|
|
168
|
+
* or X-HalOne-Spam-Probability headers. Returns null when none are present.
|
|
169
|
+
*/
|
|
170
|
+
export const extractProviderSpam = (parsed) => {
|
|
171
|
+
const lines = parsed.headerLines;
|
|
172
|
+
const spamExperts = lines.find((l) => l.key.toLowerCase() === "x-spamexperts-class");
|
|
173
|
+
if (spamExperts) {
|
|
174
|
+
const value = stripHeaderName(spamExperts.line).trim().toLowerCase();
|
|
175
|
+
return {
|
|
176
|
+
classified: value === "spam",
|
|
177
|
+
source: "x-spamexperts-class",
|
|
178
|
+
};
|
|
179
|
+
}
|
|
180
|
+
const spamStatus = lines.find((l) => l.key.toLowerCase() === "x-spam-status");
|
|
181
|
+
if (spamStatus) {
|
|
182
|
+
const text = stripHeaderName(spamStatus.line).trim();
|
|
183
|
+
const classified = text.toLowerCase().startsWith("yes");
|
|
184
|
+
const scoreMatch = text.match(/score=([\d.+-]+)/i);
|
|
185
|
+
return {
|
|
186
|
+
classified,
|
|
187
|
+
score: scoreMatch ? scoreMatch[1] : undefined,
|
|
188
|
+
source: "x-spam-status",
|
|
189
|
+
};
|
|
190
|
+
}
|
|
191
|
+
const halOne = lines.find((l) => l.key.toLowerCase() === "x-halone-spam-probability");
|
|
192
|
+
if (halOne) {
|
|
193
|
+
const value = stripHeaderName(halOne.line).trim();
|
|
194
|
+
return {
|
|
195
|
+
classified: parseFloat(value) > 0.5,
|
|
196
|
+
score: value,
|
|
197
|
+
source: "x-halone-spam-probability",
|
|
198
|
+
};
|
|
199
|
+
}
|
|
200
|
+
return null;
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* Returns true when a List-Unsubscribe header is present, indicating a
|
|
204
|
+
* bulk/mailing-list sender.
|
|
205
|
+
*/
|
|
206
|
+
export const extractHasListUnsubscribe = (parsed) => parsed.headerLines.some((l) => l.key.toLowerCase() === "list-unsubscribe");
|
|
207
|
+
const matchesAutoSubmitted = (headers) => {
|
|
208
|
+
const value = readStringHeader(headers, "auto-submitted");
|
|
209
|
+
if (!value)
|
|
210
|
+
return false;
|
|
211
|
+
const normalized = value.split(";")[0].trim().toLowerCase();
|
|
212
|
+
return normalized === "auto-generated" || normalized === "auto-replied";
|
|
213
|
+
};
|
|
214
|
+
const matchesPrecedence = (headers) => {
|
|
215
|
+
const value = readStringHeader(headers, "precedence");
|
|
216
|
+
if (!value)
|
|
217
|
+
return false;
|
|
218
|
+
const normalized = value.trim().toLowerCase();
|
|
219
|
+
return (normalized === "bulk" || normalized === "list" || normalized === "junk");
|
|
220
|
+
};
|
|
221
|
+
const hasCalendarPart = (attachments) => {
|
|
222
|
+
if (!attachments)
|
|
223
|
+
return false;
|
|
224
|
+
for (const att of attachments) {
|
|
225
|
+
if ((att.contentType ?? "").toLowerCase().startsWith("text/calendar")) {
|
|
226
|
+
return true;
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
return false;
|
|
230
|
+
};
|
|
231
|
+
/**
|
|
232
|
+
* Whether the sender is a machine that does not read replies — a no-reply
|
|
233
|
+
* local-part, or a header only bulk/notification infrastructure sets. This is
|
|
234
|
+
* what routes platform notifications (npm, CI, password resets) to `automated`
|
|
235
|
+
* instead of the `personal` fallback; they carry no list or bulk headers.
|
|
236
|
+
*/
|
|
237
|
+
const isMachineSender = (parsed, lines) => {
|
|
238
|
+
if (hasMachineHeader(lines.map((line) => line.key)))
|
|
239
|
+
return true;
|
|
240
|
+
const localPart = getFromLocalPart(parsed);
|
|
241
|
+
return localPart !== null && isMachineLocalPart(localPart);
|
|
242
|
+
};
|
|
243
|
+
const getFromLocalPart = (parsed) => {
|
|
244
|
+
const address = parsed.from?.value?.[0]?.address;
|
|
245
|
+
if (!address)
|
|
246
|
+
return null;
|
|
247
|
+
const at = address.lastIndexOf("@");
|
|
248
|
+
if (at <= 0)
|
|
249
|
+
return null;
|
|
250
|
+
return address.slice(0, at);
|
|
251
|
+
};
|
|
252
|
+
const getFromDomain = (parsed) => {
|
|
253
|
+
const from = parsed.from;
|
|
254
|
+
if (!from || !from.value || from.value.length === 0)
|
|
255
|
+
return null;
|
|
256
|
+
const address = from.value[0]?.address;
|
|
257
|
+
if (!address)
|
|
258
|
+
return null;
|
|
259
|
+
const at = address.lastIndexOf("@");
|
|
260
|
+
if (at < 0 || at === address.length - 1)
|
|
261
|
+
return null;
|
|
262
|
+
return address.slice(at + 1).toLowerCase();
|
|
263
|
+
};
|
|
264
|
+
const domainMatches = (domain, allowList) => {
|
|
265
|
+
for (const entry of allowList) {
|
|
266
|
+
if (domain === entry || domain.endsWith(`.${entry}`))
|
|
267
|
+
return true;
|
|
268
|
+
}
|
|
269
|
+
return false;
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* Whether a signing domain aligns with the From domain: equal, or one is a
|
|
273
|
+
* subdomain of the other (parent/child). A legitimate re-mailer signing under
|
|
274
|
+
* a subdomain is not suspicious, so either direction counts as aligned.
|
|
275
|
+
*/
|
|
276
|
+
const domainsAligned = (signingDomain, fromDomain) => signingDomain === fromDomain ||
|
|
277
|
+
fromDomain.endsWith(`.${signingDomain}`) ||
|
|
278
|
+
signingDomain.endsWith(`.${fromDomain}`);
|
|
279
|
+
/**
|
|
280
|
+
* Pick the domain to report out of a list of candidate signing domains: the
|
|
281
|
+
* first one aligned with the From domain, so a legitimate signature is never
|
|
282
|
+
* shadowed by an earlier unrelated one. When none align, the first is
|
|
283
|
+
* reported as the mismatching evidence — the UI can then show "signed by
|
|
284
|
+
* relay.example.net, claims example.com". Shared by the category heuristic
|
|
285
|
+
* (rule 9, which reads only `.mismatch`) and the authenticity extractor
|
|
286
|
+
* (which also reads `.domain`), so the two can never disagree.
|
|
287
|
+
*/
|
|
288
|
+
const pickAlignedOrFirstMismatch = (domains, fromDomain) => {
|
|
289
|
+
let firstMismatching = null;
|
|
290
|
+
for (const d of domains) {
|
|
291
|
+
if (domainsAligned(d, fromDomain))
|
|
292
|
+
return { mismatch: false, domain: d };
|
|
293
|
+
if (!firstMismatching)
|
|
294
|
+
firstMismatching = d;
|
|
295
|
+
}
|
|
296
|
+
return { mismatch: firstMismatching !== null, domain: firstMismatching };
|
|
297
|
+
};
|
|
298
|
+
const extractDkimDomains = (headers, lines) => {
|
|
299
|
+
const domains = [];
|
|
300
|
+
const raw = headers.get("dkim-signature");
|
|
301
|
+
const structured = collectStructured(raw);
|
|
302
|
+
for (const s of structured) {
|
|
303
|
+
const d = s.params?.d;
|
|
304
|
+
if (typeof d === "string")
|
|
305
|
+
domains.push(d.trim().toLowerCase());
|
|
306
|
+
}
|
|
307
|
+
for (const line of lines) {
|
|
308
|
+
if (line.key.toLowerCase() !== "dkim-signature")
|
|
309
|
+
continue;
|
|
310
|
+
const value = stripHeaderName(line.line);
|
|
311
|
+
const match = value.match(/(?:^|;)\s*d\s*=\s*([^;\s]+)/i);
|
|
312
|
+
if (match) {
|
|
313
|
+
const candidate = match[1].trim().toLowerCase();
|
|
314
|
+
if (!domains.includes(candidate))
|
|
315
|
+
domains.push(candidate);
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
return domains;
|
|
319
|
+
};
|
|
320
|
+
const collectStructured = (value) => {
|
|
321
|
+
if (!value)
|
|
322
|
+
return [];
|
|
323
|
+
if (Array.isArray(value)) {
|
|
324
|
+
const out = [];
|
|
325
|
+
for (const v of value) {
|
|
326
|
+
if (isStructuredHeader(v))
|
|
327
|
+
out.push(v);
|
|
328
|
+
}
|
|
329
|
+
return out;
|
|
330
|
+
}
|
|
331
|
+
if (isStructuredHeader(value))
|
|
332
|
+
return [value];
|
|
333
|
+
return [];
|
|
334
|
+
};
|
|
335
|
+
const isStructuredHeader = (v) => {
|
|
336
|
+
if (!v || typeof v !== "object")
|
|
337
|
+
return false;
|
|
338
|
+
return ("value" in v &&
|
|
339
|
+
typeof v.value === "string" &&
|
|
340
|
+
"params" in v &&
|
|
341
|
+
typeof v.params === "object");
|
|
342
|
+
};
|
|
343
|
+
const stripHeaderName = (line) => {
|
|
344
|
+
const idx = line.indexOf(":");
|
|
345
|
+
return idx >= 0 ? line.slice(idx + 1).trim() : line;
|
|
346
|
+
};
|
|
347
|
+
const hasHeaderLine = (lines, name) => {
|
|
348
|
+
const lc = name.toLowerCase();
|
|
349
|
+
for (const line of lines) {
|
|
350
|
+
if (line.key.toLowerCase() === lc)
|
|
351
|
+
return true;
|
|
352
|
+
}
|
|
353
|
+
return false;
|
|
354
|
+
};
|
|
355
|
+
const readStringHeader = (headers, key) => {
|
|
356
|
+
const value = headers.get(key);
|
|
357
|
+
if (typeof value === "string")
|
|
358
|
+
return value;
|
|
359
|
+
if (Array.isArray(value)) {
|
|
360
|
+
const first = value[0];
|
|
361
|
+
if (typeof first === "string")
|
|
362
|
+
return first;
|
|
363
|
+
}
|
|
364
|
+
return undefined;
|
|
365
|
+
};
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import type { MessageItem } from "@remit/data-ports";
|
|
2
|
+
import { SenderOverride, SenderTrust } from "@remit/domain-enums";
|
|
3
|
+
type SenderTrustValue = (typeof SenderTrust)[keyof typeof SenderTrust];
|
|
4
|
+
type SenderOverrideValue = (typeof SenderOverride)[keyof typeof SenderOverride];
|
|
5
|
+
export type FolderPlacement = "inbox" | "junk" | "other";
|
|
6
|
+
export type PlacementAction = "move-to-inbox" | "move-to-junk" | "leave";
|
|
7
|
+
export interface PlacementVerdict {
|
|
8
|
+
action: PlacementAction;
|
|
9
|
+
confidence: "confident" | "unsure";
|
|
10
|
+
reasons: string[];
|
|
11
|
+
}
|
|
12
|
+
/** The trust signal plus the `setAt` of whichever flag (`vip`/`wellknown`) produced it, `undefined` when the sender is `Unknown`. */
|
|
13
|
+
export interface SenderTrustSignal {
|
|
14
|
+
trust: SenderTrustValue;
|
|
15
|
+
setAt?: number;
|
|
16
|
+
}
|
|
17
|
+
/** The sender's `blocked` flag value plus its `setAt`. */
|
|
18
|
+
export interface SenderBlockedSignal {
|
|
19
|
+
blocked: boolean;
|
|
20
|
+
setAt?: number;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Resolve the two axes {@link classifyPlacement} takes: the trust signal, and
|
|
24
|
+
* the user's standing instruction about placement.
|
|
25
|
+
*
|
|
26
|
+
* `blocked` and `neverSpam` are two directly contradictory instructions and
|
|
27
|
+
* cannot both stand — `AddressRepository.mergeFlags` drops the loser at write
|
|
28
|
+
* time. Reading a row that carries both anyway (written before that invariant)
|
|
29
|
+
* resolves to `Blocked`, the same direction the `blocked`/`vip` same-second tie
|
|
30
|
+
* already breaks in: the demote is the recoverable mistake.
|
|
31
|
+
*/
|
|
32
|
+
export declare const resolveSenderPlacement: (trust: SenderTrustSignal, blocked: SenderBlockedSignal, neverSpam: boolean) => {
|
|
33
|
+
senderTrust: SenderTrustValue;
|
|
34
|
+
senderOverride: SenderOverrideValue;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Tier 0 deterministic placement verdict (RFC 031, "Confident moves").
|
|
38
|
+
*
|
|
39
|
+
* Pure: the caller resolves the message's current folder placement and the
|
|
40
|
+
* sender trust; this function does no DB lookups and produces no side effects.
|
|
41
|
+
* It generalizes `shouldRescueFromJunk` into a two-directional verdict and is
|
|
42
|
+
* recall-biased — a confident move only fires when cheap, deterministic signals
|
|
43
|
+
* agree; everything else is left in place for a later LLM tier.
|
|
44
|
+
*
|
|
45
|
+
* `senderOverride` (RFC 039 Decision 3, issue #605) is the user's standing
|
|
46
|
+
* instruction about this sender's placement, and it outranks every
|
|
47
|
+
* DKIM/DMARC/provider signal below — an explicit block or never-spam grant is
|
|
48
|
+
* not a heuristic. Already-tie-broken against `vip`/`wellknown` by
|
|
49
|
+
* {@link resolveSenderPlacement} in the caller; this function itself does not
|
|
50
|
+
* compare `setAt`.
|
|
51
|
+
*
|
|
52
|
+
* `NeverSpam` is checked above the `missing-signals` return and above the
|
|
53
|
+
* `providerSpam.classified` gate on purpose: the senders who need the grant are
|
|
54
|
+
* the ones the provider rated clean and whose domain publishes no DMARC record,
|
|
55
|
+
* so a check inside the rescue branch below would never fire for them. It
|
|
56
|
+
* rescues only from `junk` — a message a standing filter put in a user folder
|
|
57
|
+
* is not a spam question.
|
|
58
|
+
*
|
|
59
|
+
* It refuses outright on a `dmarc === "Fail"` or a DKIM mismatch. The demote
|
|
60
|
+
* branch below is reached only from `inbox`, so a spoof already sitting in Junk
|
|
61
|
+
* would never meet it: without this guard the grant would launder mail out of
|
|
62
|
+
* Junk on exactly the two signals that identify someone impersonating the
|
|
63
|
+
* address the user granted. A domain that publishes no DMARC record never
|
|
64
|
+
* scores `Fail`, so the case the grant exists for is untouched.
|
|
65
|
+
*/
|
|
66
|
+
export declare const classifyPlacement: (message: MessageItem, placement: FolderPlacement, senderTrust: SenderTrustValue, senderOverride: SenderOverrideValue) => PlacementVerdict;
|
|
67
|
+
export {};
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import { SenderOverride, SenderTrust } from "@remit/domain-enums";
|
|
2
|
+
const isTrusted = (senderTrust) => senderTrust === SenderTrust.Vip || senderTrust === SenderTrust.Wellknown;
|
|
3
|
+
/**
|
|
4
|
+
* RFC 039 Decision 3a: when a sender's `blocked` flag and their `vip`/
|
|
5
|
+
* `wellknown` flag disagree on placement, the one set most recently wins.
|
|
6
|
+
* Scoped to {@link classifyPlacement}'s own verdict only — it never touches
|
|
7
|
+
* `deriveSenderTrust` or the trust badge, which stay a plain `vip → wellknown
|
|
8
|
+
* → unknown` read with no `blocked` case.
|
|
9
|
+
*
|
|
10
|
+
* A same-second tie (both `setAt` floor to the same second) breaks in a
|
|
11
|
+
* fixed, arbitrary order: `blocked` before `vip` before `wellknown` — a
|
|
12
|
+
* determinism backstop, not a meaningful signal.
|
|
13
|
+
*/
|
|
14
|
+
const resolveBlockedVsTrust = (trust, blocked) => {
|
|
15
|
+
if (!blocked.blocked) {
|
|
16
|
+
return { senderTrust: trust.trust, senderBlocked: false };
|
|
17
|
+
}
|
|
18
|
+
if (trust.trust === SenderTrust.Unknown || trust.setAt === undefined) {
|
|
19
|
+
return { senderTrust: SenderTrust.Unknown, senderBlocked: true };
|
|
20
|
+
}
|
|
21
|
+
const blockedSecond = Math.floor((blocked.setAt ?? 0) / 1000);
|
|
22
|
+
const trustSecond = Math.floor(trust.setAt / 1000);
|
|
23
|
+
// Newer (or a same-second tie, which `blocked` wins) — blocked wins.
|
|
24
|
+
if (blockedSecond >= trustSecond) {
|
|
25
|
+
return { senderTrust: SenderTrust.Unknown, senderBlocked: true };
|
|
26
|
+
}
|
|
27
|
+
return { senderTrust: trust.trust, senderBlocked: false };
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Resolve the two axes {@link classifyPlacement} takes: the trust signal, and
|
|
31
|
+
* the user's standing instruction about placement.
|
|
32
|
+
*
|
|
33
|
+
* `blocked` and `neverSpam` are two directly contradictory instructions and
|
|
34
|
+
* cannot both stand — `AddressRepository.mergeFlags` drops the loser at write
|
|
35
|
+
* time. Reading a row that carries both anyway (written before that invariant)
|
|
36
|
+
* resolves to `Blocked`, the same direction the `blocked`/`vip` same-second tie
|
|
37
|
+
* already breaks in: the demote is the recoverable mistake.
|
|
38
|
+
*/
|
|
39
|
+
export const resolveSenderPlacement = (trust, blocked, neverSpam) => {
|
|
40
|
+
const { senderTrust, senderBlocked } = resolveBlockedVsTrust(trust, blocked);
|
|
41
|
+
if (senderBlocked)
|
|
42
|
+
return { senderTrust, senderOverride: SenderOverride.Blocked };
|
|
43
|
+
if (neverSpam)
|
|
44
|
+
return { senderTrust, senderOverride: SenderOverride.NeverSpam };
|
|
45
|
+
return { senderTrust, senderOverride: SenderOverride.None };
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Tier 0 deterministic placement verdict (RFC 031, "Confident moves").
|
|
49
|
+
*
|
|
50
|
+
* Pure: the caller resolves the message's current folder placement and the
|
|
51
|
+
* sender trust; this function does no DB lookups and produces no side effects.
|
|
52
|
+
* It generalizes `shouldRescueFromJunk` into a two-directional verdict and is
|
|
53
|
+
* recall-biased — a confident move only fires when cheap, deterministic signals
|
|
54
|
+
* agree; everything else is left in place for a later LLM tier.
|
|
55
|
+
*
|
|
56
|
+
* `senderOverride` (RFC 039 Decision 3, issue #605) is the user's standing
|
|
57
|
+
* instruction about this sender's placement, and it outranks every
|
|
58
|
+
* DKIM/DMARC/provider signal below — an explicit block or never-spam grant is
|
|
59
|
+
* not a heuristic. Already-tie-broken against `vip`/`wellknown` by
|
|
60
|
+
* {@link resolveSenderPlacement} in the caller; this function itself does not
|
|
61
|
+
* compare `setAt`.
|
|
62
|
+
*
|
|
63
|
+
* `NeverSpam` is checked above the `missing-signals` return and above the
|
|
64
|
+
* `providerSpam.classified` gate on purpose: the senders who need the grant are
|
|
65
|
+
* the ones the provider rated clean and whose domain publishes no DMARC record,
|
|
66
|
+
* so a check inside the rescue branch below would never fire for them. It
|
|
67
|
+
* rescues only from `junk` — a message a standing filter put in a user folder
|
|
68
|
+
* is not a spam question.
|
|
69
|
+
*
|
|
70
|
+
* It refuses outright on a `dmarc === "Fail"` or a DKIM mismatch. The demote
|
|
71
|
+
* branch below is reached only from `inbox`, so a spoof already sitting in Junk
|
|
72
|
+
* would never meet it: without this guard the grant would launder mail out of
|
|
73
|
+
* Junk on exactly the two signals that identify someone impersonating the
|
|
74
|
+
* address the user granted. A domain that publishes no DMARC record never
|
|
75
|
+
* scores `Fail`, so the case the grant exists for is untouched.
|
|
76
|
+
*/
|
|
77
|
+
export const classifyPlacement = (message, placement, senderTrust, senderOverride) => {
|
|
78
|
+
if (message.movedByRemit === true) {
|
|
79
|
+
return {
|
|
80
|
+
action: "leave",
|
|
81
|
+
confidence: "confident",
|
|
82
|
+
reasons: ["already-moved-by-remit"],
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
if (senderOverride === SenderOverride.Blocked && placement !== "junk") {
|
|
86
|
+
return {
|
|
87
|
+
action: "move-to-junk",
|
|
88
|
+
confidence: "confident",
|
|
89
|
+
reasons: ["sender=blocked"],
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
if (senderOverride === SenderOverride.NeverSpam &&
|
|
93
|
+
placement === "junk" &&
|
|
94
|
+
message.authResult?.dmarc !== "Fail" &&
|
|
95
|
+
message.authenticity?.dkimMismatch !== true) {
|
|
96
|
+
return {
|
|
97
|
+
action: "move-to-inbox",
|
|
98
|
+
confidence: "confident",
|
|
99
|
+
reasons: ["sender=never-spam"],
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
if (!message.providerSpam || !message.authResult) {
|
|
103
|
+
return {
|
|
104
|
+
action: "leave",
|
|
105
|
+
confidence: "unsure",
|
|
106
|
+
reasons: ["missing-signals"],
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
const providerSpam = message.providerSpam.classified === true;
|
|
110
|
+
const dmarc = message.authResult.dmarc;
|
|
111
|
+
const dkimMismatch = message.authenticity?.dkimMismatch === true;
|
|
112
|
+
const trusted = isTrusted(senderTrust);
|
|
113
|
+
// Rescue (junk → inbox), LOW bar. Mirrors shouldRescueFromJunk's gate.
|
|
114
|
+
if (placement === "junk" && providerSpam && dmarc === "Pass") {
|
|
115
|
+
if (trusted) {
|
|
116
|
+
return {
|
|
117
|
+
action: "move-to-inbox",
|
|
118
|
+
confidence: "confident",
|
|
119
|
+
reasons: ["provider=spam", "dmarc=pass", `sender=${senderTrust}`],
|
|
120
|
+
};
|
|
121
|
+
}
|
|
122
|
+
// Anti-spoof guard: an unknown sender is never auto-rescued.
|
|
123
|
+
return {
|
|
124
|
+
action: "leave",
|
|
125
|
+
confidence: "unsure",
|
|
126
|
+
reasons: ["provider=spam", "dmarc=pass", "sender=untrusted"],
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
// Demote (inbox → junk), HIGH bar.
|
|
130
|
+
if (placement === "inbox" && dkimMismatch) {
|
|
131
|
+
if (dmarc === "Fail" && !trusted) {
|
|
132
|
+
return {
|
|
133
|
+
action: "move-to-junk",
|
|
134
|
+
confidence: "confident",
|
|
135
|
+
reasons: ["dkim-mismatch", "dmarc=fail", "sender=untrusted"],
|
|
136
|
+
};
|
|
137
|
+
}
|
|
138
|
+
// DMARC-pass phishing: dkimMismatch but DMARC did not fail. Deferred to a
|
|
139
|
+
// later LLM tier — must never auto-demote here.
|
|
140
|
+
if (dmarc === "Pass") {
|
|
141
|
+
return {
|
|
142
|
+
action: "leave",
|
|
143
|
+
confidence: "unsure",
|
|
144
|
+
reasons: ["dkim-mismatch", "dmarc=pass", "deferred-to-llm"],
|
|
145
|
+
};
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
return {
|
|
149
|
+
action: "leave",
|
|
150
|
+
confidence: "unsure",
|
|
151
|
+
reasons: ["no-confident-signal"],
|
|
152
|
+
};
|
|
153
|
+
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Signals that a message was sent by a machine that does not read replies.
|
|
3
|
+
*
|
|
4
|
+
* Distinct from the bulk signals (`Precedence`, `List-Unsubscribe`): a platform
|
|
5
|
+
* notification — an npm publish or 2FA mail, a CI result, a password reset —
|
|
6
|
+
* carries none of those. It is a one-to-one message with an aligned DKIM
|
|
7
|
+
* signature, so before issue #45 it reached the `personal` fallback and sat
|
|
8
|
+
* alongside actual human correspondence.
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* True when any whole word of the From local-part is a known machine mailbox.
|
|
12
|
+
*
|
|
13
|
+
* Word-boundary, not substring: platforms qualify the mailbox on either side
|
|
14
|
+
* (`noreply-github`, `messages-noreply`, `jobalerts-noreply`), so a bare prefix
|
|
15
|
+
* test misses half of them — but a substring test reads `bruno.reply` as
|
|
16
|
+
* "bru|noreply" and files a real person as `automated`. Splitting on the
|
|
17
|
+
* separators the sender wrote catches the qualified forms without inventing a
|
|
18
|
+
* match that spans two words.
|
|
19
|
+
*/
|
|
20
|
+
export declare const isMachineLocalPart: (localPart: string) => boolean;
|
|
21
|
+
export declare const hasMachineHeader: (headerKeys: readonly string[]) => boolean;
|