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