Trimming whitespace and replacing tabs
[squirrelmail.git] / plugins / filters / README
7aa22276 1Filters Plugin
849bdf42 2
15d98101 3This plugin filters your inbox into different folders based upon given criteria.
4It is most useful for people who are subscibed to mailing lists to help organize
5their messages. The argument stands that filtering is not the place of the
6client, which is why this has been made a plugin for SquirrelMail. You may be
7better off using products such as Sieve or Procmail to do your filtering so it
8happens even when SquirrelMail isn't running.
10IMPORTANT: At least one version of PHP has bugs in the checkdnsrr() function
11that the SPAM filtering code RELIES ON. The PHP server that comes with Mandrake
128.1 has this problem -- checkdnsrr() NEVER finds the inaddr records, even the
13ones that really exist.
15NOTE!!! As of the time of this writing, there is a bug in sqimap_read_data() in
16functions/imap_general.php. I rewrote it (see sqimap_read_data.php) so if the
17SPAM filters aren't filtering, make a backup copy of functions/imap_general.php,
18remove the sqimap_read_data() function in there and replace it with the contents
19of sqimap_read_data.php. Hopefully, either my replacement will be blessed by
20squirrelmail-devel or some other version will come out soon. Now back to your
21regularly scheduled README... (grin)
23This is a poor alternative to procmail or Elm's filter programs. This is a
24pathetic replacement for good RBL mail scanning when you get the mail. This is
25more for systems that can't/won't offer that kind of functionality and you still
26require it.
28This is slow. Yep. Slow.
30To configure, first you need to rename config.sample.php to config.php. You
31should then just take a peek at config.php and set $SpamFilters_YourHop to some
32string if you want to avoid tons of false hits on the RSS and DUL and ORBS
33databases. It should also speed up the scan somewhat.
35If you do not want to enable spam filters for all users, edit config.php and set
36the $AllowSpamFilters to false. Spam filters can take TONS of time, so if you
37don't want your users to complain and ask you tons of questions, this is a quick
38and easy method.
40If you use UW and if you encounter strange errors while using this plugin on
41your system, edit config.php and set $UseSeparateImapConnection to true. This
42may not solve the problem. One problem it might fix is if you run UW 2001 and if
43you don't see the number of unread messages in your left-hand folder pane, or if
44you see timeouts or IMAP server error messages. Turning on this feature may slow
45down the filters a bit more since it has to open a new connection.
47Lastly, if there are some IPs that you want to refuse email from or some IPs you
48want to accept email from REGARDLESS of what the DNS databases say, you can put
49in overrides in the SpamFilters_DNScache[] array. See the comments in config.php
50for more info on this.