5 * Copyright (c) 1999-2005 The SquirrelMail Project Team
6 * Copyright (c) 2000 by Michael Huttinger
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * Quite a hack -- but my first attempt at a plugin. We were
10 * looking for a way to play a sound when there was unseen
11 * messages to look at. Nice for users who keep the squirrel
12 * mail window up for long periods of time and want to know
15 * Basically, I hacked much of left_main.php into a plugin that
16 * goes through each mail folder and increments a flag if
17 * there are unseen messages. If the final count of unseen
18 * folders is > 0, then we play a sound (using the HTML at the
19 * far end of this script).
21 * This was tested with IE5.0 - but I hear Netscape works well,
22 * too (with a plugin).
30 * sqm_baseuri function for setups that don't load it by default
32 include_once(SM_PATH
. 'functions/display_messages.php');
34 /** Load plugin functions */
35 include_once(SM_PATH
. 'plugins/newmail/functions.php');
38 * Checks if mailbox contains new messages.
40 * @param object $imapConnection
41 * @param mixed $mailbox FIXME: option is not used
42 * @param string $real_box unformated mailbox name
43 * @param mixed $delimeter FIXME: option is not used
44 * @param string $unseen FIXME: option is not used
45 * @param integer $total_new number of new messages
46 * @return bool true, if there are new messages
48 function CheckNewMailboxSound($imapConnection, $mailbox, $real_box, $delimeter, $unseen, &$total_new) {
49 global $trash_folder, $sent_folder,
50 $unseen_notify, $newmail_allbox,
53 $mailboxURL = urlencode($real_box);
55 // Skip folders for Sent and Trash
56 if ($real_box == $sent_folder ||
57 $real_box == $trash_folder) {
61 if (($unseen_notify == 2 && $real_box == 'INBOX') ||
62 ($unseen_notify == 3 && ($newmail_allbox == 'on' ||
63 $real_box == 'INBOX'))) {
64 $status = sqimap_status_messages( $imapConnection, $real_box);
65 if($newmail_recent == 'on') {
66 $total_new +
= $status['RECENT'];
68 $total_new +
= $status['UNSEEN'];
80 function squirrelmail_plugin_init_newmail() {
81 global $squirrelmail_plugin_hooks;
83 $squirrelmail_plugin_hooks['left_main_before']['newmail'] = 'newmail_plugin';
84 $squirrelmail_plugin_hooks['optpage_register_block']['newmail'] = 'newmail_optpage_register_block';
85 $squirrelmail_plugin_hooks['options_save']['newmail'] = 'newmail_sav';
86 $squirrelmail_plugin_hooks['loading_prefs']['newmail'] = 'newmail_pref';
87 $squirrelmail_plugin_hooks['optpage_set_loadinfo']['newmail'] = 'newmail_set_loadinfo';
91 * Register newmail option block
93 function newmail_optpage_register_block() {
94 // Gets added to the user's OPTIONS page.
95 global $optpage_blocks;
97 if ( checkForJavascript() ) {
98 /* Register Squirrelspell with the $optionpages array. */
99 $optpage_blocks[] = array(
100 'name' => _("NewMail Options"),
101 'url' => SM_PATH
. 'plugins/newmail/newmail_opt.php',
102 'desc' => _("This configures settings for playing sounds and/or showing popup windows when new mail arrives."),
109 * Save newmail plugin settings
111 function newmail_sav() {
112 global $data_dir, $username, $_FILES;
114 if ( sqgetGlobalVar('submit_newmail', $submit, SQ_POST
) ) {
119 $media_changetitle = '';
122 sqgetGlobalVar('media_enable', $media_enable, SQ_POST
);
123 sqgetGlobalVar('media_popup', $media_popup, SQ_POST
);
124 sqgetGlobalVar('media_allbox', $media_allbox, SQ_POST
);
125 sqgetGlobalVar('media_recent', $media_recent, SQ_POST
);
126 sqgetGlobalVar('media_changetitle', $media_changetitle, SQ_POST
);
128 setPref($data_dir,$username,'newmail_enable',$media_enable);
129 setPref($data_dir,$username,'newmail_popup', $media_popup);
130 setPref($data_dir,$username,'newmail_allbox',$media_allbox);
131 setPref($data_dir,$username,'newmail_recent',$media_recent);
132 setPref($data_dir,$username,'newmail_changetitle',$media_changetitle);
134 if( sqgetGlobalVar('media_sel', $media_sel, SQ_POST
) &&
135 $media_sel == '(none)' ) {
136 removePref($data_dir,$username,'newmail_media');
138 setPref($data_dir,$username,'newmail_media',$media_sel);
141 // process uploaded file
142 if (isset($_FILES['media_file']['tmp_name']) && $_FILES['media_file']['tmp_name']!='') {
143 // set temp file and get media file name
144 $newmail_tempmedia=getHashedDir($username, $data_dir) . "/$username.tempsound";
145 $newmail_mediafile=getHashedFile($username, $data_dir, $username . '.sound');
146 if (move_uploaded_file($_FILES['media_file']['tmp_name'], $newmail_tempmedia)) {
147 // new media file is in $newmail_tempmedia
148 if (file_exists($newmail_mediafile)) unlink($newmail_mediafile);
149 if (! rename($newmail_tempmedia,$newmail_mediafile)) {
150 // remove (userfile), if file rename fails
151 removePref($data_dir,$username,'newmail_media');
154 if (isset($_FILES['media_file']['type']) && isset($_FILES['media_file']['name'])) {
155 setPref($data_dir,$username,'newmail_userfile_type',
156 newmail_get_mediatype($_FILES['media_file']['type'],$_FILES['media_file']['name']));
158 removePref($data_dir,$username,'newmail_userfile_type');
161 if (isset($_FILES['media_file']['name'])) {
162 setPref($data_dir,$username,'newmail_userfile_name',basename($_FILES['media_file']['name']));
164 setPref($data_dir,$username,'newmail_userfile_name','mediafile.unknown');
174 * Load newmail plugin settings
176 function newmail_pref() {
177 global $username,$data_dir;
178 global $newmail_media,$newmail_enable,$newmail_popup,$newmail_allbox;
179 global $newmail_recent, $newmail_changetitle;
180 global $newmail_userfile_type;
182 $newmail_recent = getPref($data_dir,$username,'newmail_recent');
183 $newmail_enable = getPref($data_dir,$username,'newmail_enable');
184 $newmail_media = getPref($data_dir, $username, 'newmail_media', '(none)');
185 $newmail_popup = getPref($data_dir, $username, 'newmail_popup');
186 $newmail_allbox = getPref($data_dir, $username, 'newmail_allbox');
187 $newmail_changetitle = getPref($data_dir, $username, 'newmail_changetitle');
189 $newmail_userfile_type = getPref($data_dir, $username, 'newmail_userfile_type');
195 * Used by option page when saving settings.
197 function newmail_set_loadinfo() {
198 global $optpage, $optpage_name;
199 if ($optpage=='newmail') {
200 $optpage_name=_("NewMail Options");
205 * Insert needed data in left_main
207 function newmail_plugin() {
208 global $username, $newmail_media, $newmail_enable, $newmail_popup,
209 $newmail_recent, $newmail_changetitle, $imapConnection, $PHP_SELF;
210 global $newmail_mmedia, $newmail_allowsound;
211 global $newmail_userfile_type;
213 if ($newmail_enable == 'on' ||
214 $newmail_popup == 'on' ||
215 $newmail_changetitle) {
217 // open a connection on the imap port (143)
219 $boxes = sqimap_mailbox_list($imapConnection);
220 $delimeter = sqimap_get_delimiter($imapConnection);
225 for ($i = 0;$i < count($boxes); $i++
) {
227 $mailbox = $boxes[$i]['formatted'];
229 if (! isset($boxes[$i]['unseen'])) {
230 $boxes[$i]['unseen'] = '';
232 if ($boxes[$i]['flags']) {
234 for ($h = 0; $h < count($boxes[$i]['flags']); $h++
) {
235 if (strtolower($boxes[$i]["flags"][$h]) == 'noselect') {
240 $status +
= CheckNewMailboxSound($imapConnection,
242 $boxes[$i]['unformatted'],
244 $boxes[$i]['unseen'],
248 $status +
= CheckNewMailboxSound($imapConnection,
250 $boxes[$i]['unformatted'],
252 $boxes[$i]['unseen'],
257 // sqimap_logout($imapConnection);
259 // If we found unseen messages, then we
260 // will play the sound as follows:
262 if ($newmail_changetitle) {
263 echo "<script language=\"javascript\">\n" .
264 "function ChangeTitleLoad() {\n";
265 echo 'window.parent.document.title = "' .
266 sprintf(ngettext("%s New Message","%s New Messages",$totalNew), $totalNew) .
268 echo "if (BeforeChangeTitle != null)\n".
269 "BeforeChangeTitle();\n".
271 "BeforeChangeTitle = window.onload;\n".
272 "window.onload = ChangeTitleLoad;\n".
276 // create media output if there are new email messages
277 if ($newmail_allowsound && $totalNew > 0 && $newmail_enable == 'on' && $newmail_media != '' ) {
278 echo newmail_create_media_tags($newmail_media);
281 if ($totalNew > 0 && $newmail_popup == 'on') {
282 echo "<script language=\"JavaScript\">\n".
284 "function PopupScriptLoad() {\n".
285 'window.open("'.sqm_baseuri().'plugins/newmail/newmail.php?numnew='.$totalNew.
287 "\"width=200,height=130,scrollbars=no\");\n".
288 "if (BeforePopupScript != null)\n".
289 "BeforePopupScript();\n".
291 "BeforePopupScript = window.onload;\n".
292 "window.onload = PopupScriptLoad;\n".
293 // Idea by: Nic Wolfe (Nic@TimelapseProductions.com)
294 // Web URL: http://fineline.xs.mw
295 // More code from Tyler Akins