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