5 * Copyright (c) 1999-2004 The SquirrelMail Project Team
6 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 * This impliments all functions that manipulate mailboxes
11 * @package squirrelmail
16 require_once(SM_PATH
. 'functions/imap_utf7_local.php');
23 * FIXME. This class should be extracted and placed in a separate file that
24 * can be included before we start the session. That makes caching of the tree
25 * possible. On a refresh mailboxes from left_main.php the only function that
26 * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
27 * / rename / delete / new we have to create methods for adding/changing the
28 * mailbox in the mbx_tree without the need for a refresh.
29 * @package squirrelmail
33 var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
34 $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
35 $is_trash = false, $is_draft = false, $mbxs = array(),
36 $unseen = false, $total = false;
38 function addMbx($mbx, $delimiter, $start, $specialfirst) {
39 $ary = explode($delimiter, $mbx->mailboxname_full
);
41 for ($i = $start, $c = count($ary)-1; $i < $c; $i++
) {
42 $mbx_childs =& $mbx_parent->mbxs
;
45 foreach ($mbx_childs as $key => $parent) {
46 if ($parent->mailboxname_sub
== $ary[$i]) {
47 $mbx_parent =& $mbx_parent->mbxs
[$key];
54 $no_select_mbx = new mailboxes();
55 if (isset($mbx_parent->mailboxname_full
) && $mbx_parent->mailboxname_full
!= '') {
56 $no_select_mbx->mailboxname_full
= $mbx_parent->mailboxname_full
.$delimiter.$ary[$i];
58 $no_select_mbx->mailboxname_full
= $ary[$i];
60 $no_select_mbx->mailboxname_sub
= $ary[$i];
61 $no_select_mbx->is_noselect
= true;
62 $mbx_parent->mbxs
[] = $no_select_mbx;
66 $mbx_parent->mbxs
[] = $mbx;
67 if ($mbx->is_special
&& $specialfirst) {
68 usort($mbx_parent->mbxs
, 'sortSpecialMbx');
73 function sortSpecialMbx($a, $b) {
75 $acmp = '0'. $a->mailboxname_full
;
76 } else if ($a->is_special
) {
77 $acmp = '1'. $a->mailboxname_full
;
79 $acmp = '2' . $a->mailboxname_full
;
82 $bcmp = '0'. $b->mailboxname_full
;
83 }else if ($b->is_special
) {
84 $bcmp = '1' . $b->mailboxname_full
;
86 $bcmp = '2' . $b->mailboxname_full
;
88 return strnatcasecmp($acmp, $bcmp);
91 function compact_mailboxes_response($ary)
94 * Workaround for mailboxes returned as literal
95 * FIXME : Doesn't work if the mailbox name is multiple lines
96 * (larger then fgets buffer)
98 for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++
) {
99 if (isset($ary[$i +
1]) && substr($ary[$i], -3) == "}\r\n") {
100 if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
102 $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+
1])) . '"' . $regs[2];
103 array_splice($ary, $i+
1, 2);
107 /* remove duplicates and ensure array is contiguous */
108 return array_values(array_unique($ary));
112 * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
113 * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
114 * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
116 function find_mailbox_name($line)
118 if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
119 if (substr($regs[1], 0, 1) == '"')
120 return stripslashes(substr($regs[1], 1, -1));
127 * @return bool whether this is a Noselect mailbox.
129 function check_is_noselect ($lsub_line) {
130 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
134 * @return bool whether this is a Noinferiors mailbox.
136 function check_is_noinferiors ($lsub_line) {
137 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
141 * If $haystack is a full mailbox name, and $needle is the mailbox
142 * separator character, returns the second last part of the full
143 * mailbox name (i.e. the mailbox's parent mailbox)
145 function readMailboxParent($haystack, $needle) {
149 $parts = explode($needle, $haystack);
150 $elem = array_pop($parts);
151 while ($elem == '' && count($parts)) {
152 $elem = array_pop($parts);
154 $ret = join($needle, $parts);
160 * Check if $subbox is below the specified $parentbox
162 function isBoxBelow( $subbox, $parentbox ) {
165 * Eliminate the obvious mismatch, where the
166 * subfolder path is shorter than that of the potential parent
168 if ( strlen($subbox) < strlen($parentbox) ) {
171 /* check for delimiter */
172 if (!substr($parentbox,-1) == $delimiter) {
173 $parentbox.=$delimiter;
175 if (substr($subbox,0,strlen($parentbox)) == $parentbox) {
183 * Defines special mailboxes: given a mailbox name, it checks if this is a
184 * "special" one: INBOX, Trash, Sent or Draft.
186 function isSpecialMailbox( $box ) {
187 $ret = ( (strtolower($box) == 'inbox') ||
188 isTrashMailbox($box) ||
isSentMailbox($box) ||
isDraftMailbox($box) );
191 $ret = boolean_hook_function('special_mailbox',$box,1);
197 * @return bool whether this is a Trash folder
199 function isTrashMailbox ($box) {
200 global $trash_folder, $move_to_trash;
201 return $move_to_trash && $trash_folder &&
202 ( $box == $trash_folder ||
isBoxBelow($box, $trash_folder) );
206 * @return bool whether this is a Sent folder
208 function isSentMailbox($box) {
209 global $sent_folder, $move_to_sent;
210 return $move_to_sent && $sent_folder &&
211 ( $box == $sent_folder ||
isBoxBelow($box, $sent_folder) );
215 * @return bool whether this is a Draft folder
217 function isDraftMailbox($box) {
218 global $draft_folder, $save_as_draft;
219 return $save_as_draft &&
220 ( $box == $draft_folder ||
isBoxBelow($box, $draft_folder) );
224 * Expunges a mailbox, ie. delete all contents.
226 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
229 $id = sqimap_message_list_squisher($id);
236 $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
237 $response, $message, $uid);
240 if (is_array($read)) {
241 foreach ($read as $r) {
242 if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
251 * Expunge specified message, updated $msgs and $msort
253 * Until Marc and I come up with a better way to maintain
254 * these stupid arrays, we'll use this wrapper function to
255 * remove the message with the matching UID .. the order
256 * won't be changed - the array element for the message
257 * will just be removed.
259 function sqimap_mailbox_expunge_dmn($message_id, $aMbxResponse, &$server_sort_array)
261 global $msgs, $msort, $sort, $imapConnection,
262 $mailbox, $auto_expunge,
263 $sort, $allow_server_sort, $thread_sort_messages, $allow_thread_sort,
264 $username, $data_dir;
267 if (!isset($sort) ||
$sort === false) {
268 sqgetGlobalVar('sort',$sort,SQ_GET
);
270 // Got to grab this out of prefs, since it isn't saved from mailbox_view.php
271 if ($allow_thread_sort) {
272 $thread_sort_messages = getPref($data_dir, $username, "thread_$mailbox",0);
275 for ($i = 0; $i < count($msort); $i++
) {
276 if ($msgs[$i]['ID'] == $message_id) {
281 if ( isset($msgs) ) {
283 $msgs = array_values($msgs);
284 sqsession_register($msgs, 'msgs');
287 if ( isset($msort) ) {
289 $msort = array_values($msort);
290 sqsession_register($msort, 'msort');
294 $cnt = sqimap_mailbox_expunge($imapConnection, $mailbox, true);
299 // And after all that mucking around, update the sort list!
300 // Remind me why the hell we need those two arrays again?!
302 if ( $allow_thread_sort && $thread_sort_messages ) {
303 $server_sort_array = get_thread_sort($imapConnection);
304 } elseif ( $allow_server_sort ) {
305 if (is_array($server_sort_array)) {
306 $key = array_search($message_id,$server_sort_array,true);
307 if ($key !== false) {
308 unset($server_sort_array[$key]);
309 $server_sort_array = array_values($server_sort_array);
311 $server_sort_array = sqimap_get_sort_order($imapConnection,$sort,$aMbxResponse);
314 $server_sort_array = sqimap_get_sort_order($imapConnection,$sort,$aMbxResponse);
317 $server_sort_array = sqimap_get_php_sort_order($imapConnection,
318 $sort,$aMbxResponse);
320 sqsession_register($server_sort_array,'server_sort_array');
325 * Checks whether or not the specified mailbox exists
327 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
328 if (!isset($mailbox) ||
empty($mailbox)) {
331 $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
332 true, $response, $message);
333 return isset($mbx[0]);
339 function sqimap_mailbox_select ($imap_stream, $mailbox) {
340 if ($mailbox == 'None') {
344 $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
345 true, $response, $message);
347 for ($i = 0, $cnt = count($read); $i < $cnt; $i++
) {
348 if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
349 $result[strtoupper($regs[1])] = $regs[2];
350 } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
351 $result[strtoupper($regs[2])] = $regs[1];
353 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
354 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
355 $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
356 } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
357 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
358 $result['FLAGS'] = explode(' ',strtolower($regs[1]));
362 if (!isset($result['PERMANENTFLAGS'])) {
363 $result['PERMANENTFLAGS'] = $result['FLAGS'];
365 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
366 $result['RIGHTS']=strtoupper($regs[1]);
375 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
377 if (strtolower($type) == 'noselect') {
378 $mailbox .= $delimiter;
381 $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
382 sqimap_encode_mailbox_name($mailbox),
383 true, $response, $message);
384 sqimap_subscribe ($imap_stream, $mailbox);
388 * Subscribes to an existing folder.
390 function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
391 $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
392 sqimap_encode_mailbox_name($mailbox),
393 $debug, $response, $message);
397 * Unsubscribes from an existing folder
399 function sqimap_unsubscribe ($imap_stream, $mailbox) {
400 $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
401 sqimap_encode_mailbox_name($mailbox),
402 false, $response, $message);
406 * Deletes the given folder
408 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
409 global $data_dir, $username;
410 sqimap_unsubscribe ($imap_stream, $mailbox);
411 $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
412 sqimap_encode_mailbox_name($mailbox),
413 true, $response, $message);
414 if ($response !== 'OK') {
416 sqimap_subscribe ($imap_stream, $mailbox);
418 do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
419 removePref($data_dir, $username, "thread_$mailbox");
424 * Determines if the user is subscribed to the folder or not
426 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
427 $boxesall = sqimap_mailbox_list ($imap_stream);
428 foreach ($boxesall as $ref) {
429 if ($ref['unformatted'] == $folder) {
439 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
440 if ( $old_name != $new_name ) {
441 global $delimiter, $imap_server_type, $data_dir, $username;
442 if ( substr( $old_name, -1 ) == $delimiter ) {
443 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
444 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
445 $postfix = $delimiter;
450 $boxesall = sqimap_mailbox_list($imap_stream);
451 $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
452 ' ' . sqimap_encode_mailbox_name($new_name);
453 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
454 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
455 $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
456 removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
457 sqimap_subscribe($imap_stream, $new_name.$postfix);
458 setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref);
459 do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
460 $l = strlen( $old_name ) +
1;
463 foreach ($boxesall as $box) {
464 if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
465 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
466 if ($imap_server_type == 'cyrus') {
467 $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
468 $data = sqimap_run_command($imap_stream, $cmd, true,
469 $response, $message);
471 sqimap_unsubscribe($imap_stream, $box[$p]);
472 $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
473 removePref($data_dir, $username, 'thread_'.$box[$p]);
474 sqimap_subscribe($imap_stream, $new_sub);
475 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
476 do_hook_function('rename_or_delete_folder',
477 $args = array($box[$p], 'rename', $new_sub));
484 * Formats a mailbox into parts for the $boxesall array
488 * raw - Raw LIST/LSUB response from the IMAP server
489 * formatted - nicely formatted folder name
490 * unformatted - unformatted, but with delimiter at end removed
491 * unformatted-dm - folder name as it appears in raw response
492 * unformatted-disp - unformatted without $folder_prefix
494 function sqimap_mailbox_parse ($line, $line_lsub) {
495 global $folder_prefix, $delimiter;
497 /* Process each folder line */
498 for ($g = 0, $cnt = count($line); $g < $cnt; ++
$g) {
499 /* Store the raw IMAP reply */
500 if (isset($line[$g])) {
501 $boxesall[$g]['raw'] = $line[$g];
503 $boxesall[$g]['raw'] = '';
506 /* Count number of delimiters ($delimiter) in folder name */
507 $mailbox = /*trim(*/$line_lsub[$g]/*)*/;
508 $dm_count = substr_count($mailbox, $delimiter);
509 if (substr($mailbox, -1) == $delimiter) {
510 /* If name ends in delimiter, decrement count by one */
514 /* Format folder name, but only if it's a INBOX.* or has a parent. */
515 $boxesallbyname[$mailbox] = $g;
516 $parentfolder = readMailboxParent($mailbox, $delimiter);
517 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
518 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
519 (isset($boxesallbyname[$parentfolder]) &&
520 (strlen($parentfolder) > 0) ) ) {
521 $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
523 $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
525 $boxesall[$g]['formatted'] = '';
527 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
529 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
532 $boxesall[$g]['unformatted-dm'] = $mailbox;
533 if (substr($mailbox, -1) == $delimiter) {
534 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
536 $boxesall[$g]['unformatted'] = $mailbox;
537 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
538 $mailbox = substr($mailbox, strlen($folder_prefix));
540 $boxesall[$g]['unformatted-disp'] = $mailbox;
541 $boxesall[$g]['id'] = $g;
543 $boxesall[$g]['flags'] = array();
544 if (isset($line[$g])) {
545 ereg("\(([^)]*)\)",$line[$g],$regs);
546 // FIXME Flags do contain the \ character. \NoSelect \NoInferiors
547 // and $MDNSent <= last one doesn't have the \
548 // It's better to follow RFC3501 instead of using our own naming.
549 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
551 $boxesall[$g]['flags'] = explode(' ', $flags);
559 * Returns list of options (to be echoed into select statement
560 * based on available mailboxes and separators
561 * Caller should surround options with <SELECT..> </SELECT> and
563 * $imap_stream - $imapConnection to query for mailboxes
564 * $show_selected - array containing list of mailboxes to pre-select (0 if none)
565 * $folder_skip - array of folders to keep out of option list (compared in lower)
566 * $boxes - list of already fetched boxes (for places like folder panel, where
567 * you know these options will be shown 3 times in a row.. (most often unset).
568 * $flag - flag to check for in mailbox flags, used to filter out mailboxes.
569 * 'noselect' by default to remove unselectable mailboxes.
570 * 'noinferiors' used to filter out folders that can not contain subfolders.
571 * NULL to avoid flag check entirely.
572 * NOTE: noselect and noiferiors are used internally. The IMAP representation is
573 * \NoSelect and \NoInferiors
574 * $use_long_format - override folder display preference and always show full folder name.
576 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
577 $flag = 'noselect', $use_long_format = false ) {
578 global $username, $data_dir;
580 if ( $use_long_format ) {
581 $shorten_box_names = 0;
583 $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF
);
587 $boxes = sqimap_mailbox_list($imap_stream);
590 foreach ($boxes as $boxes_part) {
591 if ($flag == NULL ||
!in_array($flag, $boxes_part['flags'])) {
592 $box = $boxes_part['unformatted'];
594 if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
597 $lowerbox = strtolower($box);
598 // mailboxes are casesensitive => inbox.sent != inbox.Sent
599 // nevermind, to many dependencies this should be fixed!
601 if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
604 switch ($shorten_box_names)
606 case 2: /* delimited, style = 2 */
607 $box2 = str_replace(' ', '. ', $boxes_part['formatted']);
609 case 1: /* indent, style = 1 */
610 $box2 = $boxes_part['formatted'];
612 default: /* default, long names, style = 0 */
613 $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
617 if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
618 $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'" SELECTED>'.$box2.'</OPTION>' . "\n";
620 $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'">'.$box2.'</OPTION>' . "\n";
624 return $mbox_options;
628 * Returns sorted mailbox lists in several different ways.
629 * See comment on sqimap_mailbox_parse() for info about the returned array.
633 function sqimap_mailbox_list($imap_stream, $force=false) {
634 global $default_folder_prefix;
636 if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION
) ||
$force) {
637 global $data_dir, $username, $list_special_folders_first,
638 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
639 $move_to_trash, $move_to_sent, $save_as_draft,
640 $delimiter, $noselect_fix_enable, $imap_server_type;
641 $inbox_in_list = false;
642 $inbox_subscribed = false;
643 $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
645 require_once(SM_PATH
. 'include/load_prefs.php');
648 if ($listsubscribed) {
649 $lsub = 'LIST (SUBSCRIBED)';
654 if ($noselect_fix_enable) {
656 $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
658 $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
661 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
662 true, $response, $message);
663 $lsub_ary = compact_mailboxes_response($lsub_ary);
665 $sorted_lsub_ary = array();
666 for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++
) {
668 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
669 $sorted_lsub_ary[] = $temp_mailbox_name;
670 if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
671 $inbox_subscribed = true;
675 /* natural sort mailboxes */
676 if (isset($sorted_lsub_ary)) {
677 usort($sorted_lsub_ary, 'strnatcasecmp');
680 * The LSUB response doesn't provide us information about \Noselect
681 * mail boxes. The LIST response does, that's why we need to do a LIST
682 * call to retrieve the flags for the mailbox
683 * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response.
684 * in other words, we cannot rely on it.
686 $sorted_list_ary = array();
687 // if (!$listsubscribed) {
688 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
689 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
690 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
693 $mbx = $sorted_lsub_ary[$i];
696 $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx),
697 true, $response, $message);
699 $read = compact_mailboxes_response($read);
701 if (isset($read[0])) {
702 $sorted_list_ary[$i] = $read[0];
704 $sorted_list_ary[$i] = '';
709 * Just in case they're not subscribed to their inbox,
710 * we'll get it for them anyway
712 if (!$inbox_subscribed) {
713 $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"',
714 true, $response, $message);
715 $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary));
716 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
719 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
721 /* Now, lets sort for special folders */
722 $boxesnew = $used = array();
725 $cnt = count($boxesall);
726 $used = array_pad($used,$cnt,false);
727 for($k = 0; $k < $cnt; ++
$k) {
728 if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
729 $boxesnew[] = $boxesall[$k];
734 /* List special folders and their subfolders, if requested. */
735 if ($list_special_folders_first) {
736 for($k = 0; $k < $cnt; ++
$k) {
737 if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
738 $boxesnew[] = $boxesall[$k];
743 /* Rest of the folders */
744 for($k = 0; $k < $cnt; $k++
) {
746 $boxesnew[] = $boxesall[$k];
749 sqsession_register($boxesnew,'boxesnew');
755 * Returns a list of all folders, subscribed or not
757 function sqimap_mailbox_list_all($imap_stream) {
758 global $list_special_folders_first, $folder_prefix, $delimiter;
760 $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false);
761 $read_ary = compact_mailboxes_response($read_ary);
765 $fld_pre_length = strlen($folder_prefix);
766 for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++
) {
767 /* Store the raw IMAP reply */
768 $boxes[$g]['raw'] = $read_ary[$i];
770 /* Count number of delimiters ($delimiter) in folder name */
771 $mailbox = find_mailbox_name($read_ary[$i]);
772 $dm_count = substr_count($mailbox, $delimiter);
773 if (substr($mailbox, -1) == $delimiter) {
774 /* If name ends in delimiter - decrement count by one */
778 /* Format folder name, but only if it's a INBOX.* or has a parent. */
779 $boxesallbyname[$mailbox] = $g;
780 $parentfolder = readMailboxParent($mailbox, $delimiter);
781 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
782 (ereg('^'.$folder_prefix, $mailbox)) ||
783 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
785 $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
787 $boxes[$g]['formatted'] = '';
789 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
791 $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
794 $boxes[$g]['unformatted-dm'] = $mailbox;
795 if (substr($mailbox, -1) == $delimiter) {
796 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
798 $boxes[$g]['unformatted'] = $mailbox;
799 $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
801 $boxes[$g]['id'] = $g;
803 /* Now lets get the flags for this mailbox */
804 $read_mlbx = $read_ary[$i];
805 $flags = substr($read_mlbx, strpos($read_mlbx, '(')+
1);
806 $flags = substr($flags, 0, strpos($flags, ')'));
807 $flags = str_replace('\\', '', $flags);
808 $flags = trim(strtolower($flags));
810 $boxes[$g]['flags'] = explode(' ', $flags);
812 $boxes[$g]['flags'] = array();
816 if(is_array($boxes)) {
823 function sqimap_mailbox_tree($imap_stream) {
824 global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
827 global $data_dir, $username, $list_special_folders_first,
828 $folder_prefix, $delimiter, $trash_folder, $move_to_trash,
832 $inbox_in_list = false;
833 $inbox_subscribed = false;
835 $noinferiors = false;
837 require_once(SM_PATH
. 'include/load_prefs.php');
840 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
841 true, $response, $message);
842 $lsub_ary = compact_mailboxes_response($lsub_ary);
844 /* Check to see if we have an INBOX */
847 for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++
) {
848 if (preg_match("/^\*\s+LSUB.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
849 $lsub_ary[$i] = strtoupper($lsub_ary[$i]);
850 // in case of an unsubscribed inbox an imap server can
851 // return the inbox in the lsub results with a \NoSelect
853 if (!preg_match("/\*\s+LSUB\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) {
856 // remove the result and request it again with a list
857 // response at a later stage.
858 unset($lsub_ary[$i]);
859 // re-index the array otherwise the addition of the LIST
860 // response will fail in PHP 4.1.2 and probably other older versions
861 $lsub_ary = array_values($lsub_ary);
867 if ($has_inbox == false) {
868 // do a list request for inbox because we should always show
869 // inbox even if the user isn't subscribed to it.
870 $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" INBOX',
871 true, $response, $message);
872 $inbox_ary = compact_mailboxes_response($inbox_ary);
873 if (count($inbox_ary)) {
874 $lsub_ary[] = $inbox_ary[0];
879 * Section about removing the last element was removed
880 * We don't return "* OK" anymore from sqimap_read_data
883 $sorted_lsub_ary = array();
884 $cnt = count($lsub_ary);
885 for ($i = 0; $i < $cnt; $i++
) {
886 $mbx = find_mailbox_name($lsub_ary[$i]);
888 // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting
889 if ($imap_server_type != "uw") {
890 $noselect = check_is_noselect($lsub_ary[$i]);
891 $noinferiors = check_is_noinferiors($lsub_ary[$i]);
893 if (substr($mbx, -1) == $delimiter) {
894 $mbx = substr($mbx, 0, strlen($mbx) - 1);
896 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
898 // FIX ME this requires a config setting inside conf.pl instead of checking on server type
899 if ($imap_server_type == "uw") {
902 // prepare an array with queries
903 foreach ($sorted_lsub_ary as $aMbx) {
904 $mbx = stripslashes($aMbx['mbx']);
905 sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false);
908 $sorted_lsub_ary = array();
909 // execute all the queries at once
910 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
911 foreach($aTag as $tag => $mbx) {
912 if ($aServerResponse[$tag] == 'OK') {
913 $sResponse = implode('', $aResponse[$tag]);
914 $noselect = check_is_noselect($sResponse);
915 $noinferiors = check_is_noinferiors($sResponse);
916 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
919 $cnt = count($sorted_lsub_ary);
921 $sorted_lsub_ary = array_values($sorted_lsub_ary);
922 array_multisort($sorted_lsub_ary, SORT_ASC
, SORT_REGULAR
);
923 $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
928 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
929 global $data_dir, $username, $list_special_folders_first,
930 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
931 $move_to_trash, $move_to_sent, $save_as_draft,
932 $delimiter, $imap_server_type;
934 $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
936 /* create virtual root node */
937 $mailboxes= new mailboxes();
938 $mailboxes->is_root
= true;
943 if (isset($folder_prefix) && ($folder_prefix != '')) {
944 $start = substr_count($folder_prefix,$delimiter);
945 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
947 $mailboxes->mailboxname_full
= substr($folder_prefix,0, (strlen($folder_prefix)-1));
949 $mailboxes->mailboxname_full
= $folder_prefix;
952 $mailboxes->mailboxname_sub
= $mailboxes->mailboxname_full
;
957 $cnt = count($mbx_ary);
958 for ($i=0; $i < $cnt; $i++
) {
959 if ($mbx_ary[$i]['mbx'] !='' ) {
960 $mbx = new mailboxes();
961 $mailbox = $mbx_ary[$i]['mbx'];
964 sent subfolders messes up using existing code as subfolders
965 were marked, but the parents were ordered somewhere else in
966 the list, despite having "special folders at top" option set.
967 Need a better method than this.
970 if ($mailbox == 'INBOX') {
971 $mbx->is_special = true;
972 } elseif (stristr($trash_folder , $mailbox)) {
973 $mbx->is_special = true;
974 } elseif (stristr($sent_folder , $mailbox)) {
975 $mbx->is_special = true;
976 } elseif (stristr($draft_folder , $mailbox)) {
977 $mbx->is_special = true;
982 $mbx->is_inbox = true;
983 $mbx->is_special = true;
984 $mbx_ary[$i]['noselect'] = false;
987 $mbx->is_trash = true;
988 $mbx->is_special = true;
991 $mbx->is_sent = true;
992 $mbx->is_special = true;
995 $mbx->is_draft = true;
996 $mbx->is_special = true;
1000 $mbx->is_special |
= ($mbx->is_inbox
= (strtoupper($mailbox) == 'INBOX'));
1001 $mbx->is_special |
= ($mbx->is_trash
= isTrashMailbox($mailbox));
1002 $mbx->is_special |
= ($mbx->is_sent
= isSentMailbox($mailbox));
1003 $mbx->is_special |
= ($mbx->is_draft
= isDraftMailbox($mailbox));
1004 if (!$mbx->is_special
)
1005 $mbx->is_special
= boolean_hook_function('special_mailbox', $mailbox, 1);
1007 if (isset($mbx_ary[$i]['unseen'])) {
1008 $mbx->unseen
= $mbx_ary[$i]['unseen'];
1010 if (isset($mbx_ary[$i]['nummessages'])) {
1011 $mbx->total
= $mbx_ary[$i]['nummessages'];
1014 $mbx->is_noselect
= $mbx_ary[$i]['noselect'];
1015 $mbx->is_noinferiors
= $mbx_ary[$i]['noinferiors'];
1017 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
1019 $mbx->mailboxname_sub
= substr($mbx_ary[$i]['mbx'],$r_del_pos+
1);
1020 } else { /* mailbox is root folder */
1021 $mbx->mailboxname_sub
= $mbx_ary[$i]['mbx'];
1023 $mbx->mailboxname_full
= $mbx_ary[$i]['mbx'];
1025 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
1028 sqimap_utf7_decode_mbx_tree($mailboxes);
1029 sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
1033 function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
1034 if (strtoupper($mbx_tree->mailboxname_full
) == 'INBOX')
1035 $mbx_tree->mailboxname_sub
= _("INBOX");
1037 $mbx_tree->mailboxname_sub
= imap_utf7_decode_local($mbx_tree->mailboxname_sub
);
1038 if ($mbx_tree->mbxs
) {
1039 $iCnt = count($mbx_tree->mbxs
);
1040 for ($i=0;$i<$iCnt;++
$i) {
1041 $mbxs_tree->mbxs
[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs
[$i]);
1047 function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
1049 $aMbxs[] =& $mbx_tree;
1050 if ($mbx_tree->mbxs
) {
1051 $iCnt = count($mbx_tree->mbxs
);
1052 for ($i=0;$i<$iCnt;++
$i) {
1053 sqimap_tree_to_ref_array($mbx_tree->mbxs
[$i],$aMbxs);
1058 function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
1059 global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
1060 $aMbxs = $aQuery = $aTag = array();
1061 sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
1062 // remove the root node
1063 array_shift($aMbxs);
1065 if($unseen_notify == 3) {
1066 $cnt = count($aMbxs);
1067 for($i=0;$i<$cnt;++
$i) {
1068 $oMbx =& $aMbxs[$i];
1069 if (!$oMbx->is_noselect
) {
1070 $mbx = $oMbx->mailboxname_full
;
1071 if ($unseen_type == 2 ||
1072 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1073 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)';
1075 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)';
1077 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
1079 $oMbx->unseen
= $oMbx->total
= false;
1083 $aMbxs[$i] =& $oMbx;
1085 // execute all the queries at once
1086 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
1087 $cnt = count($aMbxs);
1088 for($i=0;$i<$cnt;++
$i) {
1089 $oMbx =& $aMbxs[$i];
1091 if ($tag && $aServerResponse[$tag] == 'OK') {
1092 $sResponse = implode('', $aResponse[$tag]);
1093 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
1094 $oMbx->unseen
= $regs[1];
1096 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
1097 $oMbx->total
= $regs[1];
1102 } else if ($unseen_notify == 2) { // INBOX only
1103 $cnt = count($aMbxs);
1104 for($i=0;$i<$cnt;++
$i) {
1105 $oMbx =& $aMbxs[$i];
1106 if (strtoupper($oMbx->mailboxname_full
) == 'INBOX' ||
1107 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1108 if ($unseen_type == 2 ||
1109 ($oMbx->mailboxname_full
== $trash_folder && $move_to_trash)) {
1110 $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full
);
1111 $oMbx->unseen
= $aStatus['UNSEEN'];
1112 $oMbx->total
= $aStatus['MESSAGES'];
1114 $oMbx->unseen
= sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full
);
1116 $aMbxs[$i] =& $oMbx;
1117 if (!$move_to_trash && $trash_folder) {
1120 // trash comes after INBOX
1121 if ($oMbx->mailboxname_full
== $trash_folder) {