6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Copyright (c) 2000 by Michael Huttinger
8 * Licensed under the GNU GPL. For full terms see the file COPYING.
10 * Quite a hack -- but my first attempt at a plugin. We were
11 * looking for a way to play a sound when there was unseen
12 * messages to look at. Nice for users who keep the squirrel
13 * mail window up for long periods of time and want to know
16 * Basically, I hacked much of left_main.php into a plugin that
17 * goes through each mail folder and increments a flag if
18 * there are unseen messages. If the final count of unseen
19 * folders is > 0, then we play a sound (using the HTML at the
20 * far end of this script).
22 * This was tested with IE5.0 - but I hear Netscape works well,
23 * too (with a plugin).
27 include_once(SM_PATH
. 'functions/display_messages.php');
29 function CheckNewMailboxSound($imapConnection, $mailbox, $real_box, $delimeter, $unseen, &$total_new) {
31 global $folder_prefix, $trash_folder, $sent_folder,
32 $color, $move_to_sent, $move_to_trash,
33 $unseen_notify, $unseen_type, $newmail_allbox,
34 $newmail_recent, $newmail_changetitle;
36 $mailboxURL = urlencode($real_box);
37 $unseen = $recent = 0;
39 // Skip folders for Sent and Trash
41 if ($real_box == $sent_folder ||
42 $real_box == $trash_folder) {
46 if (($unseen_notify == 2 && $real_box == 'INBOX') ||
47 ($unseen_notify == 3 && ($newmail_allbox == 'on' ||
48 $real_box == 'INBOX'))) {
49 $status = sqimap_status_messages( $imapConnection, $real_box);
50 if($newmail_recent == 'on') {
51 $total_new +
= $status['RECENT'];
53 $total_new +
= $status['UNSEEN'];
63 function squirrelmail_plugin_init_newmail() {
64 global $squirrelmail_plugin_hooks;
66 $squirrelmail_plugin_hooks['left_main_before']['newmail'] = 'newmail_plugin';
67 $squirrelmail_plugin_hooks['optpage_register_block']['newmail'] = 'newmail_optpage_register_block';
68 $squirrelmail_plugin_hooks['options_save']['newmail'] = 'newmail_sav';
69 $squirrelmail_plugin_hooks['loading_prefs']['newmail'] = 'newmail_pref';
72 function newmail_optpage_register_block() {
73 // Gets added to the user's OPTIONS page.
74 global $optpage_blocks;
78 /* Register Squirrelspell with the $optionpages array. */
79 $optpage_blocks[] = array(
80 'name' => _("NewMail Options"),
81 'url' => SM_PATH
. 'plugins/newmail/newmail_opt.php',
82 'desc' => _("This configures settings for playing sounds and/or showing popup windows when new mail arrives."),
88 function newmail_sav() {
89 global $data_dir, $username;
91 if ( sqgetGlobalVar('submit_newmail', $submit, SQ_POST
) ) {
96 $media_changetitle = '';
99 sqgetGlobalVar('media_enable', $media_enable, SQ_POST
);
100 sqgetGlobalVar('media_popup', $media_popup, SQ_POST
);
101 sqgetGlobalVar('media_allbox', $media_allbox, SQ_POST
);
102 sqgetGlobalVar('media_recent', $media_recent, SQ_POST
);
103 sqgetGlobalVar('media_changetitle', $media_changetitle, SQ_POST
);
105 setPref($data_dir,$username,'newmail_enable',$media_enable);
106 setPref($data_dir,$username,'newmail_popup', $media_popup);
107 setPref($data_dir,$username,'newmail_allbox',$media_allbox);
108 setPref($data_dir,$username,'newmail_recent',$media_recent);
109 setPref($data_dir,$username,'newmail_changetitle',$media_changetitle);
111 if( sqgetGlobalVar('media_sel', $media_sel, SQ_POST
) &&
112 ($media_sel == '(none)' ||
$media_sel == '(local media)') ) {
113 removePref($data_dir,$username,'newmail_media');
115 setPref($data_dir,$username,'newmail_media',$media_sel);
117 echo html_tag( 'p', _("New Mail Notification options saved"), 'center' );
121 function newmail_pref() {
123 global $username,$data_dir;
124 global $newmail_media,$newmail_enable,$newmail_popup,$newmail_allbox;
125 global $newmail_recent, $newmail_changetitle;
127 $newmail_recent = getPref($data_dir,$username,'newmail_recent');
128 $newmail_enable = getPref($data_dir,$username,'newmail_enable');
129 $newmail_media = getPref($data_dir, $username, 'newmail_media', '(none)');
130 $newmail_popup = getPref($data_dir, $username, 'newmail_popup');
131 $newmail_allbox = getPref($data_dir, $username, 'newmail_allbox');
132 $newmail_changetitle = getPref($data_dir, $username, 'newmail_changetitle');
136 function newmail_plugin() {
138 global $username, $key, $imapServerAddress, $imapPort,
139 $newmail_media, $newmail_enable, $newmail_popup,
140 $newmail_recent, $newmail_changetitle, $imapConnection, $PHP_SELF;
142 if ($newmail_enable == 'on' ||
143 $newmail_popup == 'on' ||
144 $newmail_changetitle) {
146 // open a connection on the imap port (143)
148 $boxes = sqimap_mailbox_list($imapConnection);
149 $delimeter = sqimap_get_delimiter($imapConnection);
154 for ($i = 0;$i < count($boxes); $i++
) {
157 $mailbox = $boxes[$i]['formatted'];
159 if (! isset($boxes[$i]['unseen'])) {
160 $boxes[$i]['unseen'] = '';
162 if ($boxes[$i]['flags']) {
164 for ($h = 0; $h < count($boxes[$i]['flags']); $h++
) {
165 if (strtolower($boxes[$i]["flags"][$h]) == 'noselect') {
170 $status +
= CheckNewMailboxSound($imapConnection,
172 $boxes[$i]['unformatted'],
174 $boxes[$i]['unseen'],
178 $status +
= CheckNewMailboxSound($imapConnection,
180 $boxes[$i]['unformatted'],
182 $boxes[$i]['unseen'],
188 // sqimap_logout($imapConnection);
190 // If we found unseen messages, then we
191 // will play the sound as follows:
193 if ($newmail_changetitle) {
194 echo "<script language=\"javascript\">\n" .
195 "function ChangeTitleLoad() {\n";
196 if( $totalNew > 1 ||
$totalNew == 0 ) {
197 echo 'window.parent.document.title = "' .
198 sprintf(_("%s New Messages"), $totalNew ) .
201 echo 'window.parent.document.title = "' .
202 sprintf(_("%s New Message"), $totalNew ) .
205 echo "if (BeforeChangeTitle != null)\n".
206 "BeforeChangeTitle();\n".
208 "BeforeChangeTitle = window.onload;\n".
209 "window.onload = ChangeTitleLoad;\n".
213 if ($totalNew > 0 && $newmail_enable == 'on' && $newmail_media != '' ) {
214 echo "<EMBED SRC=\"$newmail_media\" HIDDEN=TRUE AUTOSTART=TRUE>\n";
216 if ($totalNew > 0 && $newmail_popup == 'on') {
217 echo "<SCRIPT LANGUAGE=\"JavaScript\">\n".
219 "function PopupScriptLoad() {\n".
220 'window.open("'.sqm_baseuri().'plugins/newmail/newmail.php?numnew='.$totalNew.
222 "\"width=200,height=130,scrollbars=no\");\n".
223 "if (BeforePopupScript != null)\n".
224 "BeforePopupScript();\n".
226 "BeforePopupScript = window.onload;\n".
227 "window.onload = PopupScriptLoad;\n".
228 // Idea by: Nic Wolfe (Nic@TimelapseProductions.com)
229 // Web URL: http://fineline.xs.mw
230 // More code from Tyler Akins