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