# Linha de comando ```text spamscanner [options] ``` | Comando | O que faz | | ------------------------------------------ | ---------------------------------------------------------------------------------------------------- | | `scan [file\|-]` | Analisa uma mensagem de um arquivo ou da entrada padrão | | `filter -f -- ` | Filtro de conteúdo do Postfix: analisa a entrada padrão, adiciona os cabeçalhos e repassa a mensagem | | `milter` | Milter para Postfix e Sendmail, porta 7831 | | `http` | API HTTP, porta 7832 | | `server` | Servidor TCP simples, porta 7830 | | `spamd` | Servidor spamd compatível com o SpamAssassin, porta 783 | | `train` | Treina um modelo a partir de arquivos mbox, Maildirs, pastas ou conjuntos de dados | | `eval` | Mede um modelo com e-mails rotulados | | `learn spam\|ham [file\|-] --model ` | Ensina uma mensagem a um modelo | | `llm-test` | Confere as configurações do modelo de linguagem com três mensagens de exemplo | | `models` | Lista os modelos abertos recomendados | | `version`, `help` | | ## scan ```sh spamscanner scan message.eml spamscanner scan - < message.eml spamscanner scan message.eml --json spamscanner scan message.eml --headers > tagged.eml spamscanner scan message.eml --subject-tag "[SPAM]" > tagged.eml ``` | Opção | Significado | | -------------------------- | --------------------------------------------------------------- | | `--json` | Imprime o resultado completo em JSON | | `--headers` | Imprime a mensagem com os cabeçalhos `X-Spam-*` adicionados | | `--subject-tag ` | Também adiciona um prefixo ao assunto do spam | | `--verbose` | Mostra todos os testes e as pistas mais fortes do classificador | | `--threshold ` | Pontuação a partir da qual o e-mail é spam (padrão 5) | | `--reject-threshold ` | Pontuação a partir da qual o e-mail é rejeitado (padrão 15) | | `--model ` | Um arquivo de modelo no lugar do incluído | | `--no-classifier` | Não usa o classificador | | `--config ` | Um arquivo JSON com [opções da biblioteca](https://spamscanner.net/pt/docs/api/#options) | | `--allow-language ` | Idiomas aceitos, por exemplo `en,de,fr` | Códigos de saída: 0 ham, 1 spam, 2 erro. ### Sessão SMTP | Opção | Significado | | ------------------- | -------------------------------------------- | | `--ip
` | Endereço IP do cliente que enviou a mensagem | | `--hostname ` | O nome DNS reverso verificado do cliente | | `--helo ` | O nome que ele informou no HELO ou EHLO | | `--from
` | Remetente do envelope (MAIL FROM) | | `--to
` | Destinatário do envelope; repita para vários | ### Verificações | Opção | Significado | | --------------------- | ------------------------------------------------------------------------------------------- | | `--auth` | Verifica SPF, DKIM, DMARC e ARC (precisa de `--ip`) | | `--dnsbl ` | Lista de bloqueio de IPs, por exemplo `zen.spamhaus.org`; pode ser repetida | | `--uribl ` | Lista de bloqueio de domínios para links, por exemplo `dbl.spamhaus.org`; pode ser repetida | | `--dns-server ` | Servidor de nomes para as verificações DNS; pode ser repetida | | `--no-cloudflare` | Não consulta os resolvedores com filtragem da Cloudflare sobre os links | | `--clamav [socket]` | Analisa os anexos com o clamd, no socket padrão ou no informado | | `--allowlist ` | Sempre aceita este endereço IP, domínio ou endereço; pode ser repetida | | `--denylist ` | Sempre rejeita este endereço IP, domínio ou endereço; pode ser repetida | ### Modelo de linguagem | Opção | Significado | | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--llm ` | `ollama`, `clef-flash`, `jev`, `openai`, `anthropic` e outros ([lista](https://spamscanner.net/pt/docs/llm/#providers)) | | `--llm-model ` | Modelo, por exemplo `qwen3.5:4b` ou `claude-haiku-4-5` | | `--llm-method ` | `decision` (uma probabilidade para cada veredito, em um único passo; o padrão onde estiver disponível) ou `generate` ([métodos](https://spamscanner.net/pt/docs/llm/#decision-or-generation)) | | `--llm-account ` | ID da conta da Cloudflare, para `clef` e `clef-flash` | | `--llm-url ` | URL base, por exemplo `http://10.0.0.5:11434` | | `--llm-host`, `--llm-port`, `--llm-path`, `--llm-protocol` | Altera uma parte da URL do provedor | | `--llm-api-key ` | Chave de API; veja também as variáveis de ambiente abaixo | | `--llm-auth ` | `bearer`, `x-api-key`, `api-key`, `basic`, `header` ou `none` | | `--llm-auth-header ` | Cabeçalho para a chave, com `--llm-auth header` | | `--llm-username`, `--llm-password` | Para `--llm-auth basic` | | `--llm-header "Name: value"` | Cabeçalho extra na requisição; pode ser repetida | | `--llm-mode ` | `auto` (só os casos duvidosos, o padrão) ou `always` | | `--llm-timeout ` | Padrão 30000 | | `--llm-policy ` | Regras extras para o modelo, por exemplo “Nunca enviamos faturas” | | `--llm-redact`, `--no-llm-redact` | Remove os dados pessoais antes; ativado por padrão para provedores remotos | ## filter Um [filtro de conteúdo do Postfix](https://spamscanner.net/pt/docs/postfix/#content-filter). Ele lê uma mensagem da entrada padrão, adiciona os cabeçalhos `X-Spam-*` e a repassa ao sendmail com o mesmo envelope. ```sh spamscanner filter -f "$sender" -- "$recipient" ``` | Opção | Significado | | --------------------- | -------------------------------------------------------------------------- | | `--sendmail ` | Padrão `/usr/sbin/sendmail` | | `--subject-tag ` | Adiciona um prefixo ao assunto do spam | | `--reject` | Devolve os e-mails que atingem o limite de rejeição em vez de repassá-los | | `--discard` | Descarta os e-mails que atingem o limite de rejeição em vez de repassá-los | Os códigos de saída seguem as convenções do sendmail, que o Postfix lê: 0, entregue (ou descartado); 64, nenhum destinatário informado; 69, rejeitado como spam (o Postfix o devolve); 75, qualquer falha, então o Postfix guarda a mensagem e tenta de novo mais tarde. ## milter, http, server e spamd ```sh spamscanner milter --port 7831 --reject --subject-tag "[SPAM]" spamscanner http --port 7832 --token "$SPAMSCANNER_TOKEN" spamscanner server --port 7830 spamscanner spamd --port 783 ``` A porta 783 é a que os clientes do SpamAssassin usam por padrão. Portas abaixo de 1024 exigem root ou a capability `CAP_NET_BIND_SERVICE`; use outra porta, como `--port 7833`, e informe-a ao cliente. | Opção | Significado | | --------------------- | ---------------------------------------------------------------------------- | | `--port ` | Porta TCP | | `--host ` | Endereço em que escutar (padrão 127.0.0.1) | | `--socket ` | Escuta em um socket Unix | | `--reject` | Milter: recusa os e-mails que atingem o limite de rejeição | | `--reject-code ` | Milter: 451, tente de novo mais tarde (o padrão), ou 550 | | `--quarantine` | Milter: retém o spam na quarentena do servidor de e-mail | | `--name ` | Milter: o nome deste servidor no Authentication-Results | | `--token ` | HTTP: exige `Authorization: Bearer `; necessário para `/learn` | | `--allow-tell` | spamd: aceita requisições TELL (`spamc -L spam`) para aprendizado | | `--out ` | HTTP e spamd: salva o que é aprendido neste arquivo de modelo | | `--subject-tag ` | Milter e spamd: adiciona um prefixo ao assunto do spam | | `--verbose` | Milter: registra cada análise. Servidor TCP: responde com uma linha de texto | As opções de análise acima também valem para os servidores. [O milter](https://spamscanner.net/pt/docs/postfix/#milter), [a API HTTP, o servidor TCP e o spamd](https://spamscanner.net/pt/docs/http-api/). ## train, eval e learn ```sh spamscanner train --spam ~/Mail/Junk --ham ~/Mail/Archive --out my-model.json spamscanner eval --model my-model.json --spam test/spam.mbox --ham test/ham.mbox spamscanner learn spam message.eml --model my-model.json ``` | Opção | Significado | | ----------------------------------------------- | ------------------------------------------------------------------------------------ | | `--spam ` | Spam: um arquivo mbox, um Maildir ou uma pasta de arquivos `.eml`; pode ser repetida | | `--ham ` | Ham, da mesma forma; pode ser repetida | | `--dataset ` | Um arquivo CSV ou JSON Lines com colunas de texto e de rótulo; pode ser repetida | | `--text-column `, `--label-column ` | Nomes das colunas, quando não são detectados | | `--out ` | Onde gravar o modelo (padrão `spamscanner-model.json`) | | `--merge` | Parte do modelo incluído (ou de `--model`) em vez de um modelo vazio | O `learn` atualiza o arquivo de modelo no próprio lugar e o cria a partir do modelo incluído na primeira vez. [Treinamento](https://spamscanner.net/pt/docs/training/) ## llm-test e models ```sh spamscanner models spamscanner llm-test --llm ollama --llm-model qwen3.5:4b ``` O `llm-test` envia ao modelo uma mensagem comum e dois golpes, em inglês e em italiano, imprime os vereditos, o tempo de cada um, o método usado e o hardware, e sai com 0 somente se os três estiverem corretos. ## Arquivo de configuração O `--config file.json` (ou a variável de ambiente `SPAMSCANNER_CONFIG`) carrega [opções da biblioteca](https://spamscanner.net/pt/docs/api/#options). As opções da linha de comando têm prioridade sobre o arquivo. ```json { "threshold": 6, "authentication": true, "dnsbl": {"ip": ["zen.spamhaus.org"], "domain": ["dbl.spamhaus.org"]}, "dns": {"servers": ["127.0.0.1"]}, "clamav": {"socket": "/var/run/clamav/clamd.ctl"}, "llm": {"provider": "ollama", "model": "qwen3.5:4b"}, "scores": {"deceptiveLink": 4, "FROM_NAME_BRAND": 3} } ``` ## Variáveis de ambiente | Variável | Significado | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | | `SPAMSCANNER_CONFIG` | Arquivo de configuração | | `SPAMSCANNER_MODEL` | Arquivo de modelo usado no lugar do incluído | | `SPAMSCANNER_TOKEN` | Token da API HTTP | | `SPAMSCANNER_LLM_API_KEY` | Chave de API para qualquer provedor de modelo de linguagem | | `CLOUDFLARE_API_TOKEN` e `CLOUDFLARE_ACCOUNT_ID`, `TYPESAFE_API_KEY`, `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`, `MISTRAL_API_KEY`, `GROQ_API_KEY`, `OPENROUTER_API_KEY`, `DEEPSEEK_API_KEY`, `XAI_API_KEY`, `TOGETHER_API_KEY`, `FIREWORKS_API_KEY`, `CEREBRAS_API_KEY`, `HF_TOKEN`, `AZURE_OPENAI_API_KEY` | A chave de cada provedor | | `NODE_DEBUG=spamscanner*` | Logs de depuração |