Začínáme

Spam Scanner potřebuje Node.js 18 nebo novější, se samostatnou binárkou nepotřebuje vůbec nic.

Instalace#

Jako nástroj pro příkazovou řádku:

Shell
npm install --global spamscanner
spamscanner version

Jako knihovna v projektu Node.js:

Shell
npm install spamscanner

Jako samostatná binárka pro Linux nebo macOS s vestavěným Node.js a modelem:

Shell
curl -fsSL https://github.com/spamscanner/spamscanner/releases/latest/download/install.sh | bash

Binárky pro Linux (x64 a arm64), macOS (Intel a Apple silicon) a Windows jsou přiložené ke každému vydání.

Kontrola zprávy#

Uložte zprávu do souboru (většina poštovních programů tomu říká „Uložit jako“ nebo „Zobrazit originál“) a zkontrolujte ji:

Shell
spamscanner scan message.eml
Text
SPAM  score 16.3 (spam at 5.0, reject at 15.0)  action: reject  language: en
     +6.3  BAYES_999                    Classifier spam probability 99.9%
     +5.0  PHISHING_LOOKALIKE_DOMAIN    "paypa1-secure.top" imitates paypal by swapping characters
     +3.0  DECEPTIVE_LINK               A link shows "https://www.paypal.com/signin" but goes to paypa1-secure.top
     +2.0  FROM_NAME_BRAND              Display name says "paypal" but the message is from paypa1-secure.top

Návratový kód je 0 pro hamŽádoucí pošta: opak spamu., 1 pro spam a 2 pro chybu, takže ho skripty mohou použít přímo. --json vypíše celý výsledek a --headers vypíše zprávu s přidanými hlavičkami X-Spam-*.

Zprávy mohou přicházet i ze standardního vstupu:

Shell
cat message.eml | spamscanner scan -

Použití z Node.js#

JavaScript
import SpamScanner from 'spamscanner';
import {readFile} from 'node:fs/promises';

const scanner = new SpamScanner();
const result = await scanner.scan(await readFile('message.eml'));

console.log(result.isSpam, result.score, result.action);
for (const test of result.tests) {
  console.log(test.name, test.score, test.description);
}

Funguje i CommonJS:

JavaScript
const SpamScanner = require('spamscanner');

scan() přijímá surovou zprávu jako Buffer, řetězec, Uint8Array nebo čitelný stream. Řetězec je vždy text zprávy: Spam Scanner nikdy nečte soubor jen proto, že řetězec vypadá jako cesta. Pro soubory použijte scanner.scanFile(path).

Informace o relaci SMTP#

IP adresa klienta, jeho ověřený název hostitele, jméno z HELO a obálka zpřesňují výsledek: ověření potřebuje IP adresu a pravidlo proti podvrhování vlastní domény potřebuje příjemce.

JavaScript
const result = await scanner.scan(raw, {
  session: {
    remoteAddress: '203.0.113.5',
    resolvedClientHostname: 'mail.example.com',
    helo: 'mail.example.com',
    envelope: {
      mailFrom: {address: 'alice@example.com'},
      rcptTo: [{address: 'bob@example.org'}],
    },
  },
});

Totéž z příkazové řádky:

Shell
spamscanner scan message.eml --ip 203.0.113.5 --helo mail.example.com \
  --from alice@example.com --to bob@example.org --auth

Zapnutí dalších kontrol#

Žádná z nich není ve výchozím stavu zapnutá, protože každá potřebuje službu nebo rozhodnutí:

KontrolaVolba knihovnyPříkazová řádka
SPF, DKIM, DMARC, ARCauthentication: true--auth
Blocklist IP adresdnsbl: {ip: ['zen.spamhaus.org']}--dnsbl zen.spamhaus.org
Blocklist domén v odkazechdnsbl: {domain: ['dbl.spamhaus.org']}--uribl dbl.spamhaus.org
ClamAVclamav: true nebo clamav: {socket}--clamav [socket]
Jazykový modelllm: {provider: 'ollama', model: 'qwen3.5:4b'}--llm ollama
Seznamy povolených a zakázanýchallowlist: [...], denylist: [...]--allowlist, --denylist

Filtrovacích resolverů Cloudflare (1.1.1.2 pro malware, 1.1.1.3 pro obsah pro dospělé) se Spam Scanner ve výchozím stavu ptá na hostitele z odkazů. Vypnete to pomocí phishing: {cloudflare: false} nebo --no-cloudflare. Co opouští počítač

Spamhaus a některé další blocklisty neodpovídají na dotazy poslané přes veřejné resolvery jako 8.8.8.8 nebo 1.1.1.1. Používejte je s lokálním cachovacím resolverem a ověřte si jejich podmínky použití pro váš objem pošty.

Další kroky#

Upravit tuto stránku na GitHubu · Markdown ·