plugins/filters/setup.php

   1 <?php
   2 /**
   3  * Message and Spam Filter Plugin
   4  *
   5  * Copyright (c) 1999-2002 The SquirrelMail Project Team
   6  * Licensed under the GNU GPL. For full terms see the file COPYING.
   7  *
   8  * This plugin filters your inbox into different folders based upon given
   9  * criteria.  It is most useful for people who are subscibed to mailing lists
  10  * to help organize their messages.  The argument stands that filtering is
  11  * not the place of the client, which is why this has been made a plugin for
  12  * SquirrelMail.  You may be better off using products such as Sieve or
  13  * Procmail to do your filtering so it happens even when SquirrelMail isn't
  14  * running.
  15  *
  16  * If you need help with this, or see improvements that can be made, please
  17  * email me directly at the address above.  I definately welcome suggestions
  18  * and comments.  This plugin, as is the case with all SquirrelMail plugins,
  19  * is not directly supported by the developers.  Please come to me off the
  20  * mailing list if you have trouble with it.
  21  *
  22  * Also view plugins/README.plugins for more information.
  23  *
  24  * $Id$
  25  */
  26
  27 /* Path for SquirrelMail required files. */
  28 define('SM_PATH','../../');
  29
  30 /* SquirrelMail required files. */
  31 require_once(SM_PATH . 'plugins/filters/filters.php');
  32
  33 /*
  34  * Set this to true if you have problems -- check the README file
  35  * Note:  This doesn't work all of the time (No idea why)
  36  *        Seems to be related to UW
  37  */
  38 global $UseSeparateImapConnection;
  39 $UseSeparateImapConnection = false;
  40
  41 /*
  42  * Set this to false if you do not want the user to be able to enable
  43  * spam filters
  44  */
  45 global $AllowSpamFilters;
  46 $AllowSpamFilters = true;
  47
  48 /*
  49  * Set this to a string containing something unique to the line in the
  50  * header you want me to find IPs to scan the databases with.  For example,
  51  * All the email coming IN from the internet to my site has a line in
  52  * the header that looks like (all on one line):
  53  * Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
  54  *    [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
  55  *     0.2) with
  56  * Since this line indicates the FIRST hop the email takes into my network,
  57  * I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
  58  * case-sensitive string will do.  You can set it to something found on
  59  * every line in the header (like ' ') if you want to scan all IPs in
  60  * the header (lots of false alarms here tho).
  61  */
  62 global $SpamFilters_YourHop;
  63 $SpamFilters_YourHop = ' ';
  64
  65 /*
  66  * Some of the SPAM filters are COMMERCIAL and require a fee. If your users
  67  * select them and you're not allowed to use them, it will make SPAM filtering
  68  * very slow. If you don't want them to even be offered to the users, you
  69  * should set SpamFilters_ShowCommercial to false.
  70  */
  71 global $SpamFilters_ShowCommercial;
  72 $SpamFilters_ShowCommercial = false;
  73
  74 /*
  75  * A cache of IPs we've already checked or are known bad boys or good boys
  76  * ie. $SpamFilters_DNScache["210.54.220.18"] = true;
  77  * would tell filters to not even bother doing the DNS queries for that
  78  * IP and any email coming from it are SPAM - false would mean that any
  79  * email coming from it would NOT be SPAM
  80  */
  81 global $SpamFilters_DNScache;
  82
  83 /*
  84  * Absolute path to the bulkquery program. Leave blank if you don't have
  85  * bulkquery compiled, installed, and lwresd running. See the README file
  86  * in the bulkquery directory for more information on using bulkquery.
  87  */
  88 global $SpamFilters_BulkQuery;
  89 $SpamFilters_BulkQuery = "";
  90
  91 /*
  92  * Do you want to use a shared file for the DNS cache or a session variable?
  93  * Using a shared file means that every user can benefit from any queries
  94  * made by other users. The shared file is named "dnscache" and is in the
  95  * data directory.
  96  */
  97 global $SpamFilters_SharedCache;
  98 $SpamFilters_SharedCache = true;
  99
 100 /*
 101  * How long should DNS query results be cached for by default (in seconds)?
 102  */
 103 global $SpamFilters_CacheTTL;
 104 $SpamFilters_CacheTTL = 7200;
 105
 106 function squirrelmail_plugin_init_filters() {
 107     global $squirrelmail_plugin_hooks;
 108
 109     if (isset($_GET['mailbox'])) {
 110         $mailbox = $_GET['mailbox'];
 111     }
 112     elseif (isset($_POST['mailbox'])) {
 113         $mailbox = $_POST['mailbox'];
 114     }
 115     else {
 116         $mailbox = 'INBOX';
 117     }
 118
 119     $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
 120     if (isset($mailbox) && $mailbox == 'INBOX') {
 121         $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters';
 122     }
 123     $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'filters_optpage_register_block';
 124 #    $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
 125     $squirrelmail_plugin_hooks['rename_or_delete_folder']['filters'] = 'update_for_folder';
 126     $squirrelmail_plugin_hooks['webmail_bottom']['filters'] = 'start_filters';
 127 }
 128
 129 function filters_special_mailbox( $mb ) {
 130     GLOBAL $data_dir, $username;
 131
 132     return( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) );
 133
 134 }
 135
 136 function filters_optpage_register_block() {
 137     global $optpage_blocks;
 138     global $AllowSpamFilters;
 139
 140     $optpage_blocks[] = array(
 141         'name' => _("Message Filters"),
 142         'url'  => '../plugins/filters/options.php',
 143         'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
 144         'js'   => false
 145     );
 146
 147     if ($AllowSpamFilters) {
 148         $optpage_blocks[] = array(
 149             'name' => _("SPAM Filters"),
 150             'url'  => '../plugins/filters/spamoptions.php',
 151             '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)."),
 152             'js'   => false
 153         );
 154     }
 155 }
 156 ?>