[squirrelmail.git] / plugins / filters / config.sample.php

<?php
/**
 * Message and Spam Filter Plugin - Setup script
 *
 * @version $Id$
 * @copyright (c) 1999-2005 The SquirrelMail Project Team
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
 * @package plugins
 * @subpackage filters
 */

/**
 * Imap connection control
 *
 * Set this to true if you have problems -- check the README file
 * Note:  This doesn't work all of the time (No idea why)
 *        Seems to be related to UW
 * @global bool $UseSeparateImapConnection
 */

global $UseSeparateImapConnection;
$UseSeparateImapConnection = false;

/**
 * User level spam filters control
 *
 * Set this to false if you do not want the user to be able to enable
 * spam filters
 * @global bool $AllowSpamFilters
 */

global $AllowSpamFilters;
$AllowSpamFilters = true;

/**
 * SpamFilters YourHop Setting
 *
 * Set this to a string containing something unique to the line in the
 * header you want me to find IPs to scan the databases with.  For example,
 * All the email coming IN from the internet to my site has a line in
 * the header that looks like (all on one line):
 * Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
 *    [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
 *     0.2) with
 * Since this line indicates the FIRST hop the email takes into my network,
 * I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
 * case-sensitive string will do.  You can set it to something found on
 * every line in the header (like ' ') if you want to scan all IPs in
 * the header (lots of false alarms here tho).
 * @global string $SpamFilters_YourHop
 */

global $SpamFilters_YourHop;
$SpamFilters_YourHop = ' ';

/**
 * Commercial Spam Filters Control
 *
 * Some of the SPAM filters are COMMERCIAL and require a fee. If your users
 * select them and you're not allowed to use them, it will make SPAM filtering
 * very slow. If you don't want them to even be offered to the users, you
 * should set SpamFilters_ShowCommercial to false.
 * @global bool $SpamFilters_ShowCommercial
 */

global $SpamFilters_ShowCommercial;
$SpamFilters_ShowCommercial = false;

/**
 * SpamFiltring Cache
 *
 * A cache of IPs we've already checked or are known bad boys or good boys
 * ie. $SpamFilters_DNScache["210.54.220.18"] = true;
 * would tell filters to not even bother doing the DNS queries for that
 * IP and any email coming from it are SPAM - false would mean that any
 * email coming from it would NOT be SPAM
 * @global array $SpamFilters_DNScache
 */

global $SpamFilters_DNScache;

/**
 * Path to bulkquery program
 *
 * Absolute path to the bulkquery program. Leave blank if you don't have
 * bulkquery compiled, installed, and lwresd running. See the README file
 * in the bulkquery directory for more information on using bulkquery.
 * @global string $SpamFilters_BulkQuery
 */

global $SpamFilters_BulkQuery;
$SpamFilters_BulkQuery = '';

/**
 * Shared filtering cache control
 *
 * Do you want to use a shared file for the DNS cache or a session variable?
 * Using a shared file means that every user can benefit from any queries
 * made by other users. The shared file is named "dnscache" and is in the
 * data directory.
 * @global bool $SpamFilters_SharedCache
 */

global $SpamFilters_SharedCache;
$SpamFilters_SharedCache = true;

/**
 * DNS query TTL
 *
 * How long should DNS query results be cached for by default (in seconds)?
 * @global integer $SpamFilters_CacheTTL
 */

global $SpamFilters_CacheTTL;
$SpamFilters_CacheTTL = 7200;

?>
Commit	Line	Data
9c655416	1	<?php
	2	/**
	3	* Message and Spam Filter Plugin - Setup script
	4	*
9c655416	5	* @version $Id$
	6	* @copyright (c) 1999-2005 The SquirrelMail Project Team
	7	* @license http://opensource.org/licenses/gpl-license.php GNU Public License
	8	* @package plugins
	9	* @subpackage filters
	10	*/
	11
	12	/**
	13	* Imap connection control
	14	*
	15	* Set this to true if you have problems -- check the README file
	16	* Note: This doesn't work all of the time (No idea why)
	17	* Seems to be related to UW
	18	* @global bool $UseSeparateImapConnection
	19	*/
	20
	21	global $UseSeparateImapConnection;
	22	$UseSeparateImapConnection = false;
	23
	24	/**
	25	* User level spam filters control
	26	*
	27	* Set this to false if you do not want the user to be able to enable
	28	* spam filters
	29	* @global bool $AllowSpamFilters
	30	*/
	31
	32	global $AllowSpamFilters;
	33	$AllowSpamFilters = true;
	34
	35	/**
	36	* SpamFilters YourHop Setting
	37	*
	38	* Set this to a string containing something unique to the line in the
	39	* header you want me to find IPs to scan the databases with. For example,
	40	* All the email coming IN from the internet to my site has a line in
	41	* the header that looks like (all on one line):
	42	* Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
	43	* [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
	44	* 0.2) with
	45	* Since this line indicates the FIRST hop the email takes into my network,
	46	* I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
	47	* case-sensitive string will do. You can set it to something found on
	48	* every line in the header (like ' ') if you want to scan all IPs in
	49	* the header (lots of false alarms here tho).
	50	* @global string $SpamFilters_YourHop
	51	*/
	52
	53	global $SpamFilters_YourHop;
	54	$SpamFilters_YourHop = ' ';
	55
	56	/**
	57	* Commercial Spam Filters Control
	58	*
	59	* Some of the SPAM filters are COMMERCIAL and require a fee. If your users
	60	* select them and you're not allowed to use them, it will make SPAM filtering
	61	* very slow. If you don't want them to even be offered to the users, you
	62	* should set SpamFilters_ShowCommercial to false.
	63	* @global bool $SpamFilters_ShowCommercial
	64	*/
	65
	66	global $SpamFilters_ShowCommercial;
	67	$SpamFilters_ShowCommercial = false;
	68
69	/**
70	* SpamFiltring Cache
71	*
72	* A cache of IPs we've already checked or are known bad boys or good boys
73	* ie. $SpamFilters_DNScache["210.54.220.18"] = true;
74	* would tell filters to not even bother doing the DNS queries for that
75	* IP and any email coming from it are SPAM - false would mean that any
76	* email coming from it would NOT be SPAM
77	* @global array $SpamFilters_DNScache
78	*/
79
80	global $SpamFilters_DNScache;
81
82	/**
83	* Path to bulkquery program
84	*
85	* Absolute path to the bulkquery program. Leave blank if you don't have
86	* bulkquery compiled, installed, and lwresd running. See the README file
87	* in the bulkquery directory for more information on using bulkquery.
88	* @global string $SpamFilters_BulkQuery
89	*/
90
91	global $SpamFilters_BulkQuery;
92	$SpamFilters_BulkQuery = '';
93
94	/**
95	* Shared filtering cache control
96	*
97	* Do you want to use a shared file for the DNS cache or a session variable?
98	* Using a shared file means that every user can benefit from any queries
99	* made by other users. The shared file is named "dnscache" and is in the
100	* data directory.
101	* @global bool $SpamFilters_SharedCache
102	*/
103
104	global $SpamFilters_SharedCache;
105	$SpamFilters_SharedCache = true;
106
107	/**
108	* DNS query TTL
109	*
110	* How long should DNS query results be cached for by default (in seconds)?
111	* @global integer $SpamFilters_CacheTTL
112	*/
113
114	global $SpamFilters_CacheTTL;
115	$SpamFilters_CacheTTL = 7200;
116
117	?>