Mercurial > prosody-modules
comparison mod_firewall/scripts/spam-blocking.pfw @ 2571:a33edc07d829
mod_firewall: spam-blocking.pfw: More comments for documentation
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Fri, 24 Feb 2017 15:58:37 +0000 |
| parents | 5e1fb7e6b558 |
| children | 8908d001faf3 |
comparison
equal
deleted
inserted
replaced
| 2570:548b68ae793b | 2571:a33edc07d829 |
|---|---|
| 1 #### Anti-spam ruleset ########################################### | 1 #### Anti-spam ruleset ########################################### |
| 2 # This script provides some foundational anti-spam | 2 # |
| 3 # rules. It does not do any form of content filtering, | 3 # This script provides some foundational anti-spam rules. It aims |
| 4 # to PASS stanzas that are definitely not spam, and DROP stanzas | |
| 5 # that are very likely spam. | |
| 6 # | |
| 7 # It does not do any form of content filtering, | |
| 4 # but this can be implemented by other scripts and | 8 # but this can be implemented by other scripts and |
| 5 # modules as desired. | 9 # modules as desired using the chains documented below. |
| 10 # | |
| 6 # | 11 # |
| 7 # The following chains are available as extension | 12 # The following chains are available as extension |
| 8 # points: | 13 # points: |
| 9 # | 14 # |
| 15 # ::user/spam_check_custom | |
| 16 # Apply additional rules to all stanzas before they are checked. | |
| 17 # Mainly useful to PASS stanzas that you do not want to be | |
| 18 # filtered. | |
| 19 # | |
| 10 # ::user/spam_check_message_custom | 20 # ::user/spam_check_message_custom |
| 11 # Apply additional rules to messages from strangers | 21 # Apply additional rules to messages from strangers, aiming to |
| 22 # PASS stanzas that are not spam and jump to ::user/spam_reject | |
| 23 # for stanzas that are considered spam. | |
| 12 # | 24 # |
| 13 # ::user/spam_check_message_content | 25 # ::user/spam_check_message_content |
| 14 # Apply additional rules to messages that may be spam | 26 # Apply additional rules to messages that may be spam, based on |
| 27 # message content rules. These may contain more intensive rules, | |
| 28 # so are executed after all other checks. Rules should jump to | |
| 29 # ::user/spam_reject if a message is considered spam. | |
| 15 # | 30 # |
| 16 # ::user/spam_check_presence_custom | 31 # ::user/spam_check_presence_custom |
| 17 # Apply additional rules to presence that may be spam | 32 # Apply additional rules to presence that may be spam. |
| 18 # | 33 # |
| 19 # ::user/spam_check_subscription_request | 34 # ::user/spam_check_subscription_request |
| 20 # Apply additional rules to subscription requests | 35 # Apply additional rules to subscription requests. |
| 21 # | 36 # |
| 22 # ::user/spam_handle_unknown_custom | 37 # ::user/spam_handle_unknown_custom |
| 23 # Override default handling of stanzas that weren't explicitly | 38 # Override default handling of stanzas that weren't explicitly |
| 24 # passed or rejected by the anti-spam checks | 39 # passed or rejected by the anti-spam checks. |
| 25 # | 40 # |
| 26 # ::user/spam_reject_custom | 41 # ::user/spam_reject_custom |
| 27 # Override default handling of stanzas that have | 42 # Override default handling of stanzas that have |
| 28 # been recognised as spam (default is to bounce | 43 # been recognised as spam (default is to bounce |
| 29 # a policy-violation error) | 44 # a policy-violation error). |
| 30 # | 45 # |
| 31 ################################################################## | 46 ################################################################## |
| 32 | 47 |
| 33 #### Entry point for all incoming stanzas ######################## | 48 #### Entry point for all incoming stanzas ######################## |
| 34 ::deliver | 49 ::deliver |
