3 * Message and Spam Filter Plugin - Filtering Options
5 * This plugin filters your inbox into different folders based upon given
6 * criteria. It is most useful for people who are subscibed to mailing lists
7 * to help organize their messages. The argument stands that filtering is
8 * not the place of the client, which is why this has been made a plugin for
9 * SquirrelMail. You may be better off using products such as Sieve or
10 * Procmail to do your filtering so it happens even when SquirrelMail isn't
13 * If you need help with this, or see improvements that can be made, please
14 * email me directly at the address above. I definately welcome suggestions
15 * and comments. This plugin, as is the case with all SquirrelMail plugins,
16 * is not directly supported by the developers. Please come to me off the
17 * mailing list if you have trouble with it.
19 * Also view plugins/README.plugins for more information.
22 * @copyright (c) 1999-2004 The SquirrelMail Project Team
23 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
29 * Path for SquirrelMail required files.
32 define('SM_PATH','../../');
34 /* SquirrelMail required files. */
35 require_once(SM_PATH
. 'include/validate.php');
36 require_once(SM_PATH
. 'functions/page_header.php');
37 require_once(SM_PATH
. 'functions/imap.php');
38 require_once(SM_PATH
. 'functions/imap_mailbox.php');
39 require_once(SM_PATH
. 'include/load_prefs.php');
40 require_once(SM_PATH
. 'plugins/filters/filters.php');
42 global $AllowSpamFilters;
44 displayPageHeader($color, 'None');
47 sqgetGlobalVar('username', $username, SQ_SESSION
);
48 sqgetGlobalVar('key', $key, SQ_COOKIE
);
49 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION
);
50 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
52 sqgetGlobalVar('theid', $theid);
53 sqgetGlobalVar('action', $action, SQ_GET
);
55 if (sqgetGlobalVar('filter_submit',$filter_submit,SQ_POST
)) {
57 if(! isset($theid) ) $theid = 0;
61 // FIXME: write human readable error messages
62 sqgetGlobalVar('filter_what', $filter_what, SQ_POST
);
63 if (!sqgetGlobalVar('filter_what', $filter_what, SQ_POST
)) {
64 do_error("Post error");
68 sqgetGlobalVar('filter_where', $filter_where, SQ_POST
);
69 if (!sqgetGlobalVar('filter_where', $filter_where, SQ_POST
)) {
70 do_error("Post error");
74 sqgetGlobalVar('filter_folder', $filter_folder, SQ_POST
);
75 if (!sqgetGlobalVar('filter_folder', $filter_folder, SQ_POST
)) {
76 do_error("Post error");
81 $filter_what = str_replace(',', ' ', $filter_what);
82 $filter_what = str_replace("\\\\", "\\", $filter_what);
83 $filter_what = str_replace("\\\"", '"', $filter_what);
84 $filter_what = str_replace('"', '"', $filter_what);
86 if (($filter_where == 'Header') && (strchr($filter_what,':') == '')) {
87 do_error(_("WARNING! Header filters should be of the format \"Header: value\""));
90 setPref($data_dir, $username, 'filter'.$theid, $filter_where.','.$filter_what.','.$filter_folder);
91 $filters[$theid]['where'] = $filter_where;
92 $filters[$theid]['what'] = $filter_what;
93 $filters[$theid]['folder'] = $filter_folder;
95 } elseif (isset($action) && $action == 'delete') {
96 remove_filter($theid);
97 } elseif (isset($action) && $action == 'move_up') {
98 filter_swap($theid, $theid - 1);
99 } elseif (isset($action) && $action == 'move_down') {
100 filter_swap($theid, $theid +
1);
101 } elseif (sqgetGlobalVar('user_submit',$user_submit,SQ_POST
)) {
102 sqgetGlobalVar('filters_user_scan_set',$filters_user_scan_set,SQ_POST
);
103 setPref($data_dir, $username, 'filters_user_scan', $filters_user_scan_set);
104 echo '<br /><center><b>'._("Saved Scan type")."</b></center>\n";
107 $filters = load_filters();
108 $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
110 echo html_tag( 'table',
113 '<center><b>' . _("Options") . ' - ' . _("Message Filtering") . '</b></center>' ,
116 'center', '', 'width="95%" border="0" cellpadding="2" cellspacing="0"' ) .
118 '<br /><form method="post" action="options.php">'.
120 html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
122 html_tag( 'th', _("What to Scan:"), 'right', '', 'nowrap' ) .
123 html_tag( 'td', '', 'left' ) .
124 '<select name="filters_user_scan_set">'.
126 if ($filters_user_scan == '') {
129 echo '>' . _("All messages") . '</option>'.
130 '<option value="new"';
131 if ($filters_user_scan == 'new') {
134 echo '>' . _("Only unread messages") . '</option>' .
137 html_tag( 'td', '<input type="submit" name="user_submit" value="' . _("Save") . '" />', 'left' ) .
142 html_tag( 'div', '[<a href="options.php?action=add">' . _("New") .
143 '</a>] - [<a href="'.SM_PATH
.'src/options.php">' . _("Done") . '</a>]' ,
144 'center' ) . '<br />';
146 if (isset($action) && ($action == 'add' ||
$action == 'edit')) {
148 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
149 $boxes = sqimap_mailbox_list($imapConnection);
150 sqimap_logout($imapConnection);
151 if ( !isset($theid) ) {
152 $theid = count($filters);
154 echo html_tag( 'div', '', 'center' ) .
155 '<form action="options.php" method="post">'.
156 html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
158 html_tag( 'td', _("Match:"), 'left' ) .
159 html_tag( 'td', '', 'left' ) .
160 '<select name="filter_where">';
162 $L = isset($filters[$theid]['where']);
164 $sel = (($L && $filters[$theid]['where'] == 'From')?
'selected':'');
165 echo "<option value=\"From\" $sel>" . _("From") . '</option>';
167 $sel = (($L && $filters[$theid]['where'] == 'To')?
'selected':'');
168 echo "<option value=\"To\" $sel>" . _("To") . '</option>';
170 $sel = (($L && $filters[$theid]['where'] == 'Cc')?
'selected':'');
171 echo "<option value=\"Cc\" $sel>" . _("Cc") . '</option>';
173 $sel = (($L && $filters[$theid]['where'] == 'To or Cc')?
'selected':'');
174 echo "<option value=\"To or Cc\" $sel>" . _("To or Cc") . '</option>';
176 $sel = (($L && $filters[$theid]['where'] == 'Subject')?
'selected':'');
177 echo "<option value=\"Subject\" $sel>" . _("Subject") . '</option>';
179 $sel = (($L && $filters[$theid]['where'] == 'Header')?
'selected':'');
180 echo "<option value=\"Header\" $sel>" . _("Header") . '</option>';
186 html_tag( 'td', _("Contains:"), 'right' ) .
187 html_tag( 'td', '', 'left' ) .
188 '<input type="text" size="32" name="filter_what" value="';
189 if (isset($filters[$theid]['what'])) {
190 echo $filters[$theid]['what'];
196 html_tag( 'td', _("Move to:"), 'left' ) .
197 html_tag( 'td', '', 'left' ) .
199 '<select name="filter_folder">';
201 if ( isset($filters[$theid]['folder']) )
202 $selected = array(strtolower($filters[$theid]['folder']));
203 echo sqimap_mailbox_option_list(0, $selected, 0, $boxes);
209 '<input type="submit" name="filter_submit" value="' . _("Submit") . "\" />\n".
210 '<input type="hidden" name="theid" value="' . $theid . "\" />\n".
216 echo html_tag( 'table', '', 'center', '', 'border="0" cellpadding="3" cellspacing="0"' );
218 for ($i=0, $num = count($filters); $i < $num; $i++
) {
220 $clr = (($i %
2)?
$color[0]:$color[9]);
221 $fdr = ($folder_prefix)?
str_replace($folder_prefix, "", $filters[$i]["folder"]):$filters[$i]["folder"];
222 echo html_tag( 'tr', '', '', $clr ) .
225 "[<a href=\"options.php?theid=$i&action=edit\">" . _("Edit") . '</a>]'.
230 "[<a href=\"options.php?theid=$i&action=delete\">" . _("Delete") . '</a>]'.
233 html_tag( 'td', '', 'center' ) . '<small>[';
235 if (isset($filters[$i +
1])) {
236 echo "<a href=\"options.php?theid=$i&action=move_down\">" . _("Down") . '</a>';
238 echo ' | ';
242 echo "<a href=\"options.php?theid=$i&action=move_up\">" . _("Up") . '</a>';
244 echo ']</small></td>'.
245 html_tag( 'td', '-', 'left' ) .
246 html_tag( 'td', '', 'left' );
247 printf( _("If %s contains %s then move to %s"),
248 '<b>'.$filters[$i]['where'].'</b>',
249 '<b>'.$filters[$i]['what'].'</b>',
250 '<b>'.imap_utf7_decode_local($fdr).'</b>');
257 html_tag( 'td', ' ', 'left' )
259 'center', '', 'width="80%" border="0" cellpadding="2" cellspacing="0"' );
260 echo '</body></html>';