sagator(1)

🌸 sagator(1) — the sgfilter era 🌸

ok so bestie, welcome to sagator, section 1 of the manual. this page is all about sgfilter, and honestly? it's giving gatekeeper of your inbox. let's get into it 💅

---

✨ NAME ✨

sgfilter — scan something for viruses/spams over sagator's filterd() service 🦋

---

✨ SYNOPSIS ✨

sgfilter [--help] [--host hostname] [--port number] [--codes|-c]
[--non-safe|-x] [filename]

---

✨ DESCRIPTION ✨

okay so this command? it's a part of sagator. its whole job is scanning emails for viruses/spams, no cap 🦠🚫

it's usable, for example, for courier smtpd — but bestie it can also be used for procmail or other configurations. versatile queen 👑

---

✨ OPTIONS ✨

• --help — display a short help text. that's it, that's the vibe 🎀
• --host hostname — define a hostname of sagator's filterd() service 🏠
• --port number — define a port of sagator's filterd() service 🔌
• --codes, -c — just check if the message is spam or not. set exit code to 1 if message is a spam, 0 if not a spam or processing failure. lowkey the "just tell me yes or no" mode 👀
• --non-safe, -x — turn off "safe fallback" error recovery, which passes through if an error occurs. non safe processing returns an error code described in the "RETURN CODES" section. this one is the spicy one, handle with care 💀
• filename — name of the file to open. if it is not defined, standard input is used 📄

---

✨ RETURN CODES ✨

like, the receipts of how it went:

• 0 — scanned email is clean (no virus and no spam has been found) ✨ slay, we love a clean inbox
• 1 — scanned email is infected (virus or spam has been detected). just error codes (--codes) option must be turned on to return this status. it's giving contaminated 🦠
• 64 — an internal error occurred during scanning. non safe processing must be turned on to return this status 😭
• 65 — an error with communication to sgfilterd() service (service is not running?). non safe processing must be turned on to return this status 🙈

heads up bestie: codes 64 and 65 only show up when non safe processing is on. otherwise it's the safe fallback doing its thing 🫶

---

✨ EXAMPLES ✨

an procmailrc filter:

# filter through sagator
:0fw
|sgfilter
# move identified emails to quarantine
:0
* ^X-Sagator-Status: .
$HOME/mail/quarantine

an courier filter:

xfilter "/usr/bin/sgfilter --host localhost --port 27"

---

✨ AUTHOR ✨

Jan ONDREJ (SAL) <ondrejj (at) salstar.sk> 👑

---

✨ SEE ALSO ✨

sgscan(1), sagator(8), sqback(8) 🌈

---

and that's the whole page, bestie 💖 this was version 0.1, dated December 20, 2004 — a certified vintage icon from the sagator era. go scan something. periodt 🎀✨