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