/plugins/sasql/sasql_conf_sample.php
NaSMail Sasql Plugin - Sample configuration file
Copyright (c) 2006-2007 Randy Smith <perlstalker@vuser.org> Copyright (c) 2007 The NaSMail Project This file is part of NaSMail sasql plugin. It is based on SquirrelMail sasql plugin.
This plugin is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This plugin is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with plugin; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
array
$allowed_params
(line 191)
Allowed SpamAssassin paramaters.
These values must be defined in $sa_params below. Currently defined values: 'required_hits', 'rewrite_subject', 'use_terse_report', 'use_dcc', 'use_razor1', 'use_razor2', 'always_add_headers', 'subject_tag', 'ok_languages' See sa_opts-dist.php for a complete list of supported parameters.
array
$allowed_sections
(line 236)
Displayed configuration sections
This will insert the file $section.inc into sasql_options.php where $section is the an element from $allowed_sections. You can use this to add custom sections to your installation or reorder sections to match your tastes. Sections: General Sections: purge => Purge Spam Folder Button
SpamAssassin Sections: sa_abooksync => Sync Address Book with Whitelist sa_whitelist => Manage SA White/blacklists sa_settings => Manage SA settings bayes_stats => Display the number of messages learned as Ham or Spam Note: sa_abooksync needs to be before sa_whitelist or changes won't be immediately visable.
dspam Sections: dspam => opt-in/out of dpam dspam_primer => A brief description of dspam and comparison to SA
policyd Sections: policyd => Allows users to opt-in/out of greylisting in policyd policyd_docs => User documentation for policyd options.
Section tools to make combining sections in to blocks. NOTE: The first start_section and last end_section are done for you. start_section => Start a new section block. end_section => End a Section block divider => shortcut for the common end_section, start_section case.
array
$allowed_wl_params
(line 198)
Allowed whitelist/blacklist options
array
$bayes_vars_cols
(line 74)
bayes_vars table columns The defaults should be fine for most people.
array
$columns
(line 47)
Table columns.
The defaults should work for most plain vanilla SpamAssassin installations. Some people, however, use different column names and custom selects. This allows those special people to change the columns easily here.
string
$globalUsername
(line 173)
Global settings username key used to define system-wide preferences
string
$learn_fp_folder
(line 138)
Set to '' to disable.
The included process-spam.pl script provides a way to learn messages moved into these folders.
string
$SABayesDSN
(line 61)
DSN for Bayes DB
SpamAssassin allows you to use a different DB for bayes. You can make this the same as the userpref DB by doing $SABayesDSN = $SqlDSN; This is only used by the bayes_stats section which is not enabled by default.
string
$SABayesVarsTable
(line 67)
SpamAssassin bayes_vars table
boolean
$sasql_learn_option
(line 128)
If set to True, then the option to learn the message as spam will be a link in the options line, otherwise it will be a button at the bottom of the message. Note: This has no effect if $sasql_use_learn is False.
boolean
$sasql_use_learn
(line 120)
If you plan on using the process-spam.pl script or your own home grown version, then setting this to True will allow the storage of emails on your server for later processing through sa_learn.
boolean
$sasql_use_salearn
(line 167)
Setting controls options that allow to feed spam and ham messages to sa-learn
command line utility. $spam_folder setting must be set to correct value. sa-learn and env utilities must be available in PATH. If PHP safe_mode is enabled, path to sa-learn and env utilities must be set in PHP safe_mode_exec_dir
If option is enabled in older SquirrelMail versions, it will remain invisible. If option is enabled in older PHP version, scripts will break with fatal errors.
boolean
$show_report_score
(line 155)
Show the message's score in the spam report.
$show_spam_report must also be set.
boolean
$show_spam_report
(line 148)
Show a spam report in the message headers.
This will only show something if the 'X-Spam-Status' header is present in the message. This option only works with NaSMail 1.1+ or with the patch at https://sourceforge.net/tracker/?func=detail&aid=1589520&group_id=311&atid=300311
string
$spam_folder
(line 105)
The name of the spam folder. Do not include the prefix if it is already
defined in the NaSMail config already, i.e. if you have set $default_folder_prefix in your config.php then set this variable to be 'Spam'. If you don't have $default_folder_prefix set globally and your IMAP server does have a require folder prefix, then you may need to define this variable as 'INBOX.Spam'.
boolean
$special_spam_folder
(line 94)
Make the $spam_folder below, a special folder.
If set to some true value, the spam folder will be auto created. If you wish to make use of the Purge Spam Folder button, then this will need to be set to true
string
$SqlDSN
(line 31)
DSN for DB
string
$SqlTable
(line 37)
SpamAssassin userprefs table
boolean
$use_quick_link
(line 112)
Add a link to the Options line in message header view to add/delete a message address to the white/black list.
Documentation generated on Sun, 22 Nov 2009 17:36:45 +0200 by phpDocumentor 1.4.3