Add ability to show login error from the IMAP server instead of traditional "Unknown...
[squirrelmail.git] / plugins / filters / README
CommitLineData
7aa22276 1Filters Plugin
849bdf42 2
e5c8ec61 3ABOUT PLUGIN
4------------
5This plugin sorts messages in your inbox into different folders based upon
6given criteria. It is most useful for people who are subscribed to mailing
7lists to help organize their messages. The argument stands that filtering is
8not the place of the client, which is why this has been made a plugin for
9SquirrelMail. You may be better off using products such as Sieve, Maildrop or
10Procmail to do your filtering so it happens even when SquirrelMail isn't
11running.
15d98101 12
13IMPORTANT: At least one version of PHP has bugs in the checkdnsrr() function
14that the SPAM filtering code RELIES ON. The PHP server that comes with Mandrake
158.1 has this problem -- checkdnsrr() NEVER finds the inaddr records, even the
16ones that really exist.
17
15d98101 18This is a poor alternative to procmail or Elm's filter programs. This is a
19pathetic replacement for good RBL mail scanning when you get the mail. This is
e5c8ec61 20more for systems that can't/won't offer that kind of functionality and you
21still require it.
15d98101 22
23This is slow. Yep. Slow.
24
e5c8ec61 25INSTALLATION
26------------
27Plugin is installed by enabling it in SquirrelMail configuration script.
28Plugin configuration can be changed with configuration files stored in
29config/filters_config.php or plugins/filters/config.php. Default configuration
30values can be found in plugins/filters/config_default.php. If both
31configuration files are present, plugin uses file from config directory.
32
33Main configuration option that must be changed is $SpamFilters_YourHop setting.
34See comments about it in config_default.php. If $SpamFilters_YourHop uses
35default value, plugin will be unable to use RBL filtering correctly and
36warning message will is displayed to end user. If you don't want to use RBL
37filtering, you can disable it by setting $AllowSpamFilters option to false. If
38you can control your incoming SMTP server, it is recommended to turn RBL
39filtering on server.
15d98101 40
41If you use UW and if you encounter strange errors while using this plugin on
e5c8ec61 42your system, edit configuration file and set $UseSeparateImapConnection to
43true. This may not solve the problem. One problem it might fix is if you run UW
442001 and if you don't see the number of unread messages in your left-hand
45folder pane, or if you see timeouts or IMAP server error messages. Turning on
46this feature may slow down the filters a bit more since it has to open a new
47connection.
48
49Lastly, if there are some IPs that you want to refuse email from or some IPs
50you want to accept email from REGARDLESS of what the DNS databases say, you can
51put in overrides in the SpamFilters_DNScache[] array. See the comments in
52config_default.php for more info on this.