3 * Message and Spam Filter Plugin
5 * Copyright (c) 1999-2004 The SquirrelMail Project Team
6 * Licensed under the GNU GPL. For full terms see the file COPYING.
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
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.
22 * Also view plugins/README.plugins for more information.
29 /** Path for SquirrelMail required files. */
30 define('SM_PATH','../../');
32 /* SquirrelMail required files. */
33 require_once(SM_PATH
. 'include/validate.php');
34 require_once(SM_PATH
. 'functions/page_header.php');
35 require_once(SM_PATH
. 'functions/imap.php');
36 require_once(SM_PATH
. 'include/load_prefs.php');
37 require_once(SM_PATH
. 'functions/html.php');
38 require_once(SM_PATH
. 'plugins/filters/filters.php');
39 global $AllowSpamFilters;
42 sqgetGlobalVar('username', $username, SQ_SESSION
);
43 sqgetGlobalVar('key', $key, SQ_COOKIE
);
44 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION
);
45 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
47 sqgetGlobalVar('action', $action, SQ_GET
);
50 displayPageHeader($color, 'None');
52 if (isset($_POST['spam_submit'])) {
53 $spam_filters = load_spam_filters();
54 setPref($data_dir, $username, 'filters_spam_folder', $_POST['filters_spam_folder_set']);
55 setPref($data_dir, $username, 'filters_spam_scan', $_POST['filters_spam_scan_set']);
56 foreach ($spam_filters as $Key => $Value) {
57 $input = $spam_filters[$Key]['prefname'] . '_set';
58 if ( isset( $_POST[$input] ) ) {
59 setPref( $data_dir, $username, $spam_filters[$Key]['prefname'],
62 removePref($data_dir, $username, $spam_filters[$Key]['prefname']);
67 $filters_spam_folder = getPref($data_dir, $username, 'filters_spam_folder');
68 $filters_spam_scan = getPref($data_dir, $username, 'filters_spam_scan');
69 $filters = load_filters();
71 echo html_tag( 'table',
73 html_tag( 'th', _("Spam Filtering"), 'center' )
75 'center', $color[0], 'width="95%" border="0" cellpadding="2" cellspacing="0"' );
77 if ($SpamFilters_YourHop == ' ') {
79 html_tag( 'div', '<b>' .
80 _("WARNING! Tell your admin to set the SpamFilters_YourHop variable") .
87 if (isset($action) && $action == 'spam') {
88 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
89 $boxes = sqimap_mailbox_list($imapConnection);
90 sqimap_logout($imapConnection);
91 $numboxes = count($boxes);
93 for ($i = 0; $i < $numboxes && $filters_spam_folder == ''; $i++
) {
94 if ((isset($boxes[$i]['flags'][0]) && $boxes[$i]['flags'][0] != 'noselect') &&
95 (isset($boxes[$i]['flags'][1]) && $boxes[$i]['flags'][1] != 'noselect') &&
96 (isset($boxes[$i]['flags'][2]) && $boxes[$i]['flags'][2] != 'noselect')) {
97 $filters_spam_folder = $boxes[$i]['unformatted'];
101 echo '<form method=post action="spamoptions.php">'.
103 html_tag( 'table', '', '', '', 'width="85%" border="0" cellpadding="2" cellspacing="0"' ) .
105 html_tag( 'th', _("Move spam to:"), 'right', '', 'nowrap' ) .
106 html_tag( 'td', '', 'left' ) .
107 '<select name="filters_spam_folder_set">';
110 if ( isset($filters_spam_folder) )
111 $selected = array(strtolower($filters_spam_folder));
112 echo sqimap_mailbox_option_list(0, $selected, 0, $boxes);
117 html_tag( 'td', ' ' ) .
119 _("Moving spam directly to the trash may not be a good idea at first, since messages from friends and mailing lists might accidentally be marked as spam. Whatever folder you set this to, make sure that it gets cleaned out periodically, so that you don't have an excessively large mailbox hanging around.") ,
123 html_tag( 'th', _("What to Scan:"), 'right', '', 'nowrap' ) .
125 '<select name="filters_spam_scan_set">'.
127 if ($filters_spam_scan == '') {
130 echo '>' . _("All messages") . '</option>'.
131 '<option value="new"';
132 if ($filters_spam_scan == 'new') {
135 echo '>' . _("Only unread messages") . '</option>' .
140 html_tag( 'td', ' ' ) .
142 _("The more messages you scan, the longer it takes. I would suggest that you scan only new messages. If you make a change to your filters, I would set it to scan all messages, then go view my INBOX, then come back and set it to scan only new messages. That way, your new spam filters will be applied and you'll scan even the spam you read with the new filters.") ,
146 $spam_filters = load_spam_filters();
148 foreach ($spam_filters as $Key => $Value) {
149 echo html_tag( 'tr' ) .
150 html_tag( 'th', $Key, 'right', '', 'nowrap' ) ."\n" .
152 '<input type=checkbox name="' .
153 $spam_filters[$Key]['prefname'] .
155 if ($spam_filters[$Key]['enabled']) {
159 if ($spam_filters[$Key]['link']) {
161 $spam_filters[$Key]['link'] .
162 '" target="_blank">';
164 echo $spam_filters[$Key]['name'];
165 if ($spam_filters[$Key]['link']) {
170 html_tag( 'td', ' ' ) .
171 html_tag( 'td', $spam_filters[$Key]['comment'], 'left' )
176 html_tag( 'td', '<input type=submit name="spam_submit" value="' . _("Save") . '">', 'center', '', 'colspan="2"' )
181 echo '</body></html>';
184 if (! isset($_GET['action']) ||
$_GET['action'] != 'spam') {
186 echo html_tag( 'p', '', 'center' ) .
187 '[<a href="spamoptions.php?action=spam">' . _("Edit") . '</a>]' .
188 ' - [<a href="../../src/options.php">' . _("Done") . '</a>]</center><br><br>';
189 printf( _("Spam is sent to <b>%s</b>"), ($filters_spam_folder?
$filters_spam_folder:_("[<i>not set yet</i>]") ) );
191 printf( _("Spam scan is limited to <b>%s</b>"), (($filters_spam_scan == 'new')?
_("New Messages Only"):_("All Messages") ) );
193 "<table border=0 cellpadding=3 cellspacing=0 align=center bgcolor=\"$color[0]\">";
195 $spam_filters = load_spam_filters();
197 foreach ($spam_filters as $Key => $Value) {
198 echo html_tag( 'tr' ) .
199 html_tag( 'th', '', 'center' );
201 if ($spam_filters[$Key]['enabled']) {
208 html_tag( 'td', ' - ', 'left' ) .
209 html_tag( 'td', '', 'left' );
211 if ($spam_filters[$Key]['link']) {
213 $spam_filters[$Key]['link'] .
214 '" target="_blank">';
217 echo $spam_filters[$Key]['name'];
218 if ($spam_filters[$Key]['link']) {
224 echo '</body></html>';