4 * Message and Spam Filter Plugin
6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This plugin filters your inbox into different folders based upon given
10 * criteria. It is most useful for people who are subscibed to mailing lists
11 * to help organize their messages. The argument stands that filtering is
12 * not the place of the client, which is why this has been made a plugin for
13 * SquirrelMail. You may be better off using products such as Sieve or
14 * Procmail to do your filtering so it happens even when SquirrelMail isn't
17 * If you need help with this, or see improvements that can be made, please
18 * email me directly at the address above. I definately welcome suggestions
19 * and comments. This plugin, as is the case with all SquirrelMail plugins,
20 * is not directly supported by the developers. Please come to me off the
21 * mailing list if you have trouble with it.
23 * Also view plugins/README.plugins for more information.
29 require_once('../src/validate.php');
30 require_once('../functions/page_header.php');
31 require_once('../functions/imap.php');
32 require_once('../src/load_prefs.php');
34 global $AllowSpamFilters;
36 displayPageHeader($color, 'None');
38 if (isset($filter_submit)) {
39 if (!isset($theid)) $theid = 0;
40 $filter_what = ereg_replace(",", " ", $filter_what);
41 $filter_what = str_replace("\\\\", "\\", $filter_what);
42 $filter_what = str_replace("\\\"", "\"", $filter_what);
43 $filter_what = str_replace("\"", """, $filter_what);
45 if (($filter_where == 'Header') && (strchr($filter_what,':') == '')) {
46 print ('WARNING! Header filters should be of the format "Header: value"<BR>');
49 setPref($data_dir, $username, "filter".$theid, $filter_where.",".$filter_what.",".$filter_folder);
50 $filters[$theid]["where"] = $filter_where;
51 $filters[$theid]["what"] = $filter_what;
52 $filters[$theid]["folder"] = $filter_folder;
53 } elseif (isset($action) && $action == 'delete') {
54 remove_filter($theid);
55 } elseif (isset($action) && $action == 'move_up') {
56 filter_swap($theid, $theid - 1);
57 } elseif (isset($action) && $action == 'move_down') {
58 filter_swap($theid, $theid +
1);
61 $filters = load_filters();
64 '<table width=95% align=center border=0 cellpadding=2 cellspacing=0>'.
65 "<tr><td bgcolor=\"$color[0]\">".
66 '<center><b>' . _("Options") . ' - ' . _("Message Filtering") . '</b></center>'.
68 '<br><center>[<a href="options.php?action=add">' . _("New") .
69 '</a>] - [<a href="../../src/options.php">' . _("Done") . '</a>]</center><br>';
71 if (isset($action) && ($action == 'add' ||
$action == 'edit')) {
72 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
73 $boxes = sqimap_mailbox_list($imapConnection);
74 sqimap_logout($imapConnection);
75 if ( !isset($theid) ) {
76 $theid = count($filters);
79 '<form action="options.php" method=post>'.
80 '<table cellpadding=2 cellspacing=0 border=0>'.
82 '<td>' . _("Match:") . '</td>'.
84 '<select name=filter_where>';
86 $L = isset($filters[$theid]['where']);
88 $sel = (($L && $filters[$theid]['where'] == 'From')?
'selected':'');
89 echo "<option value=\"From\" $sel>" . _ ("From") . '</option>';
91 $sel = (($L && $filters[$theid]['where'] == 'To')?
'selected':'');
92 echo "<option value=\"To\" $sel>" . _ ("To") . '</option>';
94 $sel = (($L && $filters[$theid]['where'] == 'Cc')?
'selected':'');
95 echo "<option value=\"Cc\" $sel>" . _ ("Cc") . '</option>';
97 $sel = (($L && $filters[$theid]['where'] == 'To or Cc')?
'selected':'');
98 echo "<option value=\"To or Cc\" $sel>" . _ ("To or Cc") . '</option>';
100 $sel = (($L && $filters[$theid]['where'] == 'Subject')?
'selected':'');
101 echo "<option value=\"Subject\" $sel>" . _ ("Subject") . '</option>';
103 $sel = (($L && $filters[$theid]['where'] == 'Header')?
'selected':'');
104 echo "<option value=\"Header\" $sel>" . _ ("Header") . '</option>';
114 '<input type=text size=32 name=filter_what value="';
115 if (isset($filters[$theid]['what'])) {
116 echo $filters[$theid]["what"];
127 '<select name=filter_folder>';
129 for ($i = 0; $i < count($boxes); $i++
) {
130 if (! in_array('noselect', $boxes[$i]['flags'])) {
131 $box = $boxes[$i]['unformatted'];
132 $box2 = str_replace(' ', ' ', $boxes[$i]['formatted']);
133 if (isset($filters[$theid]['folder']) &&
134 $filters[$theid]['folder'] == $box)
135 echo "<OPTION VALUE=\"$box\" SELECTED>$box2</option>";
137 echo "<OPTION VALUE=\"$box\">$box2</option>";
145 '<input type=submit name=filter_submit value=' . _("Submit") . '>'.
146 "<input type=hidden name=theid value=$theid>".
152 echo '<table border=0 cellpadding=3 cellspacing=0 align=center>';
154 for ($i=0; $i < count($filters); $i++
) {
156 $clr = (($i %
2)?
$color[0]:$color[9]);
157 $fdr = ($folder_prefix)?
str_replace($folder_prefix, "", $filters[$i]["folder"]):$filters[$i]["folder"];
158 echo "<tr bgcolor=\"$clr\"><td><small>".
159 "[<a href=\"options.php?theid=$i&action=edit\">" . _("Edit") . '</a>]'.
160 '</small></td><td><small>'.
161 "[<a href=\"options.php?theid=$i&action=delete\">" . _("Delete") . '</a>]'.
162 '</small></td><td align=center><small>[';
164 if (isset($filters[$i +
1])) {
165 echo "<a href=\"options.php?theid=$i&action=move_down\">" . _("Down") . '</a>';
167 echo ' | ';
171 echo "<a href=\"options.php?theid=$i&action=move_up\">" . _("Up") . '</a>';
173 echo ']</small></td><td>-</td><td>';
174 printf( _("If <b>%s</b> contains <b>%s</b> then move to <b>%s</b>"), _($filters[$i]['where']), $filters[$i]['what'], $fdr );
179 '<table width=80% align=center border=0 cellpadding=2 cellspacing=0">'.
180 '<tr><td> </td></tr>'.