6 * Copyright (c) 1999-2005 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This implements all functions that manipulate mailboxes
12 * @package squirrelmail
17 if (! defined('SM_PATH')) define('SM_PATH','../');
20 require_once(SM_PATH
. 'functions/imap_utf7_local.php');
27 * FIXME. This class should be extracted and placed in a separate file that
28 * can be included before we start the session. That makes caching of the tree
29 * possible. On a refresh mailboxes from left_main.php the only function that
30 * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
31 * / rename / delete / new we have to create methods for adding/changing the
32 * mailbox in the mbx_tree without the need for a refresh.
34 * Some code fragments are present in 1.3.0 - 1.4.4.
35 * @package squirrelmail
40 var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
41 $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
42 $is_trash = false, $is_draft = false, $mbxs = array(),
43 $unseen = false, $total = false;
45 function addMbx($mbx, $delimiter, $start, $specialfirst) {
46 $ary = explode($delimiter, $mbx->mailboxname_full
);
48 for ($i = $start, $c = count($ary)-1; $i < $c; $i++
) {
49 $mbx_childs =& $mbx_parent->mbxs
;
52 foreach ($mbx_childs as $key => $parent) {
53 if ($parent->mailboxname_sub
== $ary[$i]) {
54 $mbx_parent =& $mbx_parent->mbxs
[$key];
61 $no_select_mbx = new mailboxes();
62 if (isset($mbx_parent->mailboxname_full
) && $mbx_parent->mailboxname_full
!= '') {
63 $no_select_mbx->mailboxname_full
= $mbx_parent->mailboxname_full
.$delimiter.$ary[$i];
65 $no_select_mbx->mailboxname_full
= $ary[$i];
67 $no_select_mbx->mailboxname_sub
= $ary[$i];
68 $no_select_mbx->is_noselect
= true;
69 $mbx_parent->mbxs
[] = $no_select_mbx;
73 $mbx_parent->mbxs
[] = $mbx;
74 if ($mbx->is_special
&& $specialfirst) {
75 usort($mbx_parent->mbxs
, 'sortSpecialMbx');
81 * array callback used for sorting in mailboxes class
84 * @return integer see php strnatcasecmp()
87 function sortSpecialMbx($a, $b) {
89 $acmp = '0'. $a->mailboxname_full
;
90 } else if ($a->is_special
) {
91 $acmp = '1'. $a->mailboxname_full
;
93 $acmp = '2' . $a->mailboxname_full
;
96 $bcmp = '0'. $b->mailboxname_full
;
97 }else if ($b->is_special
) {
98 $bcmp = '1' . $b->mailboxname_full
;
100 $bcmp = '2' . $b->mailboxname_full
;
102 return strnatcasecmp($acmp, $bcmp);
110 function compact_mailboxes_response($ary) {
112 * Workaround for mailboxes returned as literal
113 * FIXME : Doesn't work if the mailbox name is multiple lines
114 * (larger then fgets buffer)
116 for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++
) {
117 if (isset($ary[$i +
1]) && substr($ary[$i], -3) == "}\r\n") {
118 if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
120 $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+
1])) . '"' . $regs[2];
121 array_splice($ary, $i+
1, 2);
125 /* remove duplicates and ensure array is contiguous */
126 return array_values(array_unique($ary));
130 * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
131 * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
132 * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
134 * Originally stored in functions/strings.php. Since 1.2.6 stored in
135 * functions/imap_mailbox.php
136 * @param string $line imap LIST/LSUB response line
137 * @return string mailbox name
139 function find_mailbox_name($line) {
140 if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
141 if (substr($regs[1], 0, 1) == '"')
142 return stripslashes(substr($regs[1], 1, -1));
149 * Detects if mailbox has noselect flag (can't store messages)
150 * In versions older than 1.4.5 function checks only LSUB responses
151 * and can produce pcre warnings.
152 * @param string $lsub_line mailbox line from untagged LIST or LSUB response
153 * @return bool whether this is a Noselect mailbox.
156 function check_is_noselect ($lsub_line) {
157 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
161 * Detects if mailbox has noinferiors flag (can't store subfolders)
162 * @param string $lsub_line mailbox line from untagged LIST or LSUB response
163 * @return bool whether this is a Noinferiors mailbox.
166 function check_is_noinferiors ($lsub_line) {
167 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
171 * Detects mailbox's parent folder
173 * If $haystack is a full mailbox name, and $needle is the mailbox
174 * separator character, returns the second last part of the full
175 * mailbox name (i.e. the mailbox's parent mailbox)
177 * Originally stored in functions/strings.php. Since 1.2.6 stored in
178 * functions/imap_mailbox.php
179 * @param string $haystack full mailbox name
180 * @param string $needle delimiter
181 * @return string parent mailbox
183 function readMailboxParent($haystack, $needle) {
187 $parts = explode($needle, $haystack);
188 $elem = array_pop($parts);
189 while ($elem == '' && count($parts)) {
190 $elem = array_pop($parts);
192 $ret = join($needle, $parts);
198 * Check if $subbox is below the specified $parentbox
199 * @param string $subbox potential sub folder
200 * @param string $parentbox potential parent
204 function isBoxBelow( $subbox, $parentbox ) {
207 * Eliminate the obvious mismatch, where the
208 * subfolder path is shorter than that of the potential parent
210 if ( strlen($subbox) < strlen($parentbox) ) {
213 /* check for delimiter */
214 if (substr($parentbox,-1) != $delimiter) {
215 $parentbox .= $delimiter;
218 return (substr($subbox,0,strlen($parentbox)) == $parentbox);
222 * Defines special mailboxes: given a mailbox name, it checks if this is a
223 * "special" one: INBOX, Trash, Sent or Draft.
225 * Since 1.2.5 function includes special_mailbox hook.<br>
226 * Since 1.4.3 hook supports more than one plugin.
227 * @param string $box mailbox name
231 function isSpecialMailbox( $box ) {
232 $ret = ( (strtolower($box) == 'inbox') ||
233 isTrashMailbox($box) ||
isSentMailbox($box) ||
isDraftMailbox($box) );
236 $ret = boolean_hook_function('special_mailbox',$box,1);
242 * Detects if mailbox is a Trash folder or subfolder of Trash
243 * @param string $box mailbox name
244 * @return bool whether this is a Trash folder
247 function isTrashMailbox ($box) {
248 global $trash_folder, $move_to_trash;
249 return $move_to_trash && $trash_folder &&
250 ( $box == $trash_folder ||
isBoxBelow($box, $trash_folder) );
254 * Detects if mailbox is a Sent folder or subfolder of Sent
255 * @param string $box mailbox name
256 * @return bool whether this is a Sent folder
259 function isSentMailbox($box) {
260 global $sent_folder, $move_to_sent;
261 return $move_to_sent && $sent_folder &&
262 ( $box == $sent_folder ||
isBoxBelow($box, $sent_folder) );
266 * Detects if mailbox is a Drafts folder or subfolder of Drafts
267 * @param string $box mailbox name
268 * @return bool whether this is a Draft folder
271 function isDraftMailbox($box) {
272 global $draft_folder, $save_as_draft;
273 return $save_as_draft &&
274 ( $box == $draft_folder ||
isBoxBelow($box, $draft_folder) );
280 * WARNING: Select mailbox before calling this function.
282 * permanently removes all messages that have the \Deleted flag
283 * set from the selected mailbox. See EXPUNGE command chapter in
285 * @param stream $imap_stream imap connection resource
286 * @param string $mailbox mailbox name (unused since 1.1.3).
287 * @param boolean $handle_errors error handling control (displays error_box on error).
288 * @param mixed $id (since 1.3.0) integer message id or array with integer ids
289 * @return integer number of expunged messages
290 * @since 1.0 or older
292 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
295 $id = sqimap_message_list_squisher($id);
302 $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
303 $response, $message, $uid);
306 if (is_array($read)) {
307 foreach ($read as $r) {
308 if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
317 * Checks whether or not the specified mailbox exists
318 * @param stream $imap_stream imap connection resource
319 * @param string $mailbox mailbox name
321 * @since 1.0 or older
323 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
324 if (!isset($mailbox) ||
empty($mailbox)) {
327 $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
328 true, $response, $message);
329 return isset($mbx[0]);
334 * Before 1.3.0 used more arguments and returned data depended on those argumements.
335 * @param stream $imap_stream imap connection resource
336 * @param string $mailbox mailbox name
337 * @return array results of select command (on success - permanentflags, flags and rights)
338 * @since 1.0 or older
340 function sqimap_mailbox_select ($imap_stream, $mailbox) {
341 if ($mailbox == 'None') {
345 $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
346 true, $response, $message);
348 for ($i = 0, $cnt = count($read); $i < $cnt; $i++
) {
349 if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
350 $result[strtoupper($regs[1])] = $regs[2];
351 } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
352 $result[strtoupper($regs[2])] = $regs[1];
354 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
355 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
356 $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
357 } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
358 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
359 $result['FLAGS'] = explode(' ',strtolower($regs[1]));
363 if (!isset($result['PERMANENTFLAGS'])) {
364 $result['PERMANENTFLAGS'] = $result['FLAGS'];
366 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
367 $result['RIGHTS']=strtoupper($regs[1]);
376 * Mailbox is automatically subscribed.
378 * Set $type to string that does not match 'noselect' (case insensitive),
379 * if you don't want to prepend delimiter to mailbox name. Please note
380 * that 'noinferiors' might be used someday as keyword for folders
381 * that store only messages.
382 * @param stream $imap_steam imap connection resource
383 * @param string $mailbox mailbox name
384 * @param string $type folder type.
385 * @since 1.0 or older
387 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
389 if (strtolower($type) == 'noselect') {
390 $mailbox .= $delimiter;
393 $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
394 sqimap_encode_mailbox_name($mailbox),
395 true, $response, $message);
396 sqimap_subscribe ($imap_stream, $mailbox);
400 * Subscribes to an existing folder.
401 * @param stream $imap_stream imap connection resource
402 * @param string $mailbox mailbox name
403 * @param boolean $debug (since 1.5.1)
404 * @since 1.0 or older
406 function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
407 $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
408 sqimap_encode_mailbox_name($mailbox),
409 $debug, $response, $message);
413 * Unsubscribes from an existing folder
414 * @param stream $imap_stream imap connection resource
415 * @param string $mailbox mailbox name
416 * @since 1.0 or older
418 function sqimap_unsubscribe ($imap_stream, $mailbox) {
419 $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
420 sqimap_encode_mailbox_name($mailbox),
421 false, $response, $message);
425 * Deletes the given folder
426 * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
427 * @param stream $imap_stream imap connection resource
428 * @param string $mailbox mailbox name
429 * @since 1.0 or older
431 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
432 global $data_dir, $username;
433 sqimap_unsubscribe ($imap_stream, $mailbox);
434 $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
435 sqimap_encode_mailbox_name($mailbox),
436 true, $response, $message);
437 if ($response !== 'OK') {
439 sqimap_subscribe ($imap_stream, $mailbox);
441 do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
442 removePref($data_dir, $username, "thread_$mailbox");
443 removePref($data_dir, $username, "collapse_folder_$mailbox");
448 * Determines if the user is subscribed to the folder or not
449 * @param stream $imap_stream imap connection resource
450 * @param string $mailbox mailbox name
454 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
455 $boxesall = sqimap_mailbox_list ($imap_stream);
456 foreach ($boxesall as $ref) {
457 if ($ref['unformatted'] == $folder) {
466 * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
467 * @param stream $imap_stream imap connection resource
468 * @param string $old_name mailbox name
469 * @param string $new_name new mailbox name
472 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
473 if ( $old_name != $new_name ) {
474 global $delimiter, $imap_server_type, $data_dir, $username;
475 if ( substr( $old_name, -1 ) == $delimiter ) {
476 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
477 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
478 $postfix = $delimiter;
483 $boxesall = sqimap_mailbox_list_all($imap_stream);
484 $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
485 ' ' . sqimap_encode_mailbox_name($new_name);
486 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
487 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
488 $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
489 $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
490 removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
491 removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
492 sqimap_subscribe($imap_stream, $new_name.$postfix);
493 setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread);
494 setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse);
495 do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
496 $l = strlen( $old_name ) +
1;
499 foreach ($boxesall as $box) {
500 if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
501 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
502 /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */
503 if ($imap_server_type == 'cyrus') {
504 $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
505 $data = sqimap_run_command($imap_stream, $cmd, false,
506 $response, $message);
508 $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]);
509 if ( $was_subscribed ) {
510 sqimap_unsubscribe($imap_stream, $box[$p]);
512 $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]);
513 $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]);
514 removePref($data_dir, $username, 'thread_'.$box[$p]);
515 removePref($data_dir, $username, 'collapse_folder_'.$box[$p]);
516 if ( $was_subscribed ) {
517 sqimap_subscribe($imap_stream, $new_sub);
519 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread);
520 setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse);
521 do_hook_function('rename_or_delete_folder',
522 $args = array($box[$p], 'rename', $new_sub));
529 * Formats a mailbox into parts for the $boxesall array
533 * <li>raw - Raw LIST/LSUB response from the IMAP server
534 * <li>formatted - nicely formatted folder name
535 * <li>unformatted - unformatted, but with delimiter at end removed
536 * <li>unformatted-dm - folder name as it appears in raw response
537 * <li>unformatted-disp - unformatted without $folder_prefix
538 * <li>id - TODO: document me
539 * <li>flags - TODO: document me
541 * Before 1.2.0 used third argument for delimiter.
545 * @since 1.0 or older
546 * @todo document id and flags keys in boxes array and function arguments.
548 function sqimap_mailbox_parse ($line, $line_lsub) {
549 global $folder_prefix, $delimiter;
551 /* Process each folder line */
552 for ($g = 0, $cnt = count($line); $g < $cnt; ++
$g) {
553 /* Store the raw IMAP reply */
554 if (isset($line[$g])) {
555 $boxesall[$g]['raw'] = $line[$g];
557 $boxesall[$g]['raw'] = '';
560 /* Count number of delimiters ($delimiter) in folder name */
561 $mailbox = /*trim(*/$line_lsub[$g]/*)*/;
562 $dm_count = substr_count($mailbox, $delimiter);
563 if (substr($mailbox, -1) == $delimiter) {
564 /* If name ends in delimiter, decrement count by one */
568 /* Format folder name, but only if it's a INBOX.* or has a parent. */
569 $boxesallbyname[$mailbox] = $g;
570 $parentfolder = readMailboxParent($mailbox, $delimiter);
571 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
572 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
573 (isset($boxesallbyname[$parentfolder]) &&
574 (strlen($parentfolder) > 0) ) ) {
575 $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
577 $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
579 $boxesall[$g]['formatted'] = '';
581 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
583 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
586 $boxesall[$g]['unformatted-dm'] = $mailbox;
587 if (substr($mailbox, -1) == $delimiter) {
588 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
590 $boxesall[$g]['unformatted'] = $mailbox;
591 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
592 $mailbox = substr($mailbox, strlen($folder_prefix));
594 $boxesall[$g]['unformatted-disp'] = $mailbox;
595 $boxesall[$g]['id'] = $g;
597 $boxesall[$g]['flags'] = array();
598 if (isset($line[$g])) {
599 ereg("\(([^)]*)\)",$line[$g],$regs);
600 // FIXME Flags do contain the \ character. \NoSelect \NoInferiors
601 // and $MDNSent <= last one doesn't have the \
602 // It's better to follow RFC3501 instead of using our own naming.
603 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
605 $boxesall[$g]['flags'] = explode(' ', $flags);
613 * Returns list of options (to be echoed into select statement
614 * based on available mailboxes and separators
615 * Caller should surround options with <select ...> </select> and
617 * @param stream $imap_stream imap connection resource to query for mailboxes
618 * @param array $show_selected array containing list of mailboxes to pre-select (0 if none)
619 * @param array $folder_skip array of folders to keep out of option list (compared in lower)
620 * @param $boxes list of already fetched boxes (for places like folder panel, where
621 * you know these options will be shown 3 times in a row.. (most often unset).
622 * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes.
623 * 'noselect' by default to remove unselectable mailboxes.
624 * 'noinferiors' used to filter out folders that can not contain subfolders.
625 * NULL to avoid flag check entirely.
626 * NOTE: noselect and noiferiors are used internally. The IMAP representation is
627 * \NoSelect and \NoInferiors
628 * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name.
629 * @return string html formated mailbox selection options
632 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
633 $flag = 'noselect', $use_long_format = false ) {
634 global $username, $data_dir;
636 if ( $use_long_format ) {
637 $shorten_box_names = 0;
639 $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF
);
643 $boxes = sqimap_mailbox_list($imap_stream);
646 foreach ($boxes as $boxes_part) {
647 if ($flag == NULL ||
(is_array($boxes_part['flags'])
648 && !in_array($flag, $boxes_part['flags']))) {
649 $box = $boxes_part['unformatted'];
651 if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
654 $lowerbox = strtolower($box);
655 // mailboxes are casesensitive => inbox.sent != inbox.Sent
656 // nevermind, to many dependencies this should be fixed!
658 if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
661 switch ($shorten_box_names)
663 case 2: /* delimited, style = 2 */
664 $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted']));
666 case 1: /* indent, style = 1 */
667 $box2 = str_replace('&nbsp;&nbsp;', ' ', htmlspecialchars($boxes_part['formatted']));
669 default: /* default, long names, style = 0 */
670 $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
674 if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
675 $mbox_options .= '<option value="' . htmlspecialchars($box) .'" selected="selected">'.$box2.'</option>' . "\n";
677 $mbox_options .= '<option value="' . htmlspecialchars($box) .'">'.$box2.'</option>' . "\n";
681 return $mbox_options;
685 * Returns sorted mailbox lists in several different ways.
686 * See comment on sqimap_mailbox_parse() for info about the returned array.
687 * @param resource $imap_stream imap connection resource
688 * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
689 * @return array list of mailboxes
690 * @since 1.0 or older
692 function sqimap_mailbox_list($imap_stream, $force=false) {
693 if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION
) ||
$force) {
694 global $data_dir, $username, $list_special_folders_first,
695 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
696 $move_to_trash, $move_to_sent, $save_as_draft,
697 $delimiter, $noselect_fix_enable, $imap_server_type,
698 $show_only_subscribed_folders;
699 $inbox_subscribed = false;
700 $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
702 require_once(SM_PATH
. 'include/load_prefs.php');
704 if (!$show_only_subscribed_folders) {
706 } elseif ($listsubscribed) {
707 $lsub = 'LIST (SUBSCRIBED)';
712 if ($noselect_fix_enable) {
713 $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
715 $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
718 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
719 true, $response, $message);
720 $lsub_ary = compact_mailboxes_response($lsub_ary);
722 $sorted_lsub_ary = array();
723 for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++
) {
725 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
726 $sorted_lsub_ary[] = $temp_mailbox_name;
727 if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
728 $inbox_subscribed = true;
732 /* natural sort mailboxes */
733 if (isset($sorted_lsub_ary)) {
734 usort($sorted_lsub_ary, 'strnatcasecmp');
737 * The LSUB response doesn't provide us information about \Noselect
738 * mail boxes. The LIST response does, that's why we need to do a LIST
739 * call to retrieve the flags for the mailbox
740 * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response.
741 * in other words, we cannot rely on it.
743 $sorted_list_ary = array();
744 // if (!$listsubscribed) {
745 for ($i=0; $i < count($sorted_lsub_ary); $i++
) {
746 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
747 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
750 $mbx = $sorted_lsub_ary[$i];
753 $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx),
754 true, $response, $message);
756 $read = compact_mailboxes_response($read);
758 if (isset($read[0])) {
759 $sorted_list_ary[$i] = $read[0];
761 $sorted_list_ary[$i] = '';
766 * Just in case they're not subscribed to their inbox,
767 * we'll get it for them anyway
769 if (!$inbox_subscribed) {
770 $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"',
771 true, $response, $message);
772 $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary));
773 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
776 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
778 /* Now, lets sort for special folders */
779 $boxesnew = $used = array();
782 $cnt = count($boxesall);
783 $used = array_pad($used,$cnt,false);
784 for($k = 0; $k < $cnt; ++
$k) {
785 if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
786 $boxesnew[] = $boxesall[$k];
791 /* List special folders and their subfolders, if requested. */
792 if ($list_special_folders_first) {
793 for($k = 0; $k < $cnt; ++
$k) {
794 if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
795 $boxesnew[] = $boxesall[$k];
801 /* Find INBOX's children */
802 for($k = 0; $k < $cnt; ++
$k) {
803 if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') &&
804 strtolower($boxesall[$k]['unformatted']) != 'inbox') {
805 $boxesnew[] = $boxesall[$k];
810 /* Rest of the folders */
811 for($k = 0; $k < $cnt; $k++
) {
813 $boxesnew[] = $boxesall[$k];
816 sqsession_register($boxesnew,'boxesnew');
822 * Returns a list of all folders, subscribed or not
823 * @param stream $imap_stream imap connection resource
824 * @return array see sqimap_mailbox_parse()
825 * @since 1.0 or older
827 function sqimap_mailbox_list_all($imap_stream) {
828 global $list_special_folders_first, $folder_prefix, $delimiter;
830 $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false);
831 $read_ary = compact_mailboxes_response($read_ary);
834 $fld_pre_length = strlen($folder_prefix);
835 for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++
) {
836 /* Store the raw IMAP reply */
837 $boxes[$g]['raw'] = $read_ary[$i];
839 /* Count number of delimiters ($delimiter) in folder name */
840 $mailbox = find_mailbox_name($read_ary[$i]);
841 $dm_count = substr_count($mailbox, $delimiter);
842 if (substr($mailbox, -1) == $delimiter) {
843 /* If name ends in delimiter - decrement count by one */
847 /* Format folder name, but only if it's a INBOX.* or has a parent. */
848 $boxesallbyname[$mailbox] = $g;
849 $parentfolder = readMailboxParent($mailbox, $delimiter);
850 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
851 (ereg('^'.$folder_prefix, $mailbox)) ||
852 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
854 $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
856 $boxes[$g]['formatted'] = '';
858 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
860 $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
863 $boxes[$g]['unformatted-dm'] = $mailbox;
864 if (substr($mailbox, -1) == $delimiter) {
865 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
867 $boxes[$g]['unformatted'] = $mailbox;
868 $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
870 $boxes[$g]['id'] = $g;
872 /* Now lets get the flags for this mailbox */
873 $read_mlbx = $read_ary[$i];
874 $flags = substr($read_mlbx, strpos($read_mlbx, '(')+
1);
875 $flags = substr($flags, 0, strpos($flags, ')'));
876 $flags = str_replace('\\', '', $flags);
877 $flags = trim(strtolower($flags));
879 $boxes[$g]['flags'] = explode(' ', $flags);
881 $boxes[$g]['flags'] = array();
885 if(is_array($boxes)) {
893 * Fills mailbox object
895 * Some code fragments are present in 1.3.0 - 1.4.4.
896 * @param stream $imap_stream imap connection resource
897 * @return object see mailboxes class.
900 function sqimap_mailbox_tree($imap_stream) {
901 global $default_folder_prefix, $data_dir, $username, $list_special_folders_first,
902 $folder_prefix, $delimiter, $trash_folder, $move_to_trash,
903 $imap_server_type, $show_only_subscribed_folders;
905 // TODO: implement mailbox tree caching. maybe store object in session?
908 $noinferiors = false;
910 require_once(SM_PATH
. 'include/load_prefs.php');
912 if ($show_only_subscribed_folders) {
919 $lsub_ary = sqimap_run_command ($imap_stream, "$lsub_cmd \"$folder_prefix\" \"*\"",
920 true, $response, $message);
921 $lsub_ary = compact_mailboxes_response($lsub_ary);
923 /* Check to see if we have an INBOX */
926 for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++
) {
927 if (preg_match("/^\*\s+$lsub_cmd.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
928 $lsub_ary[$i] = strtoupper($lsub_ary[$i]);
929 // in case of an unsubscribed inbox an imap server can
930 // return the inbox in the lsub results with a \NoSelect
932 if (!preg_match("/\*\s+$lsub_cmd\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) {
935 // remove the result and request it again with a list
936 // response at a later stage.
937 unset($lsub_ary[$i]);
938 // re-index the array otherwise the addition of the LIST
939 // response will fail in PHP 4.1.2 and probably other older versions
940 $lsub_ary = array_values($lsub_ary);
946 if ($has_inbox == false) {
947 // do a list request for inbox because we should always show
948 // inbox even if the user isn't subscribed to it.
949 $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"',
950 true, $response, $message);
951 $inbox_ary = compact_mailboxes_response($inbox_ary);
952 if (count($inbox_ary)) {
953 $lsub_ary[] = $inbox_ary[0];
958 * Section about removing the last element was removed
959 * We don't return "* OK" anymore from sqimap_read_data
962 $sorted_lsub_ary = array();
963 $cnt = count($lsub_ary);
964 for ($i = 0; $i < $cnt; $i++
) {
965 $mbx = find_mailbox_name($lsub_ary[$i]);
967 // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting
968 if ($imap_server_type != "uw") {
969 $noselect = check_is_noselect($lsub_ary[$i]);
970 $noinferiors = check_is_noinferiors($lsub_ary[$i]);
972 if (substr($mbx, -1) == $delimiter) {
973 $mbx = substr($mbx, 0, strlen($mbx) - 1);
975 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
977 // FIX ME this requires a config setting inside conf.pl instead of checking on server type
978 if ($imap_server_type == "uw") {
981 // prepare an array with queries
982 foreach ($sorted_lsub_ary as $aMbx) {
983 $mbx = stripslashes($aMbx['mbx']);
984 sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false);
987 $sorted_lsub_ary = array();
988 // execute all the queries at once
989 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
990 foreach($aTag as $tag => $mbx) {
991 if ($aServerResponse[$tag] == 'OK') {
992 $sResponse = implode('', $aResponse[$tag]);
993 $noselect = check_is_noselect($sResponse);
994 $noinferiors = check_is_noinferiors($sResponse);
995 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
998 $cnt = count($sorted_lsub_ary);
1000 $sorted_lsub_ary = array_values($sorted_lsub_ary);
1001 usort($sorted_lsub_ary, 'mbxSort');
1002 $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
1007 * Callback function used for sorting mailboxes in sqimap_mailbox_tree
1010 * @return integer see php strnatcasecmp()
1013 function mbxSort($a, $b) {
1014 return strnatcasecmp($a['mbx'], $b['mbx']);
1018 * Fills mailbox object
1020 * Some code fragments are present in 1.3.0 - 1.4.4.
1021 * @param array $mbx_ary
1023 * @param stream $imap_stream imap connection resource
1024 * @return object see mailboxes class
1027 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
1028 global $data_dir, $username, $list_special_folders_first,
1029 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
1030 $move_to_trash, $move_to_sent, $save_as_draft,
1031 $delimiter, $imap_server_type;
1033 // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
1035 /* create virtual root node */
1036 $mailboxes= new mailboxes();
1037 $mailboxes->is_root
= true;
1042 if (isset($folder_prefix) && ($folder_prefix != '')) {
1043 $start = substr_count($folder_prefix,$delimiter);
1044 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
1045 $mailboxes->mailboxname_full
= substr($folder_prefix,0, (strlen($folder_prefix)-1));
1047 $mailboxes->mailboxname_full
= $folder_prefix;
1050 $mailboxes->mailboxname_sub
= $mailboxes->mailboxname_full
;
1055 $cnt = count($mbx_ary);
1056 for ($i=0; $i < $cnt; $i++
) {
1057 if ($mbx_ary[$i]['mbx'] !='' ) {
1058 $mbx = new mailboxes();
1059 $mailbox = $mbx_ary[$i]['mbx'];
1062 * Set the is_special flag if it concerned a special mailbox.
1063 * Used for displaying the special folders on top in the mailbox
1064 * tree displaying code.
1066 $mbx->is_special |
= ($mbx->is_inbox
= (strtoupper($mailbox) == 'INBOX'));
1067 $mbx->is_special |
= ($mbx->is_trash
= isTrashMailbox($mailbox));
1068 $mbx->is_special |
= ($mbx->is_sent
= isSentMailbox($mailbox));
1069 $mbx->is_special |
= ($mbx->is_draft
= isDraftMailbox($mailbox));
1071 if (!$mbx->is_special
)
1072 $mbx->is_special
= boolean_hook_function('special_mailbox', $mailbox, 1);
1074 if (isset($mbx_ary[$i]['unseen'])) {
1075 $mbx->unseen
= $mbx_ary[$i]['unseen'];
1077 if (isset($mbx_ary[$i]['nummessages'])) {
1078 $mbx->total
= $mbx_ary[$i]['nummessages'];
1081 $mbx->is_noselect
= $mbx_ary[$i]['noselect'];
1082 $mbx->is_noinferiors
= $mbx_ary[$i]['noinferiors'];
1084 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
1086 $mbx->mailboxname_sub
= substr($mbx_ary[$i]['mbx'],$r_del_pos+
1);
1087 } else { /* mailbox is root folder */
1088 $mbx->mailboxname_sub
= $mbx_ary[$i]['mbx'];
1090 $mbx->mailboxname_full
= $mbx_ary[$i]['mbx'];
1092 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
1095 sqimap_utf7_decode_mbx_tree($mailboxes);
1096 sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
1101 * @param object $mbx_tree
1104 function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
1105 if (strtoupper($mbx_tree->mailboxname_full
) == 'INBOX')
1106 $mbx_tree->mailboxname_sub
= _("INBOX");
1108 $mbx_tree->mailboxname_sub
= imap_utf7_decode_local($mbx_tree->mailboxname_sub
);
1109 if ($mbx_tree->mbxs
) {
1110 $iCnt = count($mbx_tree->mbxs
);
1111 for ($i=0;$i<$iCnt;++
$i) {
1112 $mbxs_tree->mbxs
[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs
[$i]);
1118 * @param object $mbx_tree
1119 * @param array $aMbxs
1122 function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
1124 $aMbxs[] =& $mbx_tree;
1125 if ($mbx_tree->mbxs
) {
1126 $iCnt = count($mbx_tree->mbxs
);
1127 for ($i=0;$i<$iCnt;++
$i) {
1128 sqimap_tree_to_ref_array($mbx_tree->mbxs
[$i],$aMbxs);
1134 * @param stream $imap_stream imap connection resource
1135 * @param object $mbx_tree
1136 * @since since 1.5.0
1138 function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
1139 global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
1140 $aMbxs = $aQuery = array();
1141 sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
1142 // remove the root node
1143 array_shift($aMbxs);
1145 if($unseen_notify == 3) {
1146 $cnt = count($aMbxs);
1147 for($i=0;$i<$cnt;++
$i) {
1148 $oMbx =& $aMbxs[$i];
1149 if (!$oMbx->is_noselect
) {
1150 $mbx = $oMbx->mailboxname_full
;
1151 if ($unseen_type == 2 ||
1152 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1153 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)';
1155 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)';
1157 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
1159 $oMbx->unseen
= $oMbx->total
= false;
1163 $aMbxs[$i] =& $oMbx;
1165 // execute all the queries at once
1166 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
1167 $cnt = count($aMbxs);
1168 for($i=0;$i<$cnt;++
$i) {
1169 $oMbx =& $aMbxs[$i];
1171 if ($tag && $aServerResponse[$tag] == 'OK') {
1172 $sResponse = implode('', $aResponse[$tag]);
1173 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
1174 $oMbx->unseen
= $regs[1];
1176 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
1177 $oMbx->total
= $regs[1];
1182 } else if ($unseen_notify == 2) { // INBOX only
1183 $cnt = count($aMbxs);
1184 for($i=0;$i<$cnt;++
$i) {
1185 $oMbx =& $aMbxs[$i];
1186 if (strtoupper($oMbx->mailboxname_full
) == 'INBOX' ||
1187 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1188 if ($unseen_type == 2 ||
1189 ($oMbx->mailboxname_full
== $trash_folder && $move_to_trash)) {
1190 $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full
);
1191 $oMbx->unseen
= $aStatus['UNSEEN'];
1192 $oMbx->total
= $aStatus['MESSAGES'];
1194 $oMbx->unseen
= sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full
);
1196 $aMbxs[$i] =& $oMbx;
1197 if (!$move_to_trash && $trash_folder) {
1200 // trash comes after INBOX
1201 if ($oMbx->mailboxname_full
== $trash_folder) {