This commit adds the hability to add a special folder through the hook
[squirrelmail.git] / plugins / filters / setup.php
1 <?php
2 /**
3 * Message and Spam Filter Plugin
4 *
5 * Copyright (c) 1999-2002 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 */
26
27 // Set this to true if you have problems -- check the README file
28 // Note: This doesn't work all of the time (No idea why)
29 // Seems to be related to UW
30 global $UseSeparateImapConnection;
31 $UseSeparateImapConnection = false;
32
33 // Set this to false if you do not want the user to be able to enable
34 // spam filters
35 global $AllowSpamFilters;
36 $AllowSpamFilters = true;
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
51 global $SpamFilters_YourHop;
52 $SpamFilters_YourHop = ' ';
53
54 // A cache of IPs we've already checked or are known bad boys or good boys
55 // ie. $SpamFilters_DNScache["210.54.220.18"] = true;
56 // would tell filters to not even bother doing the DNS queries for that
57 // IP and any email coming from it are SPAM - false would mean that any
58 // email coming from it would NOT be SPAM
59 global $SpamFilters_DNScache;
60
61 require_once ('../plugins/filters/filters.php');
62
63 function squirrelmail_plugin_init_filters() {
64 global $squirrelmail_plugin_hooks;
65 global $mailbox, $imap_stream, $imapConnection;
66
67 $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
68 if ($mailbox == 'INBOX') {
69 $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters';
70 }
71 $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'squirrelmail_plugin_optpage_register_block';
72 $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
73 }
74
75 function filters_special_mailbox( $data, $mb ) {
76
77 if ( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) ) {
78 return( TRUE );
79 } else {
80 return( FALSE );
81 }
82 }
83
84 function squirrelmail_plugin_optpage_register_block() {
85 global $optpage_blocks;
86 global $AllowSpamFilters;
87
88 $optpage_blocks[] = array(
89 'name' => _("Message Filters"),
90 'url' => '../plugins/filters/options.php',
91 'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
92 'js' => false
93 );
94
95 if ($AllowSpamFilters) {
96 $optpage_blocks[] = array(
97 'name' => _("SPAM Filters"),
98 'url' => '../plugins/filters/spamoptions.php',
99 '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)."),
100 'js' => false
101 );
102 }
103 }
104 ?>