A start for a new change_password master plugin. This is not finished
[squirrelmail.git] / plugins / filters / setup.php
1 <?php
2 /**
3 * Message and Spam Filter Plugin
4 *
5 * Copyright (c) 1999-2003 The SquirrelMail Project Team
6 * Licensed under the GNU GPL. For full terms see the file COPYING.
7 *
8 * This plugin filters your inbox into different folders based upon given
9 * criteria. It is most useful for people who are subscibed to mailing lists
10 * to help organize their messages. The argument stands that filtering is
11 * not the place of the client, which is why this has been made a plugin for
12 * SquirrelMail. You may be better off using products such as Sieve or
13 * Procmail to do your filtering so it happens even when SquirrelMail isn't
14 * running.
15 *
16 * If you need help with this, or see improvements that can be made, please
17 * email me directly at the address above. I definately welcome suggestions
18 * and comments. This plugin, as is the case with all SquirrelMail plugins,
19 * is not directly supported by the developers. Please come to me off the
20 * mailing list if you have trouble with it.
21 *
22 * Also view plugins/README.plugins for more information.
23 *
24 * $Id$
25 * @package plugins
26 * @subpackage filters
27 */
28
29 /** SquirrelMail required files. */
30 require_once(SM_PATH . 'plugins/filters/filters.php');
31
32 /*
33 * Set this to true if you have problems -- check the README file
34 * Note: This doesn't work all of the time (No idea why)
35 * Seems to be related to UW
36 */
37 global $UseSeparateImapConnection;
38 $UseSeparateImapConnection = false;
39
40 /*
41 * Set this to false if you do not want the user to be able to enable
42 * spam filters
43 */
44 global $AllowSpamFilters;
45 $AllowSpamFilters = true;
46
47 /*
48 * Set this to a string containing something unique to the line in the
49 * header you want me to find IPs to scan the databases with. For example,
50 * All the email coming IN from the internet to my site has a line in
51 * the header that looks like (all on one line):
52 * Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
53 * [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
54 * 0.2) with
55 * Since this line indicates the FIRST hop the email takes into my network,
56 * I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
57 * case-sensitive string will do. You can set it to something found on
58 * every line in the header (like ' ') if you want to scan all IPs in
59 * the header (lots of false alarms here tho).
60 */
61 global $SpamFilters_YourHop;
62 $SpamFilters_YourHop = ' ';
63
64 /*
65 * Some of the SPAM filters are COMMERCIAL and require a fee. If your users
66 * select them and you're not allowed to use them, it will make SPAM filtering
67 * very slow. If you don't want them to even be offered to the users, you
68 * should set SpamFilters_ShowCommercial to false.
69 */
70 global $SpamFilters_ShowCommercial;
71 $SpamFilters_ShowCommercial = false;
72
73 /*
74 * A cache of IPs we've already checked or are known bad boys or good boys
75 * ie. $SpamFilters_DNScache["210.54.220.18"] = true;
76 * would tell filters to not even bother doing the DNS queries for that
77 * IP and any email coming from it are SPAM - false would mean that any
78 * email coming from it would NOT be SPAM
79 */
80 global $SpamFilters_DNScache;
81
82 /*
83 * Absolute path to the bulkquery program. Leave blank if you don't have
84 * bulkquery compiled, installed, and lwresd running. See the README file
85 * in the bulkquery directory for more information on using bulkquery.
86 */
87 global $SpamFilters_BulkQuery;
88 $SpamFilters_BulkQuery = '';
89
90 /*
91 * Do you want to use a shared file for the DNS cache or a session variable?
92 * Using a shared file means that every user can benefit from any queries
93 * made by other users. The shared file is named "dnscache" and is in the
94 * data directory.
95 */
96 global $SpamFilters_SharedCache;
97 $SpamFilters_SharedCache = true;
98
99 /*
100 * How long should DNS query results be cached for by default (in seconds)?
101 */
102 global $SpamFilters_CacheTTL;
103 $SpamFilters_CacheTTL = 7200;
104
105 function squirrelmail_plugin_init_filters() {
106 global $squirrelmail_plugin_hooks;
107
108 if (isset($_GET['mailbox'])) {
109 $mailbox = $_GET['mailbox'];
110 }
111 elseif (isset($_POST['mailbox'])) {
112 $mailbox = $_POST['mailbox'];
113 }
114 else {
115 $mailbox = 'INBOX';
116 }
117
118 $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
119 if (isset($mailbox) && $mailbox == 'INBOX') {
120 $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters';
121 }
122 $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'filters_optpage_register_block';
123 # $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
124 $squirrelmail_plugin_hooks['rename_or_delete_folder']['filters'] = 'update_for_folder';
125 $squirrelmail_plugin_hooks['webmail_bottom']['filters'] = 'start_filters';
126 }
127
128 function filters_special_mailbox( $mb ) {
129 GLOBAL $data_dir, $username;
130
131 return( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) );
132
133 }
134
135 function filters_optpage_register_block() {
136 global $optpage_blocks;
137 global $AllowSpamFilters;
138
139 $optpage_blocks[] = array(
140 'name' => _("Message Filters"),
141 'url' => '../plugins/filters/options.php',
142 'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
143 'js' => false
144 );
145
146 if ($AllowSpamFilters) {
147 $optpage_blocks[] = array(
148 'name' => _("SPAM Filters"),
149 'url' => '../plugins/filters/spamoptions.php',
150 'desc' => _("SPAM filters allow you to select from various DNS based blacklists to detect junk email in your INBOX and move it to another folder (like Trash)."),
151 'js' => false
152 );
153 }
154 }
155 ?>