6 * Copyright (c) 1999-2003 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This impliments all functions that manipulate mailboxes
12 * @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='') {
230 $id = sqimap_message_list_squisher($id);
237 $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
238 $response, $message, $uid);
241 if (is_array($read)) {
242 foreach ($read as $r) {
243 if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
252 * Expunge specified message, updated $msgs and $msort
254 * Until Marc and I come up with a better way to maintain
255 * these stupid arrays, we'll use this wrapper function to
256 * remove the message with the matching UID .. the order
257 * won't be changed - the array element for the message
258 * will just be removed.
260 function sqimap_mailbox_expunge_dmn($message_id)
262 global $msgs, $msort, $sort, $imapConnection,
263 $mailbox, $uid_support, $mbx_response, $auto_expunge,
264 $sort, $allow_server_sort, $thread_sort_messages, $allow_thread_sort,
265 $username, $data_dir;
267 // Got to grab this out of prefs, since it isn't saved from mailbox_view.php
268 if ($allow_thread_sort) {
269 $thread_sort_messages = getPref($data_dir, $username, "thread_$mailbox",0);
272 for ($i = 0; $i < count($msort); $i++
) {
273 if ($msgs[$i]['ID'] == $message_id) {
281 $msgs = array_values($msgs);
282 $msort = array_values($msort);
284 sqsession_register($msgs, 'msgs');
285 sqsession_register($msort, 'msort');
288 sqimap_mailbox_expunge($imapConnection, $mailbox, true);
291 // And after all that mucking around, update the sort list!
292 // Remind me why the hell we need those two arrays again?!
293 if ( $allow_thread_sort && $thread_sort_messages ) {
294 $server_sort_array = get_thread_sort($imapConnection);
295 } elseif ( $allow_server_sort ) {
296 $server_sort_array = sqimap_get_sort_order($imapConnection, $sort, $mbx_response);
297 } elseif ( $uid_support ) {
298 $server_sort_array = sqimap_get_php_sort_order($imapConnection, $mbx_response);
304 * Checks whether or not the specified mailbox exists
306 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
307 if (!isset($mailbox) ||
empty($mailbox)) {
310 $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
311 true, $response, $message);
312 return isset($mbx[0]);
318 function sqimap_mailbox_select ($imap_stream, $mailbox) {
319 global $auto_expunge;
321 if ($mailbox == 'None') {
325 $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
326 true, $response, $message);
328 for ($i = 0, $cnt = count($read); $i < $cnt; $i++
) {
329 if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
330 $result[strtoupper($regs[1])] = $regs[2];
331 } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
332 $result[strtoupper($regs[2])] = $regs[1];
334 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
335 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
336 $result['PERMANENTFLAGS'] = $regs[1];
337 } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
338 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
339 $result['FLAGS'] = $regs[1];
343 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
344 $result['RIGHTS']=$regs[1];
348 $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
356 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
358 if (strtolower($type) == 'noselect') {
359 $mailbox .= $delimiter;
362 $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
363 sqimap_encode_mailbox_name($mailbox),
364 true, $response, $message);
365 sqimap_subscribe ($imap_stream, $mailbox);
369 * Subscribes to an existing folder.
371 function sqimap_subscribe ($imap_stream, $mailbox) {
372 $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
373 sqimap_encode_mailbox_name($mailbox),
374 true, $response, $message);
378 * Unsubscribes from an existing folder
380 function sqimap_unsubscribe ($imap_stream, $mailbox) {
381 $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
382 sqimap_encode_mailbox_name($mailbox),
383 false, $response, $message);
387 * Deletes the given folder
389 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
390 global $data_dir, $username;
391 sqimap_unsubscribe ($imap_stream, $mailbox);
392 $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
393 sqimap_encode_mailbox_name($mailbox),
394 true, $response, $message);
395 if ($response !== 'OK') {
397 sqimap_subscribe ($imap_stream, $mailbox);
399 do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
400 removePref($data_dir, $username, "thread_$mailbox");
405 * Determines if the user is subscribed to the folder or not
407 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
408 $boxesall = sqimap_mailbox_list ($imap_stream);
409 foreach ($boxesall as $ref) {
410 if ($ref['unformatted'] == $folder) {
420 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
421 if ( $old_name != $new_name ) {
422 global $delimiter, $imap_server_type, $data_dir, $username;
423 if ( substr( $old_name, -1 ) == $delimiter ) {
424 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
425 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
426 $postfix = $delimiter;
431 $boxesall = sqimap_mailbox_list($imap_stream);
432 $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
433 ' ' . sqimap_encode_mailbox_name($new_name);
434 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
435 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
436 $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
437 removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
438 sqimap_subscribe($imap_stream, $new_name.$postfix);
439 setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref);
440 do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
441 $l = strlen( $old_name ) +
1;
444 foreach ($boxesall as $box) {
445 if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
446 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
447 if ($imap_server_type == 'cyrus') {
448 $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
449 $data = sqimap_run_command($imap_stream, $cmd, true,
450 $response, $message);
452 sqimap_unsubscribe($imap_stream, $box[$p]);
453 $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
454 removePref($data_dir, $username, 'thread_'.$box[$p]);
455 sqimap_subscribe($imap_stream, $new_sub);
456 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
457 do_hook_function('rename_or_delete_folder',
458 $args = array($box[$p], 'rename', $new_sub));
465 * Formats a mailbox into parts for the $boxesall array
469 * raw - Raw LIST/LSUB response from the IMAP server
470 * formatted - nicely formatted folder name
471 * unformatted - unformatted, but with delimiter at end removed
472 * unformatted-dm - folder name as it appears in raw response
473 * unformatted-disp - unformatted without $folder_prefix
475 function sqimap_mailbox_parse ($line, $line_lsub) {
476 global $folder_prefix, $delimiter;
478 /* Process each folder line */
479 for ($g = 0, $cnt = count($line); $g < $cnt; ++
$g) {
480 /* Store the raw IMAP reply */
481 if (isset($line[$g])) {
482 $boxesall[$g]['raw'] = $line[$g];
484 $boxesall[$g]['raw'] = '';
487 /* Count number of delimiters ($delimiter) in folder name */
488 $mailbox = /*trim(*/$line_lsub[$g]/*)*/;
489 $dm_count = substr_count($mailbox, $delimiter);
490 if (substr($mailbox, -1) == $delimiter) {
491 /* If name ends in delimiter, decrement count by one */
495 /* Format folder name, but only if it's a INBOX.* or has a parent. */
496 $boxesallbyname[$mailbox] = $g;
497 $parentfolder = readMailboxParent($mailbox, $delimiter);
498 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
499 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
500 (isset($boxesallbyname[$parentfolder]) &&
501 (strlen($parentfolder) > 0) ) ) {
502 $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
504 $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
506 $boxesall[$g]['formatted'] = '';
508 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
510 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
513 $boxesall[$g]['unformatted-dm'] = $mailbox;
514 if (substr($mailbox, -1) == $delimiter) {
515 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
517 $boxesall[$g]['unformatted'] = $mailbox;
518 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
519 $mailbox = substr($mailbox, strlen($folder_prefix));
521 $boxesall[$g]['unformatted-disp'] = $mailbox;
522 $boxesall[$g]['id'] = $g;
524 $boxesall[$g]['flags'] = array();
525 if (isset($line[$g])) {
526 ereg("\(([^)]*)\)",$line[$g],$regs);
527 // FIXME Flags do contain the \ character. \NoSelect \NoInferiors
528 // and $MDNSent <= last one doesn't have the \
529 // It's better to follow RFC3501 instead of using our own naming.
530 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
532 $boxesall[$g]['flags'] = explode(' ', $flags);
540 * Returns list of options (to be echoed into select statement
541 * based on available mailboxes and separators
542 * Caller should surround options with <SELECT..> </SELECT> and
544 * $imap_stream - $imapConnection to query for mailboxes
545 * $show_selected - array containing list of mailboxes to pre-select (0 if none)
546 * $folder_skip - array of folders to keep out of option list (compared in lower)
547 * $boxes - list of already fetched boxes (for places like folder panel, where
548 * you know these options will be shown 3 times in a row.. (most often unset).
549 * $flag - flag to check for in mailbox flags, used to filter out mailboxes.
550 * 'noselect' by default to remove unselectable mailboxes.
551 * 'noinferiors' used to filter out folders that can not contain subfolders.
552 * NULL to avoid flag check entirely.
553 * NOTE: noselect and noiferiors are used internally. The IMAP representation is
554 * \NoSelect and \NoInferiors
555 * $use_long_format - override folder display preference and always show full folder name.
557 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
558 $flag = 'noselect', $use_long_format = false ) {
559 global $username, $data_dir;
561 if ( $use_long_format ) {
562 $shorten_box_names = 0;
564 $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF
);
568 $boxes = sqimap_mailbox_list($imap_stream);
571 foreach ($boxes as $boxes_part) {
572 if ($flag == NULL ||
!in_array($flag, $boxes_part['flags'])) {
573 $box = $boxes_part['unformatted'];
575 if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
578 $lowerbox = strtolower($box);
579 // mailboxes are casesensitive => inbox.sent != inbox.Sent
580 // nevermind, to many dependencies this should be fixed!
582 if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
585 switch ($shorten_box_names)
587 case 2: /* delimited, style = 2 */
588 $box2 = str_replace(' ', '. ', $boxes_part['formatted']);
590 case 1: /* indent, style = 1 */
591 $box2 = $boxes_part['formatted'];
593 default: /* default, long names, style = 0 */
594 $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
598 if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
599 $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'" SELECTED>'.$box2.'</OPTION>' . "\n";
601 $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'">'.$box2.'</OPTION>' . "\n";
605 return $mbox_options;
609 * Returns sorted mailbox lists in several different ways.
610 * See comment on sqimap_mailbox_parse() for info about the returned array.
612 function sqimap_mailbox_list($imap_stream) {
613 global $default_folder_prefix;
615 if (!isset($boxesnew)) {
616 global $data_dir, $username, $list_special_folders_first,
617 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
618 $move_to_trash, $move_to_sent, $save_as_draft,
619 $delimiter, $noselect_fix_enable;
621 $inbox_in_list = false;
622 $inbox_subscribed = false;
624 require_once(SM_PATH
. 'include/load_prefs.php');
626 if ($noselect_fix_enable) {
627 $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
629 $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
632 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
633 true, $response, $message);
634 $lsub_ary = compact_mailboxes_response($lsub_ary);
636 $sorted_lsub_ary = array();
637 for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++
) {
638 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
639 $sorted_lsub_ary[] = $temp_mailbox_name;
640 if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
641 $inbox_subscribed = true;
645 /* natural sort mailboxes */
646 if (isset($sorted_lsub_ary)) {
647 usort($sorted_lsub_ary, 'strnatcasecmp');
650 * The LSUB response doesn't provide us information about \Noselect
651 * mail boxes. The LIST response does, that's why we need to do a LIST
652 * call to retrieve the flags for the mailbox
653 * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response.
654 * in other words, we cannot rely on it.
656 $sorted_list_ary = array();
657 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
658 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
659 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
662 $mbx = $sorted_lsub_ary[$i];
664 $mbx = stripslashes($mbx);
665 $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx),
666 true, $response, $message);
667 $read = compact_mailboxes_response($read);
668 if (isset($read[0])) {
669 $sorted_list_ary[$i] = $read[0];
671 $sorted_list_ary[$i] = '';
675 * Just in case they're not subscribed to their inbox,
676 * we'll get it for them anyway
678 if (!$inbox_subscribed) {
679 $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" INBOX',
680 true, $response, $message);
681 $sorted_list_ary[] = implode('', compact_mailboxes_response($inbox_ary));
682 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
685 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
687 /* Now, lets sort for special folders */
688 $boxesnew = $used = array();
691 $cnt = count($boxesall);
692 $used = array_pad($used,$cnt,false);
693 for($k = 0; $k < $cnt; ++
$k) {
694 if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
695 $boxesnew[] = $boxesall[$k];
700 /* List special folders and their subfolders, if requested. */
701 if ($list_special_folders_first) {
702 for($k = 0; $k < $cnt; ++
$k) {
703 if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
704 $boxesnew[] = $boxesall[$k];
710 /* Rest of the folders */
711 for($k = 0; $k < $cnt; $k++
) {
713 $boxesnew[] = $boxesall[$k];
722 * Returns a list of all folders, subscribed or not
724 function sqimap_mailbox_list_all($imap_stream) {
725 global $list_special_folders_first, $folder_prefix, $delimiter;
727 $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false);
728 $read_ary = compact_mailboxes_response($read_ary);
732 $fld_pre_length = strlen($folder_prefix);
733 for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++
) {
734 /* Store the raw IMAP reply */
735 $boxes[$g]['raw'] = $read_ary[$i];
737 /* Count number of delimiters ($delimiter) in folder name */
738 $mailbox = find_mailbox_name($read_ary[$i]);
739 $dm_count = substr_count($mailbox, $delimiter);
740 if (substr($mailbox, -1) == $delimiter) {
741 /* If name ends in delimiter - decrement count by one */
745 /* Format folder name, but only if it's a INBOX.* or has a parent. */
746 $boxesallbyname[$mailbox] = $g;
747 $parentfolder = readMailboxParent($mailbox, $delimiter);
748 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
749 (ereg('^'.$folder_prefix, $mailbox)) ||
750 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
752 $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
754 $boxes[$g]['formatted'] = '';
756 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
758 $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
761 $boxes[$g]['unformatted-dm'] = $mailbox;
762 if (substr($mailbox, -1) == $delimiter) {
763 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
765 $boxes[$g]['unformatted'] = $mailbox;
766 $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
768 $boxes[$g]['id'] = $g;
770 /* Now lets get the flags for this mailbox */
771 $read_mlbx = $read_ary[$i];
772 $flags = substr($read_mlbx, strpos($read_mlbx, '(')+
1);
773 $flags = substr($flags, 0, strpos($flags, ')'));
774 $flags = str_replace('\\', '', $flags);
775 $flags = trim(strtolower($flags));
777 $boxes[$g]['flags'] = explode(' ', $flags);
779 $boxes[$g]['flags'] = array();
783 if(is_array($boxes)) {
790 function sqimap_mailbox_tree($imap_stream) {
791 global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
792 if (!isset($boxesnew)) {
794 global $data_dir, $username, $list_special_folders_first,
795 $folder_prefix, $delimiter, $trash_folder, $move_to_trash,
799 $inbox_in_list = false;
800 $inbox_subscribed = false;
802 $noinferiors = false;
804 require_once(SM_PATH
. 'include/load_prefs.php');
807 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
808 true, $response, $message);
809 $lsub_ary = compact_mailboxes_response($lsub_ary);
811 /* Check to see if we have an INBOX */
814 for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++
) {
815 if (preg_match("/^\*\s+LSUB\s+(.*)\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
816 $lsub_ary[$i] = strtoupper($lsub_ary[$i]);
822 if ($has_inbox == false) {
823 $lsub_ary[] = '* LSUB () NIL INBOX';
827 * Section about removing the last element was removed
828 * We don't return "* OK" anymore from sqimap_read_data
831 $sorted_lsub_ary = array();
832 $cnt = count($lsub_ary);
833 for ($i = 0; $i < $cnt; $i++
) {
834 $mbx = find_mailbox_name($lsub_ary[$i]);
836 // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting
837 if ($imap_server_type != "uw") {
838 $noselect = check_is_noselect($lsub_ary[$i]);
839 $noinferiors = check_is_noinferiors($lsub_ary[$i]);
841 if (substr($mbx, -1) == $delimiter) {
842 $mbx = substr($mbx, 0, strlen($mbx) - 1);
844 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
846 // FIX ME this requires a config setting inside conf.pl instead of checking on server type
847 if ($imap_server_type == "uw") {
850 // prepare an array with queries
851 foreach ($sorted_lsub_ary as $aMbx) {
852 $mbx = stripslashes($aMbx['mbx']);
853 sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false);
856 $sorted_lsub_ary = array();
857 // execute all the queries at once
858 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
859 foreach($aTag as $tag => $mbx) {
860 if ($aServerResponse[$tag] == 'OK') {
861 $sResponse = implode('', $aResponse[$tag]);
862 $noselect = check_is_noselect($sResponse);
863 $noinferiors = check_is_noinferiors($sResponse);
864 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
867 $cnt = count($sorted_lsub_ary);
869 $sorted_lsub_ary = array_values($sorted_lsub_ary);
870 array_multisort($sorted_lsub_ary, SORT_ASC
, SORT_REGULAR
);
871 $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
876 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
877 global $data_dir, $username, $list_special_folders_first,
878 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
879 $move_to_trash, $move_to_sent, $save_as_draft,
880 $delimiter, $imap_server_type;
882 $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
884 /* create virtual root node */
885 $mailboxes= new mailboxes();
886 $mailboxes->is_root
= true;
891 if (isset($folder_prefix) && ($folder_prefix != '')) {
892 $start = substr_count($folder_prefix,$delimiter);
893 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
895 $mailboxes->mailboxname_full
= substr($folder_prefix,0, (strlen($folder_prefix)-1));
897 $mailboxes->mailboxname_full
= $folder_prefix;
900 $mailboxes->mailboxname_sub
= $mailboxes->mailboxname_full
;
905 $cnt = count($mbx_ary);
906 for ($i=0; $i < $cnt; $i++
) {
907 if ($mbx_ary[$i]['mbx'] !='' ) {
908 $mbx = new mailboxes();
909 $mailbox = $mbx_ary[$i]['mbx'];
912 sent subfolders messes up using existing code as subfolders
913 were marked, but the parents were ordered somewhere else in
914 the list, despite having "special folders at top" option set.
915 Need a better method than this.
918 if ($mailbox == 'INBOX') {
919 $mbx->is_special = true;
920 } elseif (stristr($trash_folder , $mailbox)) {
921 $mbx->is_special = true;
922 } elseif (stristr($sent_folder , $mailbox)) {
923 $mbx->is_special = true;
924 } elseif (stristr($draft_folder , $mailbox)) {
925 $mbx->is_special = true;
930 $mbx->is_inbox = true;
931 $mbx->is_special = true;
932 $mbx_ary[$i]['noselect'] = false;
935 $mbx->is_trash = true;
936 $mbx->is_special = true;
939 $mbx->is_sent = true;
940 $mbx->is_special = true;
943 $mbx->is_draft = true;
944 $mbx->is_special = true;
948 $mbx->is_special |
= ($mbx->is_inbox
= (strtoupper($mailbox) == 'INBOX'));
949 $mbx->is_special |
= ($mbx->is_trash
= isTrashMailbox($mailbox));
950 $mbx->is_special |
= ($mbx->is_sent
= isSentMailbox($mailbox));
951 $mbx->is_special |
= ($mbx->is_draft
= isDraftMailbox($mailbox));
952 if (!$mbx->is_special
)
953 $mbx->is_special
= boolean_hook_function('special_mailbox', $mailbox, 1);
955 if (isset($mbx_ary[$i]['unseen'])) {
956 $mbx->unseen
= $mbx_ary[$i]['unseen'];
958 if (isset($mbx_ary[$i]['nummessages'])) {
959 $mbx->total
= $mbx_ary[$i]['nummessages'];
962 $mbx->is_noselect
= $mbx_ary[$i]['noselect'];
963 $mbx->is_noinferiors
= $mbx_ary[$i]['noinferiors'];
965 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
967 $mbx->mailboxname_sub
= substr($mbx_ary[$i]['mbx'],$r_del_pos+
1);
968 } else { /* mailbox is root folder */
969 $mbx->mailboxname_sub
= $mbx_ary[$i]['mbx'];
971 $mbx->mailboxname_full
= $mbx_ary[$i]['mbx'];
973 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
976 sqimap_utf7_decode_mbx_tree($mailboxes);
977 sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
981 function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
982 if (strtoupper($mbx_tree->mailboxname_sub
) == 'INBOX')
983 $mbx_tree->mailboxname_sub
= _("INBOX");
985 $mbx_tree->mailboxname_sub
= imap_utf7_decode_local($mbx_tree->mailboxname_sub
);
986 if ($mbx_tree->mbxs
) {
987 $iCnt = count($mbx_tree->mbxs
);
988 for ($i=0;$i<$iCnt;++
$i) {
989 $mbxs_tree->mbxs
[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs
[$i]);
995 function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
997 $aMbxs[] =& $mbx_tree;
998 if ($mbx_tree->mbxs
) {
999 $iCnt = count($mbx_tree->mbxs
);
1000 for ($i=0;$i<$iCnt;++
$i) {
1001 sqimap_tree_to_ref_array($mbx_tree->mbxs
[$i],$aMbxs);
1006 function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
1007 global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
1008 $aMbxs = $aQuery = $aTag = array();
1009 sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
1010 // remove the root node
1011 array_shift($aMbxs);
1013 if($unseen_notify == 3) {
1014 $cnt = count($aMbxs);
1015 for($i=0;$i<$cnt;++
$i) {
1016 $oMbx =& $aMbxs[$i];
1017 if (!$oMbx->is_noselect
) {
1018 $mbx = $oMbx->mailboxname_full
;
1019 if ($unseen_type == 2 ||
1020 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1021 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)';
1023 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)';
1025 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
1027 $oMbx->unseen
= $oMbx->total
= false;
1031 $aMbxs[$i] =& $oMbx;
1033 // execute all the queries at once
1034 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
1035 $cnt = count($aMbxs);
1036 for($i=0;$i<$cnt;++
$i) {
1037 $oMbx =& $aMbxs[$i];
1039 if ($tag && $aServerResponse[$tag] == 'OK') {
1040 $sResponse = implode('', $aResponse[$tag]);
1041 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
1042 $oMbx->unseen
= $regs[1];
1044 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
1045 $oMbx->total
= $regs[1];
1050 } else if ($unseen_notify == 2) { // INBOX only
1051 $cnt = count($aMbxs);
1052 for($i=0;$i<$cnt;++
$i) {
1053 $oMbx =& $aMbxs[$i];
1054 if (strtoupper($oMbx->mailboxname_full
) == 'INBOX' ||
1055 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1056 if ($unseen_type == 2 ||
1057 ($oMbx->mailboxname_full
== $trash_folder && $move_to_trash)) {
1058 $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full
);
1059 $oMbx->unseen
= $aStatus['UNSEEN'];
1060 $oMbx->total
= $aStatus['MESSAGES'];
1062 $oMbx->unseen
= sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full
);
1064 $aMbxs[$i] =& $oMbx;
1065 if (!$move_to_trash && $trash_folder) {
1068 // trash comes after INBOX
1069 if ($oMbx->mailboxname_full
== $trash_folder) {