f430cc12b32f8c55853665b30c8d9ecf09421392
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).
32 include_once(SM_PATH
. 'functions/display_messages.php');
34 function CheckNewMailboxSound($imapConnection, $mailbox, $real_box, $delimeter, $unseen, &$total_new) {
36 global $folder_prefix, $trash_folder, $sent_folder,
37 $color, $move_to_sent, $move_to_trash,
38 $unseen_notify, $unseen_type, $newmail_allbox,
39 $newmail_recent, $newmail_changetitle;
41 $mailboxURL = urlencode($real_box);
42 $unseen = $recent = 0;
44 // Skip folders for Sent and Trash
46 if ($real_box == $sent_folder ||
47 $real_box == $trash_folder) {
51 if (($unseen_notify == 2 && $real_box == 'INBOX') ||
52 ($unseen_notify == 3 && ($newmail_allbox == 'on' ||
53 $real_box == 'INBOX'))) {
54 $status = sqimap_status_messages( $imapConnection, $real_box);
55 if($newmail_recent == 'on') {
56 $total_new +
= $status['RECENT'];
58 $total_new +
= $status['UNSEEN'];
68 function squirrelmail_plugin_init_newmail() {
69 global $squirrelmail_plugin_hooks;
71 $squirrelmail_plugin_hooks['left_main_before']['newmail'] = 'newmail_plugin';
72 $squirrelmail_plugin_hooks['optpage_register_block']['newmail'] = 'newmail_optpage_register_block';
73 $squirrelmail_plugin_hooks['options_save']['newmail'] = 'newmail_sav';
74 $squirrelmail_plugin_hooks['loading_prefs']['newmail'] = 'newmail_pref';
77 function newmail_optpage_register_block() {
78 // Gets added to the user's OPTIONS page.
79 global $optpage_blocks;
81 if ( checkForJavascript() ) {
82 /* Register Squirrelspell with the $optionpages array. */
83 $optpage_blocks[] = array(
84 'name' => _("NewMail Options"),
85 'url' => SM_PATH
. 'plugins/newmail/newmail_opt.php',
86 'desc' => _("This configures settings for playing sounds and/or showing popup windows when new mail arrives."),
92 function newmail_sav() {
93 global $data_dir, $username;
95 if ( sqgetGlobalVar('submit_newmail', $submit, SQ_POST
) ) {
100 $media_changetitle = '';
103 sqgetGlobalVar('media_enable', $media_enable, SQ_POST
);
104 sqgetGlobalVar('media_popup', $media_popup, SQ_POST
);
105 sqgetGlobalVar('media_allbox', $media_allbox, SQ_POST
);
106 sqgetGlobalVar('media_recent', $media_recent, SQ_POST
);
107 sqgetGlobalVar('media_changetitle', $media_changetitle, SQ_POST
);
109 setPref($data_dir,$username,'newmail_enable',$media_enable);
110 setPref($data_dir,$username,'newmail_popup', $media_popup);
111 setPref($data_dir,$username,'newmail_allbox',$media_allbox);
112 setPref($data_dir,$username,'newmail_recent',$media_recent);
113 setPref($data_dir,$username,'newmail_changetitle',$media_changetitle);
115 if( sqgetGlobalVar('media_sel', $media_sel, SQ_POST
) &&
116 ($media_sel == '(none)' ||
$media_sel == '(local media)') ) {
117 removePref($data_dir,$username,'newmail_media');
119 setPref($data_dir,$username,'newmail_media',$media_sel);
121 echo html_tag( 'p', _("New Mail Notification options saved"), 'center' );
125 function newmail_pref() {
127 global $username,$data_dir;
128 global $newmail_media,$newmail_enable,$newmail_popup,$newmail_allbox;
129 global $newmail_recent, $newmail_changetitle;
131 $newmail_recent = getPref($data_dir,$username,'newmail_recent');
132 $newmail_enable = getPref($data_dir,$username,'newmail_enable');
133 $newmail_media = getPref($data_dir, $username, 'newmail_media', '(none)');
134 $newmail_popup = getPref($data_dir, $username, 'newmail_popup');
135 $newmail_allbox = getPref($data_dir, $username, 'newmail_allbox');
136 $newmail_changetitle = getPref($data_dir, $username, 'newmail_changetitle');
140 function newmail_plugin() {
142 global $username, $key, $imapServerAddress, $imapPort,
143 $newmail_media, $newmail_enable, $newmail_popup,
144 $newmail_recent, $newmail_changetitle, $imapConnection, $PHP_SELF;
146 if ($newmail_enable == 'on' ||
147 $newmail_popup == 'on' ||
148 $newmail_changetitle) {
150 // open a connection on the imap port (143)
152 $boxes = sqimap_mailbox_list($imapConnection);
153 $delimeter = sqimap_get_delimiter($imapConnection);
158 for ($i = 0;$i < count($boxes); $i++
) {
161 $mailbox = $boxes[$i]['formatted'];
163 if (! isset($boxes[$i]['unseen'])) {
164 $boxes[$i]['unseen'] = '';
166 if ($boxes[$i]['flags']) {
168 for ($h = 0; $h < count($boxes[$i]['flags']); $h++
) {
169 if (strtolower($boxes[$i]["flags"][$h]) == 'noselect') {
174 $status +
= CheckNewMailboxSound($imapConnection,
176 $boxes[$i]['unformatted'],
178 $boxes[$i]['unseen'],
182 $status +
= CheckNewMailboxSound($imapConnection,
184 $boxes[$i]['unformatted'],
186 $boxes[$i]['unseen'],
192 // sqimap_logout($imapConnection);
194 // If we found unseen messages, then we
195 // will play the sound as follows:
197 if ($newmail_changetitle) {
198 echo "<script language=\"javascript\">\n" .
199 "function ChangeTitleLoad() {\n";
200 echo 'window.parent.document.title = "' .
201 sprintf(ngettext("%s New Message","%s New Messages",$totalNew), $totalNew) .
203 echo "if (BeforeChangeTitle != null)\n".
204 "BeforeChangeTitle();\n".
206 "BeforeChangeTitle = window.onload;\n".
207 "window.onload = ChangeTitleLoad;\n".
211 if ($totalNew > 0 && $newmail_enable == 'on' && $newmail_media != '' ) {
212 echo '<embed src="'.htmlspecialchars($newmail_media) .
213 "\" hidden=\"true\" autostart=\"true\">\n";
215 if ($totalNew > 0 && $newmail_popup == 'on') {
216 echo "<script language=\"JavaScript\">\n".
218 "function PopupScriptLoad() {\n".
219 'window.open("'.sqm_baseuri().'plugins/newmail/newmail.php?numnew='.$totalNew.
221 "\"width=200,height=130,scrollbars=no\");\n".
222 "if (BeforePopupScript != null)\n".
223 "BeforePopupScript();\n".
225 "BeforePopupScript = window.onload;\n".
226 "window.onload = PopupScriptLoad;\n".
227 // Idea by: Nic Wolfe (Nic@TimelapseProductions.com)
228 // Web URL: http://fineline.xs.mw
229 // More code from Tyler Akins