a3b419571611e5e32808bbf5f8158c7cc2a59312
6 * Copyright (c) 1999-2004 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
17 require_once(SM_PATH
. 'functions/imap_utf7_local.php');
24 * FIXME. This class should be extracted and placed in a separate file that
25 * can be included before we start the session. That makes caching of the tree
26 * possible. On a refresh mailboxes from left_main.php the only function that
27 * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
28 * / rename / delete / new we have to create methods for adding/changing the
29 * mailbox in the mbx_tree without the need for a refresh.
30 * @package squirrelmail
34 var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
35 $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
36 $is_trash = false, $is_draft = false, $mbxs = array(),
37 $unseen = false, $total = false;
39 function addMbx($mbx, $delimiter, $start, $specialfirst) {
40 $ary = explode($delimiter, $mbx->mailboxname_full
);
42 for ($i = $start, $c = count($ary)-1; $i < $c; $i++
) {
43 $mbx_childs =& $mbx_parent->mbxs
;
46 foreach ($mbx_childs as $key => $parent) {
47 if ($parent->mailboxname_sub
== $ary[$i]) {
48 $mbx_parent =& $mbx_parent->mbxs
[$key];
55 $no_select_mbx = new mailboxes();
56 if (isset($mbx_parent->mailboxname_full
) && $mbx_parent->mailboxname_full
!= '') {
57 $no_select_mbx->mailboxname_full
= $mbx_parent->mailboxname_full
.$delimiter.$ary[$i];
59 $no_select_mbx->mailboxname_full
= $ary[$i];
61 $no_select_mbx->mailboxname_sub
= $ary[$i];
62 $no_select_mbx->is_noselect
= true;
63 $mbx_parent->mbxs
[] = $no_select_mbx;
67 $mbx_parent->mbxs
[] = $mbx;
68 if ($mbx->is_special
&& $specialfirst) {
69 usort($mbx_parent->mbxs
, 'sortSpecialMbx');
74 function sortSpecialMbx($a, $b) {
76 $acmp = '0'. $a->mailboxname_full
;
77 } else if ($a->is_special
) {
78 $acmp = '1'. $a->mailboxname_full
;
80 $acmp = '2' . $a->mailboxname_full
;
83 $bcmp = '0'. $b->mailboxname_full
;
84 }else if ($b->is_special
) {
85 $bcmp = '1' . $b->mailboxname_full
;
87 $bcmp = '2' . $b->mailboxname_full
;
89 return strnatcasecmp($acmp, $bcmp);
92 function compact_mailboxes_response($ary)
95 * Workaround for mailboxes returned as literal
96 * FIXME : Doesn't work if the mailbox name is multiple lines
97 * (larger then fgets buffer)
99 for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++
) {
100 if (isset($ary[$i +
1]) && substr($ary[$i], -3) == "}\r\n") {
101 if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
103 $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+
1])) . '"' . $regs[2];
104 array_splice($ary, $i+
1, 2);
108 /* remove duplicates and ensure array is contiguous */
109 return array_values(array_unique($ary));
113 * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
114 * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
115 * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
117 function find_mailbox_name($line)
119 if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
120 if (substr($regs[1], 0, 1) == '"')
121 return stripslashes(substr($regs[1], 1, -1));
128 * @return bool whether this is a Noselect mailbox.
130 function check_is_noselect ($lsub_line) {
131 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
135 * @return bool whether this is a Noinferiors mailbox.
137 function check_is_noinferiors ($lsub_line) {
138 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
142 * If $haystack is a full mailbox name, and $needle is the mailbox
143 * separator character, returns the second last part of the full
144 * mailbox name (i.e. the mailbox's parent mailbox)
146 function readMailboxParent($haystack, $needle) {
150 $parts = explode($needle, $haystack);
151 $elem = array_pop($parts);
152 while ($elem == '' && count($parts)) {
153 $elem = array_pop($parts);
155 $ret = join($needle, $parts);
161 * Check if $subbox is below the specified $parentbox
163 function isBoxBelow( $subbox, $parentbox ) {
166 * Eliminate the obvious mismatch, where the
167 * subfolder path is shorter than that of the potential parent
169 if ( strlen($subbox) < strlen($parentbox) ) {
172 /* check for delimiter */
173 if (!substr($parentbox,-1) == $delimiter) {
174 $parentbox.=$delimiter;
176 if (substr($subbox,0,strlen($parentbox)) == $parentbox) {
184 * Defines special mailboxes: given a mailbox name, it checks if this is a
185 * "special" one: INBOX, Trash, Sent or Draft.
187 function isSpecialMailbox( $box ) {
188 $ret = ( (strtolower($box) == 'inbox') ||
189 isTrashMailbox($box) ||
isSentMailbox($box) ||
isDraftMailbox($box) );
192 $ret = boolean_hook_function('special_mailbox',$box,1);
198 * @return bool whether this is a Trash folder
200 function isTrashMailbox ($box) {
201 global $trash_folder, $move_to_trash;
202 return $move_to_trash && $trash_folder &&
203 ( $box == $trash_folder ||
isBoxBelow($box, $trash_folder) );
207 * @return bool whether this is a Sent folder
209 function isSentMailbox($box) {
210 global $sent_folder, $move_to_sent;
211 return $move_to_sent && $sent_folder &&
212 ( $box == $sent_folder ||
isBoxBelow($box, $sent_folder) );
216 * @return bool whether this is a Draft folder
218 function isDraftMailbox($box) {
219 global $draft_folder, $save_as_draft;
220 return $save_as_draft &&
221 ( $box == $draft_folder ||
isBoxBelow($box, $draft_folder) );
225 * Expunges a mailbox, ie. delete all contents.
227 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, $mbx_response, $auto_expunge,
264 $sort, $allow_server_sort, $thread_sort_messages, $allow_thread_sort,
265 $username, $data_dir;
268 // Got to grab this out of prefs, since it isn't saved from mailbox_view.php
269 if ($allow_thread_sort) {
270 $thread_sort_messages = getPref($data_dir, $username, "thread_$mailbox",0);
273 for ($i = 0; $i < count($msort); $i++
) {
274 if ($msgs[$i]['ID'] == $message_id) {
279 if ( isset($msgs) ) {
281 $msgs = array_values($msgs);
282 sqsession_register($msgs, 'msgs');
285 if ( isset($msort) ) {
287 $msort = array_values($msort);
288 sqsession_register($msort, 'msort');
292 $cnt = sqimap_mailbox_expunge($imapConnection, $mailbox, true);
295 // And after all that mucking around, update the sort list!
296 // Remind me why the hell we need those two arrays again?!
298 sqgetGlobalVar('server_sort_array',$server_sort_array,SQ_SESSION
);
301 if ( $allow_thread_sort && $thread_sort_messages ) {
302 $server_sort_array = get_thread_sort($imapConnection);
303 } elseif ( $allow_server_sort ) {
304 $key = array_search($message_id,$server_sort_array,true);
305 if ($key !== false) {
306 unset($server_sort_array[$key]);
307 $server_sort_array = array_values($server_sort_array);
310 $server_sort_array = sqimap_get_php_sort_order($imapConnection, $mbx_response);
312 sqsession_register('server_sort_array',$server_sort_array);
317 * Checks whether or not the specified mailbox exists
319 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
320 if (!isset($mailbox) ||
empty($mailbox)) {
323 $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
324 true, $response, $message);
325 return isset($mbx[0]);
331 function sqimap_mailbox_select ($imap_stream, $mailbox) {
332 if ($mailbox == 'None') {
336 $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
337 true, $response, $message);
339 for ($i = 0, $cnt = count($read); $i < $cnt; $i++
) {
340 if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
341 $result[strtoupper($regs[1])] = $regs[2];
342 } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
343 $result[strtoupper($regs[2])] = $regs[1];
345 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
346 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
347 $result['PERMANENTFLAGS'] = $regs[1];
348 } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
349 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
350 $result['FLAGS'] = $regs[1];
354 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
355 $result['RIGHTS']=$regs[1];
364 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
366 if (strtolower($type) == 'noselect') {
367 $mailbox .= $delimiter;
370 $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
371 sqimap_encode_mailbox_name($mailbox),
372 true, $response, $message);
373 sqimap_subscribe ($imap_stream, $mailbox);
377 * Subscribes to an existing folder.
379 function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
380 $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
381 sqimap_encode_mailbox_name($mailbox),
382 $debug, $response, $message);
386 * Unsubscribes from an existing folder
388 function sqimap_unsubscribe ($imap_stream, $mailbox) {
389 $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
390 sqimap_encode_mailbox_name($mailbox),
391 false, $response, $message);
395 * Deletes the given folder
397 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
398 global $data_dir, $username;
399 sqimap_unsubscribe ($imap_stream, $mailbox);
400 $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
401 sqimap_encode_mailbox_name($mailbox),
402 true, $response, $message);
403 if ($response !== 'OK') {
405 sqimap_subscribe ($imap_stream, $mailbox);
407 do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
408 removePref($data_dir, $username, "thread_$mailbox");
413 * Determines if the user is subscribed to the folder or not
415 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
416 $boxesall = sqimap_mailbox_list ($imap_stream);
417 foreach ($boxesall as $ref) {
418 if ($ref['unformatted'] == $folder) {
428 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
429 if ( $old_name != $new_name ) {
430 global $delimiter, $imap_server_type, $data_dir, $username;
431 if ( substr( $old_name, -1 ) == $delimiter ) {
432 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
433 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
434 $postfix = $delimiter;
439 $boxesall = sqimap_mailbox_list($imap_stream);
440 $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
441 ' ' . sqimap_encode_mailbox_name($new_name);
442 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
443 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
444 $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
445 removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
446 sqimap_subscribe($imap_stream, $new_name.$postfix);
447 setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref);
448 do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
449 $l = strlen( $old_name ) +
1;
452 foreach ($boxesall as $box) {
453 if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
454 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
455 if ($imap_server_type == 'cyrus') {
456 $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
457 $data = sqimap_run_command($imap_stream, $cmd, true,
458 $response, $message);
460 sqimap_unsubscribe($imap_stream, $box[$p]);
461 $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
462 removePref($data_dir, $username, 'thread_'.$box[$p]);
463 sqimap_subscribe($imap_stream, $new_sub);
464 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
465 do_hook_function('rename_or_delete_folder',
466 $args = array($box[$p], 'rename', $new_sub));
473 * Formats a mailbox into parts for the $boxesall array
477 * raw - Raw LIST/LSUB response from the IMAP server
478 * formatted - nicely formatted folder name
479 * unformatted - unformatted, but with delimiter at end removed
480 * unformatted-dm - folder name as it appears in raw response
481 * unformatted-disp - unformatted without $folder_prefix
483 function sqimap_mailbox_parse ($line, $line_lsub) {
484 global $folder_prefix, $delimiter;
486 /* Process each folder line */
487 for ($g = 0, $cnt = count($line); $g < $cnt; ++
$g) {
488 /* Store the raw IMAP reply */
489 if (isset($line[$g])) {
490 $boxesall[$g]['raw'] = $line[$g];
492 $boxesall[$g]['raw'] = '';
495 /* Count number of delimiters ($delimiter) in folder name */
496 $mailbox = /*trim(*/$line_lsub[$g]/*)*/;
497 $dm_count = substr_count($mailbox, $delimiter);
498 if (substr($mailbox, -1) == $delimiter) {
499 /* If name ends in delimiter, decrement count by one */
503 /* Format folder name, but only if it's a INBOX.* or has a parent. */
504 $boxesallbyname[$mailbox] = $g;
505 $parentfolder = readMailboxParent($mailbox, $delimiter);
506 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
507 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
508 (isset($boxesallbyname[$parentfolder]) &&
509 (strlen($parentfolder) > 0) ) ) {
510 $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
512 $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
514 $boxesall[$g]['formatted'] = '';
516 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
518 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
521 $boxesall[$g]['unformatted-dm'] = $mailbox;
522 if (substr($mailbox, -1) == $delimiter) {
523 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
525 $boxesall[$g]['unformatted'] = $mailbox;
526 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
527 $mailbox = substr($mailbox, strlen($folder_prefix));
529 $boxesall[$g]['unformatted-disp'] = $mailbox;
530 $boxesall[$g]['id'] = $g;
532 $boxesall[$g]['flags'] = array();
533 if (isset($line[$g])) {
534 ereg("\(([^)]*)\)",$line[$g],$regs);
535 // FIXME Flags do contain the \ character. \NoSelect \NoInferiors
536 // and $MDNSent <= last one doesn't have the \
537 // It's better to follow RFC3501 instead of using our own naming.
538 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
540 $boxesall[$g]['flags'] = explode(' ', $flags);
548 * Returns list of options (to be echoed into select statement
549 * based on available mailboxes and separators
550 * Caller should surround options with <SELECT..> </SELECT> and
552 * $imap_stream - $imapConnection to query for mailboxes
553 * $show_selected - array containing list of mailboxes to pre-select (0 if none)
554 * $folder_skip - array of folders to keep out of option list (compared in lower)
555 * $boxes - list of already fetched boxes (for places like folder panel, where
556 * you know these options will be shown 3 times in a row.. (most often unset).
557 * $flag - flag to check for in mailbox flags, used to filter out mailboxes.
558 * 'noselect' by default to remove unselectable mailboxes.
559 * 'noinferiors' used to filter out folders that can not contain subfolders.
560 * NULL to avoid flag check entirely.
561 * NOTE: noselect and noiferiors are used internally. The IMAP representation is
562 * \NoSelect and \NoInferiors
563 * $use_long_format - override folder display preference and always show full folder name.
565 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
566 $flag = 'noselect', $use_long_format = false ) {
567 global $username, $data_dir;
569 if ( $use_long_format ) {
570 $shorten_box_names = 0;
572 $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF
);
576 $boxes = sqimap_mailbox_list($imap_stream);
579 foreach ($boxes as $boxes_part) {
580 if ($flag == NULL ||
!in_array($flag, $boxes_part['flags'])) {
581 $box = $boxes_part['unformatted'];
583 if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
586 $lowerbox = strtolower($box);
587 // mailboxes are casesensitive => inbox.sent != inbox.Sent
588 // nevermind, to many dependencies this should be fixed!
590 if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
593 switch ($shorten_box_names)
595 case 2: /* delimited, style = 2 */
596 $box2 = str_replace(' ', '. ', $boxes_part['formatted']);
598 case 1: /* indent, style = 1 */
599 $box2 = $boxes_part['formatted'];
601 default: /* default, long names, style = 0 */
602 $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
606 if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
607 $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'" SELECTED>'.$box2.'</OPTION>' . "\n";
609 $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'">'.$box2.'</OPTION>' . "\n";
613 return $mbox_options;
617 * Returns sorted mailbox lists in several different ways.
618 * See comment on sqimap_mailbox_parse() for info about the returned array.
622 function sqimap_mailbox_list($imap_stream, $force=false) {
623 global $default_folder_prefix;
625 if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION
) ||
$force) {
626 global $data_dir, $username, $list_special_folders_first,
627 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
628 $move_to_trash, $move_to_sent, $save_as_draft,
629 $delimiter, $noselect_fix_enable, $imap_server_type;
630 $inbox_in_list = false;
631 $inbox_subscribed = false;
632 $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
634 require_once(SM_PATH
. 'include/load_prefs.php');
637 if ($listsubscribed) {
638 $lsub = 'LIST (SUBSCRIBED)';
643 if ($noselect_fix_enable) {
645 $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
647 $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
650 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
651 true, $response, $message);
652 $lsub_ary = compact_mailboxes_response($lsub_ary);
654 $sorted_lsub_ary = array();
655 for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++
) {
657 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
658 $sorted_lsub_ary[] = $temp_mailbox_name;
659 if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
660 $inbox_subscribed = true;
664 /* natural sort mailboxes */
665 if (isset($sorted_lsub_ary)) {
666 usort($sorted_lsub_ary, 'strnatcasecmp');
669 * The LSUB response doesn't provide us information about \Noselect
670 * mail boxes. The LIST response does, that's why we need to do a LIST
671 * call to retrieve the flags for the mailbox
672 * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response.
673 * in other words, we cannot rely on it.
675 $sorted_list_ary = array();
676 // if (!$listsubscribed) {
677 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
678 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
679 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
682 $mbx = $sorted_lsub_ary[$i];
685 $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx),
686 true, $response, $message);
688 $read = compact_mailboxes_response($read);
690 if (isset($read[0])) {
691 $sorted_list_ary[$i] = $read[0];
693 $sorted_list_ary[$i] = '';
698 * Just in case they're not subscribed to their inbox,
699 * we'll get it for them anyway
701 if (!$inbox_subscribed) {
702 $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"',
703 true, $response, $message);
704 $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary));
705 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
708 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
710 /* Now, lets sort for special folders */
711 $boxesnew = $used = array();
714 $cnt = count($boxesall);
715 $used = array_pad($used,$cnt,false);
716 for($k = 0; $k < $cnt; ++
$k) {
717 if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
718 $boxesnew[] = $boxesall[$k];
723 /* List special folders and their subfolders, if requested. */
724 if ($list_special_folders_first) {
725 for($k = 0; $k < $cnt; ++
$k) {
726 if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
727 $boxesnew[] = $boxesall[$k];
732 /* Rest of the folders */
733 for($k = 0; $k < $cnt; $k++
) {
735 $boxesnew[] = $boxesall[$k];
738 sqsession_register($boxesnew,'boxesnew');
744 * Returns a list of all folders, subscribed or not
746 function sqimap_mailbox_list_all($imap_stream) {
747 global $list_special_folders_first, $folder_prefix, $delimiter;
749 $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false);
750 $read_ary = compact_mailboxes_response($read_ary);
754 $fld_pre_length = strlen($folder_prefix);
755 for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++
) {
756 /* Store the raw IMAP reply */
757 $boxes[$g]['raw'] = $read_ary[$i];
759 /* Count number of delimiters ($delimiter) in folder name */
760 $mailbox = find_mailbox_name($read_ary[$i]);
761 $dm_count = substr_count($mailbox, $delimiter);
762 if (substr($mailbox, -1) == $delimiter) {
763 /* If name ends in delimiter - decrement count by one */
767 /* Format folder name, but only if it's a INBOX.* or has a parent. */
768 $boxesallbyname[$mailbox] = $g;
769 $parentfolder = readMailboxParent($mailbox, $delimiter);
770 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
771 (ereg('^'.$folder_prefix, $mailbox)) ||
772 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
774 $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
776 $boxes[$g]['formatted'] = '';
778 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
780 $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
783 $boxes[$g]['unformatted-dm'] = $mailbox;
784 if (substr($mailbox, -1) == $delimiter) {
785 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
787 $boxes[$g]['unformatted'] = $mailbox;
788 $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
790 $boxes[$g]['id'] = $g;
792 /* Now lets get the flags for this mailbox */
793 $read_mlbx = $read_ary[$i];
794 $flags = substr($read_mlbx, strpos($read_mlbx, '(')+
1);
795 $flags = substr($flags, 0, strpos($flags, ')'));
796 $flags = str_replace('\\', '', $flags);
797 $flags = trim(strtolower($flags));
799 $boxes[$g]['flags'] = explode(' ', $flags);
801 $boxes[$g]['flags'] = array();
805 if(is_array($boxes)) {
812 function sqimap_mailbox_tree($imap_stream) {
813 global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
816 global $data_dir, $username, $list_special_folders_first,
817 $folder_prefix, $delimiter, $trash_folder, $move_to_trash,
821 $inbox_in_list = false;
822 $inbox_subscribed = false;
824 $noinferiors = false;
826 require_once(SM_PATH
. 'include/load_prefs.php');
829 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
830 true, $response, $message);
831 $lsub_ary = compact_mailboxes_response($lsub_ary);
833 /* Check to see if we have an INBOX */
836 for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++
) {
837 if (preg_match("/^\*\s+LSUB.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
838 $lsub_ary[$i] = strtoupper($lsub_ary[$i]);
839 // in case of an unsubscribed inbox an imap server can
840 // return the inbox in the lsub results with a \NoSelect
842 if (!preg_match("/\*\s+LSUB\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) {
845 // remove the result and request it again with a list
846 // response at a later stage.
847 unset($lsub_ary[$i]);
848 // re-index the array otherwise the addition of the LIST
849 // response will fail in PHP 4.1.2 and probably other older versions
850 $lsub_ary = array_values($lsub_ary);
856 if ($has_inbox == false) {
857 // do a list request for inbox because we should always show
858 // inbox even if the user isn't subscribed to it.
859 $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" INBOX',
860 true, $response, $message);
861 $inbox_ary = compact_mailboxes_response($inbox_ary);
862 if (count($inbox_ary)) {
863 $lsub_ary[] = $inbox_ary[0];
868 * Section about removing the last element was removed
869 * We don't return "* OK" anymore from sqimap_read_data
872 $sorted_lsub_ary = array();
873 $cnt = count($lsub_ary);
874 for ($i = 0; $i < $cnt; $i++
) {
875 $mbx = find_mailbox_name($lsub_ary[$i]);
877 // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting
878 if ($imap_server_type != "uw") {
879 $noselect = check_is_noselect($lsub_ary[$i]);
880 $noinferiors = check_is_noinferiors($lsub_ary[$i]);
882 if (substr($mbx, -1) == $delimiter) {
883 $mbx = substr($mbx, 0, strlen($mbx) - 1);
885 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
887 // FIX ME this requires a config setting inside conf.pl instead of checking on server type
888 if ($imap_server_type == "uw") {
891 // prepare an array with queries
892 foreach ($sorted_lsub_ary as $aMbx) {
893 $mbx = stripslashes($aMbx['mbx']);
894 sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false);
897 $sorted_lsub_ary = array();
898 // execute all the queries at once
899 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
900 foreach($aTag as $tag => $mbx) {
901 if ($aServerResponse[$tag] == 'OK') {
902 $sResponse = implode('', $aResponse[$tag]);
903 $noselect = check_is_noselect($sResponse);
904 $noinferiors = check_is_noinferiors($sResponse);
905 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
908 $cnt = count($sorted_lsub_ary);
910 $sorted_lsub_ary = array_values($sorted_lsub_ary);
911 array_multisort($sorted_lsub_ary, SORT_ASC
, SORT_REGULAR
);
912 $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
917 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
918 global $data_dir, $username, $list_special_folders_first,
919 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
920 $move_to_trash, $move_to_sent, $save_as_draft,
921 $delimiter, $imap_server_type;
923 $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
925 /* create virtual root node */
926 $mailboxes= new mailboxes();
927 $mailboxes->is_root
= true;
932 if (isset($folder_prefix) && ($folder_prefix != '')) {
933 $start = substr_count($folder_prefix,$delimiter);
934 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
936 $mailboxes->mailboxname_full
= substr($folder_prefix,0, (strlen($folder_prefix)-1));
938 $mailboxes->mailboxname_full
= $folder_prefix;
941 $mailboxes->mailboxname_sub
= $mailboxes->mailboxname_full
;
946 $cnt = count($mbx_ary);
947 for ($i=0; $i < $cnt; $i++
) {
948 if ($mbx_ary[$i]['mbx'] !='' ) {
949 $mbx = new mailboxes();
950 $mailbox = $mbx_ary[$i]['mbx'];
953 sent subfolders messes up using existing code as subfolders
954 were marked, but the parents were ordered somewhere else in
955 the list, despite having "special folders at top" option set.
956 Need a better method than this.
959 if ($mailbox == 'INBOX') {
960 $mbx->is_special = true;
961 } elseif (stristr($trash_folder , $mailbox)) {
962 $mbx->is_special = true;
963 } elseif (stristr($sent_folder , $mailbox)) {
964 $mbx->is_special = true;
965 } elseif (stristr($draft_folder , $mailbox)) {
966 $mbx->is_special = true;
971 $mbx->is_inbox = true;
972 $mbx->is_special = true;
973 $mbx_ary[$i]['noselect'] = false;
976 $mbx->is_trash = true;
977 $mbx->is_special = true;
980 $mbx->is_sent = true;
981 $mbx->is_special = true;
984 $mbx->is_draft = true;
985 $mbx->is_special = true;
989 $mbx->is_special |
= ($mbx->is_inbox
= (strtoupper($mailbox) == 'INBOX'));
990 $mbx->is_special |
= ($mbx->is_trash
= isTrashMailbox($mailbox));
991 $mbx->is_special |
= ($mbx->is_sent
= isSentMailbox($mailbox));
992 $mbx->is_special |
= ($mbx->is_draft
= isDraftMailbox($mailbox));
993 if (!$mbx->is_special
)
994 $mbx->is_special
= boolean_hook_function('special_mailbox', $mailbox, 1);
996 if (isset($mbx_ary[$i]['unseen'])) {
997 $mbx->unseen
= $mbx_ary[$i]['unseen'];
999 if (isset($mbx_ary[$i]['nummessages'])) {
1000 $mbx->total
= $mbx_ary[$i]['nummessages'];
1003 $mbx->is_noselect
= $mbx_ary[$i]['noselect'];
1004 $mbx->is_noinferiors
= $mbx_ary[$i]['noinferiors'];
1006 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
1008 $mbx->mailboxname_sub
= substr($mbx_ary[$i]['mbx'],$r_del_pos+
1);
1009 } else { /* mailbox is root folder */
1010 $mbx->mailboxname_sub
= $mbx_ary[$i]['mbx'];
1012 $mbx->mailboxname_full
= $mbx_ary[$i]['mbx'];
1014 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
1017 sqimap_utf7_decode_mbx_tree($mailboxes);
1018 sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
1022 function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
1023 if (strtoupper($mbx_tree->mailboxname_full
) == 'INBOX')
1024 $mbx_tree->mailboxname_sub
= _("INBOX");
1026 $mbx_tree->mailboxname_sub
= imap_utf7_decode_local($mbx_tree->mailboxname_sub
);
1027 if ($mbx_tree->mbxs
) {
1028 $iCnt = count($mbx_tree->mbxs
);
1029 for ($i=0;$i<$iCnt;++
$i) {
1030 $mbxs_tree->mbxs
[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs
[$i]);
1036 function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
1038 $aMbxs[] =& $mbx_tree;
1039 if ($mbx_tree->mbxs
) {
1040 $iCnt = count($mbx_tree->mbxs
);
1041 for ($i=0;$i<$iCnt;++
$i) {
1042 sqimap_tree_to_ref_array($mbx_tree->mbxs
[$i],$aMbxs);
1047 function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
1048 global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
1049 $aMbxs = $aQuery = $aTag = array();
1050 sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
1051 // remove the root node
1052 array_shift($aMbxs);
1054 if($unseen_notify == 3) {
1055 $cnt = count($aMbxs);
1056 for($i=0;$i<$cnt;++
$i) {
1057 $oMbx =& $aMbxs[$i];
1058 if (!$oMbx->is_noselect
) {
1059 $mbx = $oMbx->mailboxname_full
;
1060 if ($unseen_type == 2 ||
1061 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1062 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)';
1064 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)';
1066 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
1068 $oMbx->unseen
= $oMbx->total
= false;
1072 $aMbxs[$i] =& $oMbx;
1074 // execute all the queries at once
1075 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
1076 $cnt = count($aMbxs);
1077 for($i=0;$i<$cnt;++
$i) {
1078 $oMbx =& $aMbxs[$i];
1080 if ($tag && $aServerResponse[$tag] == 'OK') {
1081 $sResponse = implode('', $aResponse[$tag]);
1082 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
1083 $oMbx->unseen
= $regs[1];
1085 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
1086 $oMbx->total
= $regs[1];
1091 } else if ($unseen_notify == 2) { // INBOX only
1092 $cnt = count($aMbxs);
1093 for($i=0;$i<$cnt;++
$i) {
1094 $oMbx =& $aMbxs[$i];
1095 if (strtoupper($oMbx->mailboxname_full
) == 'INBOX' ||
1096 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1097 if ($unseen_type == 2 ||
1098 ($oMbx->mailboxname_full
== $trash_folder && $move_to_trash)) {
1099 $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full
);
1100 $oMbx->unseen
= $aStatus['UNSEEN'];
1101 $oMbx->total
= $aStatus['MESSAGES'];
1103 $oMbx->unseen
= sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full
);
1105 $aMbxs[$i] =& $oMbx;
1106 if (!$move_to_trash && $trash_folder) {
1109 // trash comes after INBOX
1110 if ($oMbx->mailboxname_full
== $trash_folder) {