Moving documentation from source code to README
authorjervfors <jervfors@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Thu, 7 Apr 2005 16:22:35 +0000 (16:22 +0000)
committerjervfors <jervfors@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Thu, 7 Apr 2005 16:22:35 +0000 (16:22 +0000)
git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@9220 7612ce4b-ef26-0410-bec9-ea0150e637f0

plugins/filters/README
plugins/filters/config.sample.php
plugins/filters/filters.php
plugins/filters/options.php
plugins/filters/setup.php
plugins/filters/spamoptions.php

index de35371..cf30ffb 100644 (file)
@@ -1,46 +1,50 @@
 Filters Plugin
 
-IMPORTANT: I've noticed at least one version of PHP that has bugs in the
-checkdnsrr() function that the SPAM filtering code RELIES ON.  In my case,
-the PHP server that comes with Mandrake 8.1 has this problem -- checkdnsrr()
-NEVER finds the inaddr records, even the ones that really exist. (sigh)
-
-NOTE!!! As of the time of this writing, there is a bug in sqimap_read_data()
-in functions/imap_general.php.  I rewrote it (see sqimap_read_data.php) so
-if the SPAM filters aren't filtering, make a backup copy of
-functions/imap_general.php, remove the sqimap_read_data() function in there
-and replace it with the contents of sqimap_read_data.php.  Hopefully, either
-my replacement will be blessed by squirrelmail-devel or some other version
-will come out soon.  Now back to your regularly scheduled README...  (grin)
-
-This is a poor alternative to procmail or Elm's filter programs.  This is a
-pathetic replacement for good RBL mail scanning when you get the mail.  This
-is more for systems that can't/won't offer that kind of functionality and
-you still require it.
-
-This is slow.  Yep.  Slow.
-
-
-To configure, first you need to rename config.sample.php to config.php.
-You should then just take a peek at config.php and set
-$SpamFilters_YourHop to some string if you want to avoid tons of false
-hits on the RSS and DUL and ORBS databases.  It should also speed up the
-scan somewhat.  
-
-If you do not want to enable spam filters for all users, edit config.php and
-set the $AllowSpamFilters to false.  Spam filters can take TONS of time, so
-if you don't want your users to complain and ask you tons of questions, this
-is a quick and easy method.
-
-If you use UW and if you encounter strange errors while using this plugin on 
-your system, edit config.php and set $UseSeparateImapConnection to true.  This
-may not solve the problem.  One problem it might fix is if you run UW 2001
-and if you don't see the number of unread messages in your left-hand folder
-pane, or if you see timeouts or IMAP server error messages.  Turning on this
-feature may slow down the filters a bit more since it has to open a new
-connection.
-
-Lastly, if there are some IPs that you want to refuse email from or some IPs
-you want to accept email from REGARDLESS of what the DNS databases say, you
-can put in overrides in the SpamFilters_DNScache[] array.  See the comments
-in config.php for more info on this.
+This plugin filters your inbox into different folders based upon given criteria.
+It is most useful for people who are subscibed to mailing lists to help organize
+their messages. The argument stands that filtering is not the place of the
+client, which is why this has been made a plugin for SquirrelMail. You may be
+better off using products such as Sieve or Procmail to do your filtering so it
+happens even when SquirrelMail isn't running.
+
+IMPORTANT: At least one version of PHP has bugs in the checkdnsrr() function
+that the SPAM filtering code RELIES ON. The PHP server that comes with Mandrake
+8.1 has this problem -- checkdnsrr() NEVER finds the inaddr records, even the
+ones that really exist.
+
+NOTE!!! As of the time of this writing, there is a bug in sqimap_read_data() in
+functions/imap_general.php. I rewrote it (see sqimap_read_data.php) so if the
+SPAM filters aren't filtering, make a backup copy of functions/imap_general.php,
+remove the sqimap_read_data() function in there and replace it with the contents
+of sqimap_read_data.php. Hopefully, either my replacement will be blessed by
+squirrelmail-devel or some other version will come out soon. Now back to your
+regularly scheduled README... (grin)
+
+This is a poor alternative to procmail or Elm's filter programs. This is a
+pathetic replacement for good RBL mail scanning when you get the mail. This is
+more for systems that can't/won't offer that kind of functionality and you still
+require it.
+
+This is slow. Yep. Slow.
+
+To configure, first you need to rename config.sample.php to config.php. You
+should then just take a peek at config.php and set $SpamFilters_YourHop to some
+string if you want to avoid tons of false hits on the RSS and DUL and ORBS
+databases. It should also speed up the scan somewhat.
+
+If you do not want to enable spam filters for all users, edit config.php and set
+the $AllowSpamFilters to false. Spam filters can take TONS of time, so if you
+don't want your users to complain and ask you tons of questions, this is a quick
+and easy method.
+
+If you use UW and if you encounter strange errors while using this plugin on
+your system, edit config.php and set $UseSeparateImapConnection to true. This
+may not solve the problem. One problem it might fix is if you run UW 2001 and if
+you don't see the number of unread messages in your left-hand folder pane, or if
+you see timeouts or IMAP server error messages. Turning on this feature may slow
+down the filters a bit more since it has to open a new connection.
+
+Lastly, if there are some IPs that you want to refuse email from or some IPs you
+want to accept email from REGARDLESS of what the DNS databases say, you can put
+in overrides in the SpamFilters_DNScache[] array. See the comments in config.php
+for more info on this.
index d405bfe..0764dc6 100644 (file)
@@ -2,22 +2,6 @@
 /**
  * Message and Spam Filter Plugin - Setup script
  *
- * This plugin filters your inbox into different folders based upon given
- * criteria.  It is most useful for people who are subscibed to mailing lists
- * to help organize their messages.  The argument stands that filtering is
- * not the place of the client, which is why this has been made a plugin for
- * SquirrelMail.  You may be better off using products such as Sieve or
- * Procmail to do your filtering so it happens even when SquirrelMail isn't
- * running.
- *
- * If you need help with this, or see improvements that can be made, please
- * email me directly at the address above.  I definately welcome suggestions
- * and comments.  This plugin, as is the case with all SquirrelMail plugins,
- * is not directly supported by the developers.  Please come to me off the
- * mailing list if you have trouble with it.
- *
- * Also view plugins/README.plugins for more information.
- *
  * @version $Id$
  * @copyright (c) 1999-2005 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
index 997ffc3..be2c1a0 100644 (file)
@@ -2,22 +2,6 @@
 /**
  * Message and Spam Filter Plugin - Filtering Functions
  *
- * This plugin filters your inbox into different folders based upon given
- * criteria.  It is most useful for people who are subscibed to mailing lists
- * to help organize their messages.  The argument stands that filtering is
- * not the place of the client, which is why this has been made a plugin for
- * SquirrelMail.  You may be better off using products such as Sieve or
- * Procmail to do your filtering so it happens even when SquirrelMail isn't
- * running.
- *
- * If you need help with this, or see improvements that can be made, please
- * email me directly at the address above.  I definitely welcome suggestions
- * and comments.  This plugin, as is the case with all SquirrelMail plugins,
- * is not directly supported by the developers.  Please come to me off the
- * mailing list if you have trouble with it.
- *
- * Also view plugins/README.plugins for more information.
- *
  * @version $Id$
  * @copyright (c) 1999-2005 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
index 122bd37..58147c5 100644 (file)
@@ -2,22 +2,6 @@
 /**
  * Message and Spam Filter Plugin - Filtering Options
  *
- * This plugin filters your inbox into different folders based upon given
- * criteria. It is most useful for people who are subscibed to mailing lists
- * to help organize their messages.  The argument stands that filtering is
- * not the place of the client, which is why this has been made a plugin for
- * SquirrelMail.  You may be better off using products such as Sieve or
- * Procmail to do your filtering so it happens even when SquirrelMail isn't
- * running.
- *
- * If you need help with this, or see improvements that can be made, please
- * email me directly at the address above.  I definately welcome suggestions
- * and comments.  This plugin, as is the case with all SquirrelMail plugins,
- * is not directly supported by the developers.  Please come to me off the
- * mailing list if you have trouble with it.
- *
- * Also view plugins/README.plugins for more information.
- *
  * @version $Id$
  * @copyright (c) 1999-2005 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
index 153aaaa..f3ed928 100644 (file)
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Message and Spam Filter Plugin - Setup
+ *
  * @version $Id$
  * @copyright (c) 1999-2005 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
index 83db830..26bb53c 100644 (file)
@@ -2,22 +2,6 @@
 /**
  * Message and Spam Filter Plugin - Spam Options
  *
- * This plugin filters your inbox into different folders based upon given
- * criteria.  It is most useful for people who are subscibed to mailing lists
- * to help organize their messages.  The argument stands that filtering is
- * not the place of the client, which is why this has been made a plugin for
- * SquirrelMail.  You may be better off using products such as Sieve or
- * Procmail to do your filtering so it happens even when SquirrelMail isn't
- * running.
- *
- * If you need help with this, or see improvements that can be made, please
- * email me directly at the address above.  I definately welcome suggestions
- * and comments.  This plugin, as is the case with all SquirrelMail plugins,
- * is not directly supported by the developers.  Please come to me off the
- * mailing list if you have trouble with it.
- *
- * Also view plugins/README.plugins for more information.
- *
  * @version $Id$
  * @copyright (c) 1999-2005 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License