PublicInbox::SaPlugin::ListMirror(3pm)

1PublicInbox::SaPlugin::ULsiesrtMCiornrtorri(b3u)ted PerlPuDbolciucmIennbtoaxt:i:oSnaPlugin::ListMirror(3)
2
3
4

NAME

6       PublicInbox::SaPlugin::ListMirror - SpamAssassin plugin for mailing
7       list mirrors
8

SYNOPSIS

10         loadplugin PublicInbox::SaPlugin::ListMirror
11
12       Declare some mailing lists based on the expected List-Id value,
13       expected servers, and mailing list address:
14
15         list_mirror List-Id <foo.example.com> *.example.com foo@example.com
16         list_mirror List-Id <bar.example.com> *.example.com bar@example.com
17
18       Bump the score for messages which come from unexpected servers:
19
20         header LIST_MIRROR_RECEIVED eval:check_list_mirror_received()
21         describe LIST_MIRROR_RECEIVED Received does not match expected
22         score LIST_MIRROR_RECEIVED 10
23
24       Bump the score for messages which Bcc the list:
25
26         header LIST_MIRROR_BCC eval:check_list_mirror_bcc()
27         describe LIST_MIRROR_BCC Mailing list was Bcc-ed
28         score LIST_MIRROR_BCC 5
29

DESCRIPTION

31       This plugin contains common functions to provide accurate, ongoing
32       mirrors of existing mailing lists.  It may be used independently of the
33       rest of public-inbox, it does not depend on any public-inbox code, only
34       SpamAssassin.
35

ADMINISTRATOR SETTINGS

37       This plugin has no administrator settings, aside from the need to load
38       it via "loadplugin" and enabling user rules "allow_user_rules 1"
39

USER SETTINGS

41       list_mirror HEADER HEADER_VALUE HOSTNAME_GLOB [LIST_ADDRESS]
42           Declare a list based on an expected "HEADER" matching "HEADER_NAME"
43           exactly coming from "HOSTNAME_GLOB".  "LIST_ADDRESS" is optional,
44           but may specify the address of the mailing list being mirrored.
45
46           "List-Id" or "X-Mailing-List" are common values of "HEADER"
47
48           An example of "HEADER_VALUE" is "<foo.example.org>" if "HEADER" is
49           "List-Id".
50
51           "HOSTNAME_GLOB" may be a wildcard match for machines where mail can
52           come from or an exact match.
53
54           "LIST_ADDRESS" is only required if using the
55           "check_list_mirror_bcc" eval rule
56
57           "list_mirror" may be specified multiple times.
58

EVAL FUNCTIONS

60       header LIST_MIRROR_RECEIVED eval:check_list_mirror_received()
61           The "check_list_mirror_received" function implements "Received:"
62           header checking based on "list_mirror" configuration values.
63
64           This rule can be used to score and prevent messages from being
65           injected directly into your mirror without going through the
66           expected mailing list servers:
67
68             ifplugin PublicInbox::SaPlugin::ListMirror
69               header LIST_MIRROR_RECEIVED eval:check_list_mirror_received()
70               describe LIST_MIRROR_RECEIVED Received does not match expected
71             endif
72
73       header LIST_MIRROR_BCC eval:check_list_mirror_bcc()
74           The "check_list_mirror_bcc" function checks for Bcc to mailing
75           lists declared with a "LIST_ADDRESS" via "list_mirror"
76
77           Spammers will often Bcc mailing lists; while it's uncommon and
78           strange for valid messages to be Bcc-ed to any public mailing list.
79           This rule allows users to assign a score to Bcc-ed messages
80
81             ifplugin PublicInbox::SaPlugin::ListMirror
82               header LIST_MIRROR_BCC eval:check_list_mirror_bcc()
83               describe LIST_MIRROR_BCC Mailing list was Bcc-ed
84             endif
85

CONTACT

87       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
88
89       The mail archives are hosted at <https://public-inbox.org/meta/> and
90       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
91

COPYRIGHT

93       Copyright (C) 2016-2021 all contributors <mailto:meta@public-inbox.org>
94
95       License: AGPL-3.0+ <http://www.gnu.org/licenses/agpl-3.0.txt>
96