mirror of
https://github.com/bulwarkmail/webmail.git
synced 2026-10-31 16:13:15 +00:00
Linus Rath
6241ed61d6
Stalwart only moves spam to Junk when nothing else decided where the message goes. Any Bulwark rule that moved or copied mail to a folder therefore delivered spam there too, e.g. a "subject contains invoice" rule collected phishing. From 0.16.22 this also applies to the "Keep" allow-list action, which older versions still send to Junk. Move and copy rules now add `not spamtest :percent :value "ge" :comparator "i;ascii-numeric" "50"` to their condition when the server supports `spamtestplus` and `relational`. 50 % is Stalwart's spam threshold on the graded scale (0.16.19+), and older versions report 0 or 100. A new per-rule option "Also move messages marked as spam" drops the guard, and "Keep" rules are left unguarded as the explicit allow-list.
104 lines
3.0 KiB
TypeScript
104 lines
3.0 KiB
TypeScript
export interface SieveScript {
|
|
id: string;
|
|
name: string;
|
|
blobId: string;
|
|
isActive: boolean;
|
|
}
|
|
|
|
export interface SieveCapabilities {
|
|
implementation: string;
|
|
maxSizeScript: number;
|
|
sieveExtensions: string[];
|
|
notificationMethods: string[];
|
|
externalLists: string[];
|
|
/** RFC 9661: redirects run per message; extra ones are skipped silently. */
|
|
maxNumberRedirects?: number | null;
|
|
}
|
|
|
|
export type FilterConditionField =
|
|
| 'from' | 'to' | 'cc' | 'subject' | 'header' | 'size' | 'body'
|
|
| 'attachment';
|
|
|
|
export type FilterComparator =
|
|
| 'contains' | 'not_contains'
|
|
| 'is' | 'not_is'
|
|
| 'starts_with' | 'ends_with'
|
|
| 'matches'
|
|
| 'greater_than' | 'less_than'
|
|
// For field === 'attachment':
|
|
// has_any → message has any attachment (Content-Disposition: attachment)
|
|
// has_type → message has an attachment whose Content-Type matches `value`
|
|
// (substring match, e.g. "application/pdf" or "image/")
|
|
| 'has_any' | 'has_type';
|
|
|
|
export type FilterActionType =
|
|
| 'move' | 'copy' | 'forward'
|
|
| 'mark_read' | 'star' | 'add_label'
|
|
| 'discard' | 'reject' | 'keep' | 'stop';
|
|
|
|
export interface FilterCondition {
|
|
field: FilterConditionField;
|
|
comparator: FilterComparator;
|
|
/**
|
|
* Match value. Use a string array for OR-within-condition semantics
|
|
* (e.g. `["@domain1.com", "@domain2.com"]` matches mail from either).
|
|
* Sieve emits the array as a list literal which the implementation
|
|
* treats as "matches any item". Use a plain string for single-value
|
|
* conditions; existing single-value rules continue to work unchanged.
|
|
*
|
|
* Not supported for: size (numeric), has_any (no value).
|
|
*/
|
|
value: string | string[];
|
|
headerName?: string;
|
|
}
|
|
|
|
export interface FilterAction {
|
|
type: FilterActionType;
|
|
value?: string;
|
|
/**
|
|
* move/copy: JMAP id of the target folder. `value` keeps the path as the
|
|
* fallback; the id keeps the rule working after the folder is renamed.
|
|
*/
|
|
mailboxId?: string;
|
|
/** forward: also keep the message (`redirect :copy`). */
|
|
keepCopy?: boolean;
|
|
}
|
|
|
|
export type FilterOrigin = 'bulwark' | 'external' | 'opaque';
|
|
|
|
export interface FilterRule {
|
|
id: string;
|
|
name: string;
|
|
enabled: boolean;
|
|
matchType: 'all' | 'any';
|
|
conditions: FilterCondition[];
|
|
actions: FilterAction[];
|
|
stopProcessing: boolean;
|
|
/**
|
|
* Also move/copy messages the server marked as spam. Off by default, so a
|
|
* folder rule does not pull spam out of Junk.
|
|
*/
|
|
includeSpam?: boolean;
|
|
origin?: FilterOrigin;
|
|
originLabel?: string;
|
|
rawBlock?: string;
|
|
}
|
|
|
|
export interface VacationSieveConfig {
|
|
isEnabled: boolean;
|
|
subject: string;
|
|
textBody: string;
|
|
}
|
|
|
|
export interface FilterMetadata {
|
|
version: 1;
|
|
rules: FilterRule[];
|
|
vacation?: VacationSieveConfig;
|
|
/**
|
|
* The script runs the server-managed "vacation" script via `include`.
|
|
* Servers like Stalwart keep one active script, so a VacationResponse
|
|
* that activates its own script would otherwise switch the filters off.
|
|
*/
|
|
includeVacation?: boolean;
|
|
}
|