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