From 22d9cabeb30bdf491308f60528b6c6a442941d07 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 8 Oct 2019 08:58:06 +0000 Subject: doc: PublicInbox::SaPlugin::ListMirror manpage This is a plugin for SpamAssassin that happens to be quite useful in keeping spam off lists I mirror. Hopefully more people can find it useful now that it has a manpage. --- lib/PublicInbox/SaPlugin/ListMirror.pod | 114 ++++++++++++++++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 lib/PublicInbox/SaPlugin/ListMirror.pod (limited to 'lib/PublicInbox') diff --git a/lib/PublicInbox/SaPlugin/ListMirror.pod b/lib/PublicInbox/SaPlugin/ListMirror.pod new file mode 100644 index 00000000..bb54c1fe --- /dev/null +++ b/lib/PublicInbox/SaPlugin/ListMirror.pod @@ -0,0 +1,114 @@ +=head1 NAME + +PublicInbox::SaPlugin::ListMirror - SpamAssassin plugin for mailing list mirrors + +=head1 SYNOPSIS + + loadplugin PublicInbox::SaPlugin::ListMirror + +Declare some mailing lists based on the expected List-Id value, +expected servers, and mailing list address: + + list_mirror List-Id *.example.com foo@example.com + list_mirror List-Id *.example.com bar@example.com + +Bump the score for messages which come from unexpected servers: + + header LIST_MIRROR_RECEIVED eval:check_list_mirror_received() + describe LIST_MIRROR_RECEIVED Received does not match expected + score LIST_MIRROR_RECEIVED 10 + +Bump the score for messages which Bcc the list: + + header LIST_MIRROR_BCC eval:check_list_mirror_bcc() + describe LIST_MIRROR_BCC Mailing list was Bcc-ed + score LIST_MIRROR_BCC 5 + +=head1 DESCRIPTION + +This plugin contains common functions to provide accurate, ongoing +mirrors of existing mailing lists. It may be used independently of the +rest of public-inbox, it does not depend on any public-inbox code, only +SpamAssassin. + +=head1 ADMINISTRATOR SETTINGS + +This plugin has no administrator settings, aside from the need +to load it via C and enabling user rules +C + +=head1 USER SETTINGS + +=over 4 + +=item list_mirror HEADER HEADER_VALUE HOSTNAME_GLOB [LIST_ADDRESS] + +Declare a list based on an expected C
matching C +exactly coming from C. C is optional, +but may specify the address of the mailing list being mirrored. + +C or C are common values of C
+ +An example of C is Cfoo.example.orgE> +if C
is C. + +C may be a wildcard match for machines where mail can +come from or an exact match. + +C is only required if using the L +eval rule + +C may be specified multiple times. + +=back + +=head1 EVAL FUNCTIONS + +=over 4 + +=item header LIST_MIRROR_RECEIVED eval:check_list_mirror_received() + +The C function implements C +header checking based on L configuration values. + +This rule can be used to score and prevent messages from being injected +directly into your mirror without going through the expected mailing +list servers: + + ifplugin PublicInbox::SaPlugin::ListMirror + header LIST_MIRROR_RECEIVED eval:check_list_mirror_received() + describe LIST_MIRROR_RECEIVED Received does not match expected + endif + +=item header LIST_MIRROR_BCC eval:check_list_mirror_bcc() + +The C function checks for Bcc to mailing lists +declared with a C via L + +Spammers will often Bcc mailing lists; while it's uncommon and +strange for valid messages to be Bcc-ed to any public mailing list. +This rule allows users to assign a score to Bcc-ed messages + + ifplugin PublicInbox::SaPlugin::ListMirror + header LIST_MIRROR_BCC eval:check_list_mirror_bcc() + describe LIST_MIRROR_BCC Mailing list was Bcc-ed + endif + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L + +The mail archives are hosted at L +and L + +=head1 COPYRIGHT + +Copyright (C) 2016-2019 all contributors L + +License: AGPL-3.0+ L + +=head1 SEE ALSO + +L -- cgit v1.2.3-24-ge0c7