<?php
/**
- * Message and Spam Filter Plugin
- *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * 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
*
* Also view plugins/README.plugins for more information.
*
- * $Id$
+ * @version $Id$
+ * @copyright (c) 1999-2004 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @package plugins
+ * @subpackage filters
*/
-/*
+/** SquirrelMail required files. */
+require_once(SM_PATH . 'plugins/filters/filters.php');
+
+/**
+ * Imap connection control
+ *
* 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 bool $UseSeparateImapConnection
*/
global $UseSeparateImapConnection;
$UseSeparateImapConnection = false;
-/*
+/**
+ * User level spam filters control
+ *
* Set this to false if you do not want the user to be able to enable
* spam filters
+ * @global bool $AllowSpamFilters
*/
global $AllowSpamFilters;
$AllowSpamFilters = true;
-/*
+/**
+ * SpamFilters YourHop Setting
+ *
* 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
* 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 string $SpamFilters_YourHop
*/
global $SpamFilters_YourHop;
$SpamFilters_YourHop = ' ';
-/*
+/**
+ * Commercial Spam Filters Control
+ *
+ * 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 bool $SpamFilters_ShowCommercial
+ */
+global $SpamFilters_ShowCommercial;
+$SpamFilters_ShowCommercial = false;
+
+/**
+ * SpamFiltring Cache
+ *
* 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 array $SpamFilters_DNScache
*/
global $SpamFilters_DNScache;
-require_once ('../plugins/filters/filters.php');
+/**
+ * Path to bulkquery program
+ *
+ * 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 string $SpamFilters_BulkQuery
+ */
+global $SpamFilters_BulkQuery;
+$SpamFilters_BulkQuery = '';
+/**
+ * Shared filtering cache control
+ *
+ * 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 bool $SpamFilters_SharedCache
+ */
+global $SpamFilters_SharedCache;
+$SpamFilters_SharedCache = true;
+
+/**
+ * DNS query TTL
+ *
+ * How long should DNS query results be cached for by default (in seconds)?
+ * @global integer $SpamFilters_CacheTTL
+ */
+global $SpamFilters_CacheTTL;
+$SpamFilters_CacheTTL = 7200;
+
+/**
+ * Init plugin
+ * @access private
+ */
function squirrelmail_plugin_init_filters() {
global $squirrelmail_plugin_hooks;
- global $mailbox, $imap_stream, $imapConnection;
+
+ if (sqgetGlobalVar('mailbox',$mailbox,SQ_FORM)) {
+ sqgetGlobalVar('mailbox',$mailbox,SQ_FORM);
+ } else {
+ $mailbox = 'INBOX';
+ }
$squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
- if ($mailbox == 'INBOX') {
+ if (isset($mailbox) && $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';
+ $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';
}
+/**
+ * Report spam folter as special mailbox
+ * @param string $mb variable used by hook
+ * @return string spam folder name
+ * @access private
+ */
function filters_special_mailbox( $mb ) {
- GLOBAL $data_dir, $username;
+ global $data_dir, $username;
return( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) );
}
-function squirrelmail_plugin_optpage_register_block() {
+/**
+ * Register option blocks
+ * @access private
+ */
+function filters_optpage_register_block() {
global $optpage_blocks;
global $AllowSpamFilters;
);
}
}
-?>
+?>
\ No newline at end of file