PUBLIC-INBOX-LEARN(1)

💖 public-inbox-learn — the spam trainer & remover, bestie edition 💖

okay so you found public-inbox-learn, the public-inbox user manual page that teaches you how to yeet spam and slide ham into your inbox, all while training SpamAssassin on the side. she's a little diva, she does both jobs, and she does them flawlessly. let's get into it 🎀

---

✨ NAME ✨

public-inbox-learn — spam trainer and remover for public-inbox 🧚

---

🌸 SYNOPSIS 🌸

public-inbox-learn <spam|ham|rm> </path/to/RFC2822_message

that's it. one command, one message path, one vibe check. 💅

---

🦋 DESCRIPTION 🦋

public-inbox-learn can remove spam or inject ham messages into an inbox, and while it's doing that it's also training a SpamAssassin instance. multitasking queen, honestly. 👑

it's meant for the girlies using public-inbox-mda(1) or public-inbox-watch(1) — not for the ones relying on git-fetch(1) to mirror inboxes, so if that's you, this isn't your moment, sorry bestie 🙈

she reads one message from standard input and then operates on it depending on the command you gave her:

---

⭐ COMMANDS ⭐

public-inbox-learn takes one of the following commands as its first and only argument. pick one, she's not doing two:

• spam — treat the message as spam, periodt. this marks the message as removed so it becomes inaccessible via NNTP or WWW endpoints for all configured inboxes. ✂️

the message remains accessible in git history, so it's not gone gone, just hidden from the public-facing girlies. iykyk.

it will also be fed to spamc(1) for training purposes — unless publicinboxmda.spamcheck is none in public-inbox-config(5), in which case no training happens, no cap.

• ham — treat standard input as ham. 🍓 this one's the hero: it's useful for manually injecting messages into the archives that failed the spam check run by public-inbox-mda(1) or public-inbox-watch(1). basically rescuing the good ones from the spam bin. she's giving savior complex and we love that.

it relies on the To:, Cc:, and List-ID: headers to match configured inbox addresses and listid directives. 📬

it will also be fed to spamc(1) for training purposes — unless publicinboxmda.spamcheck is none in public-inbox-config(5). same deal as spam, just the other direction.

• rm — this is similar to the spam command above, but she does NOT feed the message to spamc(1), and she only removes messages which match on any of the To:, Cc:, and List-ID: headers. picky queen, she has standards. 💅

the --all option may be used to match spam semantics in removing the message from all configured inboxes. and heads up: --all is only available in public-inbox 1.6.0+, so if you're on an older version, bestie, it's simply not there for you 😭

---

🌈 ENVIRONMENT 🌈

• PI_CONFIG — per-user config file parseable by git-config(1). see public-inbox-config(5). ✨

Default: ~/.public-inbox/config

---

💌 CONTACT 💌

feedback welcome via plain-text mail to <mailto:meta@public-inbox.org> 📧

the mail archives are hosted at <https://public-inbox.org/meta/> and <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> — yes that second one is a whole onion address, she's mysterious like that 🧅✨

---

👑 COPYRIGHT 👑

Copyright 2019-2021 all contributors <mailto:meta@public-inbox.org> 🫶

License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

---

🔥 SEE ALSO 🔥

• spamc(1)
• public-inbox-mda(1)
• public-inbox-watch(1)

---

and that's the whole page, bestie 💖 this was public-inbox.git, dated 1993-10-02, and the page is PUBLIC-INBOX-LEARN(1) — go forth and train that spam filter like the main character you are 👑🌸