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