PUBLIC-INBOX-LEARN(1)      public-inbox user manual      PUBLIC-INBOX-LEARN(1)

NAME
       public-inbox-learn - spam trainer and remover for public-inbox

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

DESCRIPTION
       public-inbox-learn can remove spam or inject ham messages into an inbox
       while training a SpamAssassin instance.

       It is intended for users of public-inbox-mda(1) or
       public-inbox-watch(1), but not users relying on git-fetch(1) to mirror
       inboxes.

       It reads one message from standard input and operates on it depending
       on the command given:

COMMANDS
       public-inbox-learn takes one of the following commands as its first and
       only argument:

       spam    Treat the message as spam.  This will mark the message as
               removed so it becomes inaccessible via NNTP or WWW endpoints
               for all configured inboxes.

               The message remains accessible in git history.

               It will also be fed to spamc(1) for training purposes unless
               "publicinboxmda.spamcheck" is "none" in public-inbox-config(5).

       ham     Treat standard input as ham.  This is useful for manually
               injecting messages into the archives which failed the spam
               check run by public-inbox-mda(1) or public-inbox-watch(1).

               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).

       rm      This is similar to the "spam" command above, but does not feed
               the message to spamc(1) and only removes messages which match
               on any of the "To:", "Cc:", and "List-ID:" headers.

OPTIONS
       --all
           "--all" may be used with "rm" to match "spam" semantics in removing
           a message from all configured inboxes.  "--all" is only available
           in public-inbox 1.6.0+.

       --keep-going
       -k  Continue to other inboxes after errors.  This ensures "spam" and
           "rm --all" can succeed on all writable inboxes and act as a no-op
           on read-only inboxes.

           Useful for dealing with cases where some inboxes in PI_CONFIG are
           read-only.

ENVIRONMENT
       PI_CONFIG
               Per-user config file parseable by git-config(1).  See
               public-inbox-config(5).

               Default: ~/.public-inbox/config

CONFIGURATION
       These configuration knobs should be used in the public-inbox-config(5)
       file.

       publicinboxImport.dropUniqueUnsubscribe
       publicinbox.<name>.address
       publicinbox.<name>.listid
       publicinboxmda.spamcheck
               See public-inbox-config(5) for descriptions of these options

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/>

COPYRIGHT
       Copyright 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)

public-inbox.git                  1993-10-02             PUBLIC-INBOX-LEARN(1)