plugins/filters/setup.php

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