Spamassassin - Administrator Settings

These settings differ from the other spamassassin options and settings, in that they are considered 'more privileged' -- even more than the ones in the SETTINGS section. No matter what allow_user_rules is set to, these can never be set from a user's user_prefs file.

test SYMBOLIC_TEST_NAME (ok|fail) Some string to test against
Define a regression testing string. You can have more than one regression test string per symbolic test name. Simply specify a string that you wish the test to match.

These tests are only run as part of the test suite - they should not affect the general running of SpamAssassin.

razor_config filename
Define the filename used to store Razor's configuration settings. Currently this is left to Razor to decide.
pyzor_path STRING
This option tells SpamAssassin specifically where to find the pyzor client instead of relying on SpamAssassin to find it in the current PATH. Note that if taint mode is enabled in the Perl interpreter, you should use this, as the current PATH will have been cleared.
dcc_home STRING
This option tells SpamAssassin specifically where to find the dcc homedir. If dcc_path is not specified, it will default to looking in dcc_home/bin for dcc client instead of relying on SpamAssassin to find it in the current PATH. If it isn't found there, it will look in the current PATH. If a dccifd socket is found in dcc_home, it will use that interface that instead of dccproc.
dcc_dccifd_path STRING
This option tells SpamAssassin specifically where to find the dccifd socket. If dcc_dccifd_path is not specified, it will default to looking in dcc_home If a dccifd socket is found, it will use it instead of dccproc.
dcc_path STRING
This option tells SpamAssassin specifically where to find the dccproc client instead of relying on SpamAssassin to find it in the current PATH. Note that if taint mode is enabled in the Perl interpreter, you should use this, as the current PATH will have been cleared.
dcc_options options
Specify additional options to the dccproc(8) command. Please note that only [A-Z -] is allowed (security).

The default is -R

use_auto_whitelist ( 0 | 1 ) (default: 1)
Whether to use auto-whitelists. Auto-whitelists track the long-term average score for each sender and then shift the score of new messages toward that long-term average. This can increase or decrease the score for messages, depending on the long-term behavior of the particular correspondent.

For more information about the auto-whitelist system, please look at the the Automatic Whitelist System section of the README file. The auto-whitelist is not intended as a general-purpose replacement for static whitelist entries added to your config files.

auto_whitelist_factory module (default: Mail::SpamAssassin::DBBasedAddrList)
Select alternative whitelist factory module.
auto_whitelist_path /path/to/file (default: ~/.spamassassin/auto-whitelist)
Automatic-whitelist directory or file. By default, each user has their own, in their ~/.spamassassin directory with mode 0700, but for system-wide SpamAssassin use, you may want to share this across all users.
bayes_path /path/to/file (default: ~/.spamassassin/bayes)
Path for Bayesian probabilities databases. Several databases will be created, with this as the base, with _toks, _seen etc. appended to this filename; so the default setting results in files called ~/.spamassassin/bayes_seen, ~/.spamassassin/bayes_toks etc.

By default, each user has their own, in their ~/.spamassassin directory with mode 0700/0600, but for system-wide SpamAssassin use, you may want to reduce disk space usage by sharing this across all users. (However it should be noted that Bayesian filtering appears to be more effective with an individual database per user.)

auto_whitelist_file_mode (default: 0700)
The file mode bits used for the automatic-whitelist directory or file.

Make sure you specify this using the 'x' mode bits set, as it may also be used to create directories. However, if a file is created, the resulting file will not have any execute bits set (the umask is set to 111).

bayes_file_mode (default: 0700)
The file mode bits used for the Bayesian filtering database files.

Make sure you specify this using the 'x' mode bits set, as it may also be used to create directories. However, if a file is created, the resulting file will not have any execute bits set (the umask is set to 111).

bayes_use_hapaxes (default: 1)
Should the Bayesian classifier use hapaxes (words/tokens that occur only once) when classifying? This produces significantly better hit-rates, but increases database size by about a factor of 8 to 10.
bayes_use_chi2_combining (default: 1)
Should the Bayesian classifier use chi-squared combining, instead of Robinson/Graham-style naive Bayesian combining? Chi-squared produces more 'extreme' output results, but may be more resistant to changes in corpus size etc.
bayes_journal_max_size (default: 102400)
SpamAssassin will opportunistically sync the journal and the database. It will do so at least once a day, but can also sync if the file size goes above this setting, in bytes. If set to 0, the journal sync will only occur once a day.
bayes_expiry_max_db_size (default: 150000)
What should be the maximum size of the Bayes tokens database? When expiry occurs, the Bayes system will keep either 75% of the maximum value, or 100,000 tokens, whichever has a larger value. 150,000 tokens is roughly equivalent to a 8Mb database file.
bayes_auto_expire (default: 1)
If enabled, the Bayes system will try to automatically expire old tokens from the database. Auto-expiry occurs when the number of tokens in the database surpasses the bayes_expiry_max_db_size value.
bayes_learn_to_journal (default: 0)
If this option is set, whenever SpamAssassin does Bayes learning, it will put the information into the journal instead of directly into the database. This lowers contention for locking the database to execute an update, but will also cause more access to the journal and cause a delay before the updates are actually committed to the Bayes database.
user_scores_dsn DBI:databasetype:databasename:hostname:port
If you load user scores from an SQL database, this will set the DSN used to connect. Example: DBI:mysql:spamassassin:localhost
user_scores_sql_username username
The authorized username to connect to the above DSN.
user_scores_sql_password password
The password for the database username, for the above DSN.
user_scores_sql_table tablename
The table user preferences are stored in, for the above DSN.
user_scores_sql_field_username field_username
The field that the username whose preferences you're looking up is stored in. Default: username.
user_scores_sql_field_preference field_preference
The name of the preference that you're looking for. Default: preference.
user_scores_sql_field_value field_value
The name of the value you're looking for. Default: value.
user_scores_sql_field_scope field_scope
The 'scope' field. In Horde this makes the preference a single-module preference or a global preference. There's no real need to change it in other systems. Default: spamassassin.