confighelp

spamtrap_confighelp_code

 24
 25 if confighelp then
 26   rspamd_config:add_example(nil, 'spamtrap',
 27     "Honeypot spamtrap module to learn spam emails",
 28     [[
 29 spamtrap {
 30     # Optionally set an action
 31     #action = "no action";
 32     # A map file containing regexp entries for spamtrap emails and domains
 33     #map = file://$LOCAL_CONFDIR/maps.d/spamtrap.map
 34     # Name of the symbol
 35     #symbol = "SPAMTRAP";
 36     # A score for this module
 37     #score = 0.0;
 38     # Flag to enable fuzzy learning
 39     learn_fuzzy = false;
 40     # Flag to enable bayes spam learning
 41     learn_spam = false;
 42     # Fuzzy flag
 43     #fuzzy_flag = 1;
 44     # Fuzzy weight
 45     #fuzzy_weight = 10;
 46     # Redis key prefix
 47     #key_prefix = 'sptr_';
 48     # Skip spamtrap checks for authorized users
 49     #check_authed = true;
 50     # Skip spamtrap checks for local networks
 51     #check_local = true;
 52
 53     enabled = true;
 54 }
 55 ]])
 56
 57   rspamd_config:add_doc(M, 'action', 'An optional action',
 58     {type='string'})
 59   rspamd_config:add_doc(M, 'map', 'A map file containing regexp entries for spamtrap emails and domains',
 60     {type='string'})
 61   rspamd_config:add_doc(M, 'symbol', 'Name of the symbol',
 62     {default='SPAMTRAP', type='string'})
 63   rspamd_config:add_doc(M, 'score', 'A score for this module',
 64     {default=0.0, type='number'})
 65   rspamd_config:add_doc(M, 'learn_fuzzy', 'Flag to enable fuzzy learning',
 66     {default=false, type='boolean'})
 67   rspamd_config:add_doc(M, 'learn_spam', 'Flag to enable bayes spam learning',
 68     {default=false, type='boolean'})
 69   rspamd_config:add_doc(M, 'fuzzy_flag', 'Fuzzy flag for the spam class',
 70     {default=1, type'number'})
 71   rspamd_config:add_doc(M, 'fuzzy_weight', 'Fuzzy weight',
 72     {default=10.0, type='number'})
 73   rspamd_config:add_doc(M, 'key_prefix', 'Redis key prefix',
 74     {default='sptr_', type='string'})
 75   rspamd_config:add_doc(M, 'check_authed', 'Skip spamtrap checks for authorized users',
 76     {default=true, type='boolean'})
 77   rspamd_config:add_doc(M, 'check_local', 'Skip spamtrap checks for local networks',
 78     {default=true, type='boolean'})
 79   return
 80 end
 81