/**
* Message and Spam Filter Plugin
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This plugin filters your inbox into different folders based upon given
* Also view plugins/README.plugins for more information.
*
* $Id$
+ * @package plugins
+ * @subpackage filters
*/
- // Set this to true if you have problems -- check the README file
- // Note: This doesn't work all of the time (No idea why)
- // Seems to be related to UW
- global $UseSeparateImapConnection;
- $UseSeparateImapConnection = false;
-
- // Set this to false if you do not want the user to be able to enable
- // spam filters
- global $AllowSpamFilters;
- $AllowSpamFilters = true;
-
- // Set this to a string containing something unique to the line in the
- // header you want me to find IPs to scan the databases with. For example,
- // All the email coming IN from the internet to my site has a line in
- // the header that looks like (all on one line):
- // Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
- // [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
- // 0.2) with
- // Since this line indicates the FIRST hop the email takes into my network,
- // I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
- // case-sensitive string will do. You can set it to something found on
- // every line in the header (like ' ') if you want to scan all IPs in
- // the header (lots of false alarms here tho).
-
- global $SpamFilters_YourHop;
- $SpamFilters_YourHop = ' ';
-
- // A cache of IPs we've already checked or are known bad boys or good boys
- // ie. $SpamFilters_DNScache["210.54.220.18"] = true;
- // would tell filters to not even bother doing the DNS queries for that
- // IP and any email coming from it are SPAM - false would mean that any
- // email coming from it would NOT be SPAM
- global $SpamFilters_DNScache;
-
- require_once ('../plugins/filters/filters.php');
-
- function squirrelmail_plugin_init_filters() {
- global $squirrelmail_plugin_hooks;
- global $mailbox, $imap_stream, $imapConnection;
-
- $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
- if ($mailbox == 'INBOX') {
- $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters';
- }
- $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'squirrelmail_plugin_optpage_register_block';
- $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
- }
-
- function filters_special_mailbox( $mb ) {
-
- if ( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) ) {
- return( TRUE );
- } else {
- return( FALSE );
- }
- }
-
- function squirrelmail_plugin_optpage_register_block() {
- global $optpage_blocks;
- global $AllowSpamFilters;
-
- $optpage_blocks[] = array(
- 'name' => _("Message Filters"),
- 'url' => '../plugins/filters/options.php',
- 'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
- 'js' => false
- );
-
- if ($AllowSpamFilters) {
- $optpage_blocks[] = array(
+/** SquirrelMail required files. */
+require_once(SM_PATH . 'plugins/filters/filters.php');
+
+/*
+ * Set this to true if you have problems -- check the README file
+ * Note: This doesn't work all of the time (No idea why)
+ * Seems to be related to UW
+ */
+global $UseSeparateImapConnection;
+$UseSeparateImapConnection = false;
+
+/*
+ * Set this to false if you do not want the user to be able to enable
+ * spam filters
+ */
+global $AllowSpamFilters;
+$AllowSpamFilters = true;
+
+/*
+ * Set this to a string containing something unique to the line in the
+ * header you want me to find IPs to scan the databases with. For example,
+ * All the email coming IN from the internet to my site has a line in
+ * the header that looks like (all on one line):
+ * Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
+ * [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
+ * 0.2) with
+ * Since this line indicates the FIRST hop the email takes into my network,
+ * I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
+ * case-sensitive string will do. You can set it to something found on
+ * every line in the header (like ' ') if you want to scan all IPs in
+ * the header (lots of false alarms here tho).
+ */
+global $SpamFilters_YourHop;
+$SpamFilters_YourHop = ' ';
+
+/*
+ * Some of the SPAM filters are COMMERCIAL and require a fee. If your users
+ * select them and you're not allowed to use them, it will make SPAM filtering
+ * very slow. If you don't want them to even be offered to the users, you
+ * should set SpamFilters_ShowCommercial to false.
+ */
+global $SpamFilters_ShowCommercial;
+$SpamFilters_ShowCommercial = false;
+
+/*
+ * A cache of IPs we've already checked or are known bad boys or good boys
+ * ie. $SpamFilters_DNScache["210.54.220.18"] = true;
+ * would tell filters to not even bother doing the DNS queries for that
+ * IP and any email coming from it are SPAM - false would mean that any
+ * email coming from it would NOT be SPAM
+ */
+global $SpamFilters_DNScache;
+
+/*
+ * Absolute path to the bulkquery program. Leave blank if you don't have
+ * bulkquery compiled, installed, and lwresd running. See the README file
+ * in the bulkquery directory for more information on using bulkquery.
+ */
+global $SpamFilters_BulkQuery;
+$SpamFilters_BulkQuery = '';
+
+/*
+ * Do you want to use a shared file for the DNS cache or a session variable?
+ * Using a shared file means that every user can benefit from any queries
+ * made by other users. The shared file is named "dnscache" and is in the
+ * data directory.
+ */
+global $SpamFilters_SharedCache;
+$SpamFilters_SharedCache = true;
+
+/*
+ * How long should DNS query results be cached for by default (in seconds)?
+ */
+global $SpamFilters_CacheTTL;
+$SpamFilters_CacheTTL = 7200;
+
+function squirrelmail_plugin_init_filters() {
+ global $squirrelmail_plugin_hooks;
+
+ if (isset($_GET['mailbox'])) {
+ $mailbox = $_GET['mailbox'];
+ }
+ elseif (isset($_POST['mailbox'])) {
+ $mailbox = $_POST['mailbox'];
+ }
+ else {
+ $mailbox = 'INBOX';
+ }
+
+ $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
+ if (isset($mailbox) && $mailbox == 'INBOX') {
+ $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters';
+ }
+ $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'filters_optpage_register_block';
+# $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
+ $squirrelmail_plugin_hooks['rename_or_delete_folder']['filters'] = 'update_for_folder';
+ $squirrelmail_plugin_hooks['webmail_bottom']['filters'] = 'start_filters';
+}
+
+function filters_special_mailbox( $mb ) {
+ GLOBAL $data_dir, $username;
+
+ return( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) );
+
+}
+
+function filters_optpage_register_block() {
+ global $optpage_blocks;
+ global $AllowSpamFilters;
+
+ $optpage_blocks[] = array(
+ 'name' => _("Message Filters"),
+ 'url' => '../plugins/filters/options.php',
+ 'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
+ 'js' => false
+ );
+
+ if ($AllowSpamFilters) {
+ $optpage_blocks[] = array(
'name' => _("SPAM Filters"),
'url' => '../plugins/filters/spamoptions.php',
'desc' => _("SPAM filters allow you to select from various DNS based blacklists to detect junk email in your INBOX and move it to another folder (like Trash)."),
'js' => false
- );
- }
- }
-?>
+ );
+ }
+}
+?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff