Set default value of YourHop
[squirrelmail.git] / plugins / filters / setup.php
CommitLineData
849bdf42 1<?php
4eee5968 2 /**
3 ** Message and Spam Filter Plugin
4 **
5 ** Copyright (c) 1999-2001 The Squirrelmail Development 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 **/
849bdf42 27
28 // Set this to true if you have problems -- check the README file
29 // Note: This doesn't work all of the time (No idea why)
30 // Seems to be related to UW
31 global $UseSeparateImapConnection;
32 $UseSeparateImapConnection = false;
3fd1252d 33
849bdf42 34 // Set this to false if you do not want the user to be able to enable
35 // spam filters
36 global $AllowSpamFilters;
37 $AllowSpamFilters = true;
3fd1252d 38
849bdf42 39 // Set this to a string containing something unique to the line in the
40 // header you want me to find IPs to scan the databases with. For example,
41 // All the email coming IN from the internet to my site has a line in
42 // the header that looks like (all on one line):
43 // Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
44 // [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
45 // 0.2) with
46 // Since this line indicates the FIRST hop the email takes into my network,
47 // I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
48 // case-sensitive string will do. You can set it to something found on
49 // every line in the header (like ' ') if you want to scan all IPs in
50 // the header (lots of false alarms here tho).
51
52 global $SpamFilters_YourHop;
e770f7b7 53 $SpamFilters_YourHop = ' ';
849bdf42 54
55 // A cache of IPs we've already checked or are known bad boys or good boys
3fd1252d 56 // ie. $SpamFilters_DNScache["210.54.220.18"] = true;
849bdf42 57 // would tell filters to not even bother doing the DNS queries for that
58 // IP and any email coming from it are SPAM - false would mean that any
59 // email coming from it would NOT be SPAM
60 global $SpamFilters_DNScache;
61
3fd1252d 62 require_once ('../plugins/filters/filters.php');
849bdf42 63
64 function squirrelmail_plugin_init_filters() {
65 global $squirrelmail_plugin_hooks;
66 global $mailbox, $imap_stream, $imapConnection;
67
3fd1252d 68 $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
69 if ($mailbox == 'INBOX')
70 $squirrelmail_plugin_hooks["right_main_after_header"]['filters'] = 'start_filters';
cbe5423b 71 $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'squirrelmail_plugin_optpage_register_block';
849bdf42 72 }
73
cbe5423b 74 function squirrelmail_plugin_optpage_register_block() {
75 global $optpage_blocks;
eec81600 76 global $AllowSpamFilters;
849bdf42 77
cbe5423b 78 $optpage_blocks[] = array(
3fd1252d 79 'name' => _("Message Filters"),
849bdf42 80 'url' => '../plugins/filters/options.php',
3fd1252d 81 'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
849bdf42 82 'js' => false
83 );
eec81600 84
85 if ($AllowSpamFilters) {
86 $optpage_blocks[] = array(
87 'name' => _("SPAM Filters"),
88 'url' => '../plugins/filters/spamoptions.php',
89 '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)."),
90 'js' => false
91 );
92 }
849bdf42 93 }
cbe5423b 94?>