public-inbox-learn(1)

1PUBLIC-INBOX-LEARN(1)      public-inbox user manual      PUBLIC-INBOX-LEARN(1)
2
3
4

NAME

6       public-inbox-learn - spam trainer and remover for public-inbox
7

SYNOPSIS

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

DESCRIPTION

12       public-inbox-learn can remove spam or inject ham messages into an inbox
13       while training a SpamAssassin instance.
14
15       It is intended for users of public-inbox-mda(1) or
16       public-inbox-watch(1), but not users relying on git-fetch(1) to mirror
17       inboxes.
18
19       It reads one message from standard input and operates on it depending
20       on the command given:
21

COMMANDS

23       public-inbox-learn takes one of the following commands as its first and
24       only argument:
25
26       spam    Treat the message as spam.  This will mark the message as
27               removed so it becomes inaccessible via NNTP or WWW endpoints
28               for all configured inboxes.
29
30               The message remains accessible in git history.
31
32               It will also be fed to spamc(1) for training purposes unless
33               "publicinboxmda.spamcheck" is "none" in public-inbox-config(5).
34
35       ham     Treat standard input as ham.  This is useful for manually
36               injecting messages into the archives which failed the spam
37               check run by public-inbox-mda(1) or public-inbox-watch(1).
38
39               It relies on the "To:", "Cc:", and "List-ID:" headers to match
40               configured inbox addresses and "listid" directives.
41
42               It will also be fed to spamc(1) for training purposes unless
43               "publicinboxmda.spamcheck" is "none" in public-inbox-config(5).
44
45       rm      This is similar to the "spam" command above, but does not feed
46               the message to spamc(1) and only removes messages which match
47               on any of the "To:", "Cc:", and "List-ID:" headers.
48
49               The "--all" option may be used match "spam" semantics in
50               removing the message from all configured inboxes.  "--all" is
51               only available in public-inbox 1.6.0+.
52

ENVIRONMENT

54       PI_CONFIG
55               Per-user config file parseable by git-config(1).  See
56               public-inbox-config(5).
57
58               Default: ~/.public-inbox/config
59

CONTACT

61       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
62
63       The mail archives are hosted at <https://public-inbox.org/meta/> and
64       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
65

COPYRIGHT

67       Copyright 2019-2021 all contributors <mailto:meta@public-inbox.org>
68
69       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
70