PipelineContext
Defined in: src/pipeline/context.ts:8
Properties
Section titled “Properties”compiled
Section titled “compiled”compiled:
CompiledRules
Defined in: src/pipeline/context.ts:12
config
Section titled “config”config:
object
Defined in: src/pipeline/context.ts:11
categories
Section titled “categories”categories:
object[]
detection
Section titled “detection”detection:
object=detectionSchema
detection.accountCategory
Section titled “detection.accountCategory”accountCategory:
string
detection.accountDomains
Section titled “detection.accountDomains”accountDomains:
string[]
detection.automatedNamePattern
Section titled “detection.automatedNamePattern”automatedNamePattern:
string
regex source, case-insensitive, matched against the from ADDRESS
detection.brandNamePattern
Section titled “detection.brandNamePattern”brandNamePattern:
string
regex source, case-insensitive, matched against address + display name
detection.personalCategory
Section titled “detection.personalCategory”personalCategory:
string
detection.personalDomains
Section titled “detection.personalDomains”personalDomains:
string[]
the user’s own domains — anything sent from them files as personal
detection.personalProviderDomains
Section titled “detection.personalProviderDomains”personalProviderDomains:
string[]
detection.personalProviderPattern
Section titled “detection.personalProviderPattern”personalProviderPattern:
string
regex source, case-insensitive: freemail providers (needs-action heuristic)
detection.personalReplyExclusionPattern
Section titled “detection.personalReplyExclusionPattern”personalReplyExclusionPattern:
string
regex source, case-insensitive: senders excluded from the needs-reply bonus
detection.relayDomains
Section titled “detection.relayDomains”relayDomains:
string[]
keepList
Section titled “keepList”keepList:
string[]
exact sender addresses that must never be swept (checked twice)
needsAction
Section titled “needsAction”needsAction:
object=needsActionSchema
needsAction.exclusionKeywords?
Section titled “needsAction.exclusionKeywords?”
optionalexclusionKeywords?:object[]
when present, REPLACES the language packs entirely
needsAction.highKeywords?
Section titled “needsAction.highKeywords?”
optionalhighKeywords?:object[]
when present, REPLACES the language packs entirely
needsAction.label
Section titled “needsAction.label”label:
string
needsAction.languages
Section titled “needsAction.languages”languages: (
"en"|"de")[]
built-in keyword packs to enable — English-only by default
needsAction.personalNeedsReplyBonus
Section titled “needsAction.personalNeedsReplyBonus”personalNeedsReplyBonus:
number
needsAction.threshold
Section titled “needsAction.threshold”threshold:
number
needsAction.unreadBonus
Section titled “needsAction.unreadBonus”unreadBonus:
number
needsAction.windowDays
Section titled “needsAction.windowDays”windowDays:
number
how far back to scan
ops:
object=opsSchema
ops.batchDelayMs
Section titled “ops.batchDelayMs”batchDelayMs:
number
ops.batchSize
Section titled “ops.batchSize”batchSize:
number
ops.maxItems?
Section titled “ops.maxItems?”
optionalmaxItems?:number
ops.progressEvery
Section titled “ops.progressEvery”progressEvery:
number
ops.stallBackoffMs
Section titled “ops.stallBackoffMs”stallBackoffMs:
number
ops.stallLimit
Section titled “ops.stallLimit”stallLimit:
number
provider
Section titled “provider”provider:
object
provider.baseUrl?
Section titled “provider.baseUrl?”
optionalbaseUrl?:string
override endpoints (testing / self-hosted JMAP)
provider.type
Section titled “provider.type”type:
"jmap"|"mcp"
rules: ({
address:string;category:string;kind:"sender"; } | {category:string;domain:string;kind:"domain"; } | {category:string;kind:"name";onlyForDomains?:string[];pattern:string; })[]
sweep:
object=sweepSchema
sweep.after?
Section titled “sweep.after?”
optionalafter?:string
sweep.targetLabel
Section titled “sweep.targetLabel”targetLabel:
string
sweep.textHeuristic
Section titled “sweep.textHeuristic”textHeuristic:
string
full-text heuristic identifying bulk mail
confirm
Section titled “confirm”confirm:
ConfirmFn
Defined in: src/pipeline/context.ts:16
confirmThreshold?
Section titled “confirmThreshold?”
optionalconfirmThreshold?:number
Defined in: src/pipeline/context.ts:18
planned mutations above this require confirm() (default 100)
dryRun
Section titled “dryRun”dryRun:
boolean
Defined in: src/pipeline/context.ts:13
log: (
message) =>void
Defined in: src/pipeline/context.ts:19
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
optionalmax?:number
Defined in: src/pipeline/context.ts:15
cap on emails scanned per run
provider
Section titled “provider”provider:
MailProvider
Defined in: src/pipeline/context.ts:10
always the RAW provider — pipelines derive the read side via readProvider()
sleep?
Section titled “sleep?”
optionalsleep?: (ms) =>Promise<void>
Defined in: src/pipeline/context.ts:21
threaded into paging/batching so tests never wait on real timers
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<void>