6 * This implements all functions that manipulate mailboxes
8 * @copyright © 1999-2007 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
16 require_once(SM_PATH
. 'functions/imap_utf7_local.php');
22 * FIXME. This class should be extracted and placed in a separate file that
23 * can be included before we start the session. That makes caching of the tree
24 * possible. On a refresh mailboxes from left_main.php the only function that
25 * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
26 * / rename / delete / new we have to create methods for adding/changing the
27 * mailbox in the mbx_tree without the need for a refresh.
29 * Some code fragments are present in 1.3.0 - 1.4.4.
30 * @package squirrelmail
35 var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
36 $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
37 $is_trash = false, $is_draft = false, $mbxs = array(),
38 $unseen = false, $total = false, $recent = false;
40 function addMbx($mbx, $delimiter, $start, $specialfirst) {
41 $ary = explode($delimiter, $mbx->mailboxname_full
);
43 for ($i = $start, $c = count($ary)-1; $i < $c; $i++
) {
44 $mbx_childs =& $mbx_parent->mbxs
;
47 foreach ($mbx_childs as $key => $parent) {
48 if ($parent->mailboxname_sub
== $ary[$i]) {
49 $mbx_parent =& $mbx_parent->mbxs
[$key];
56 $no_select_mbx = new mailboxes();
57 if (isset($mbx_parent->mailboxname_full
) && $mbx_parent->mailboxname_full
!= '') {
58 $no_select_mbx->mailboxname_full
= $mbx_parent->mailboxname_full
.$delimiter.$ary[$i];
60 $no_select_mbx->mailboxname_full
= $ary[$i];
62 $no_select_mbx->mailboxname_sub
= $ary[$i];
63 $no_select_mbx->is_noselect
= true;
64 $mbx_parent->mbxs
[] = $no_select_mbx;
68 $mbx_parent->mbxs
[] = $mbx;
69 if ($mbx->is_special
&& $specialfirst) {
70 usort($mbx_parent->mbxs
, 'sortSpecialMbx');
76 * array callback used for sorting in mailboxes class
79 * @return integer see php strnatcasecmp()
82 function sortSpecialMbx($a, $b) {
84 $acmp = '0'. $a->mailboxname_full
;
85 } else if ($a->is_special
) {
86 $acmp = '1'. $a->mailboxname_full
;
88 $acmp = '2' . $a->mailboxname_full
;
91 $bcmp = '0'. $b->mailboxname_full
;
92 }else if ($b->is_special
) {
93 $bcmp = '1' . $b->mailboxname_full
;
95 $bcmp = '2' . $b->mailboxname_full
;
97 return strnatcasecmp($acmp, $bcmp);
105 function compact_mailboxes_response($ary) {
107 * Workaround for mailboxes returned as literal
108 * FIXME : Doesn't work if the mailbox name is multiple lines
109 * (larger then fgets buffer)
111 for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++
) {
112 if (isset($ary[$i +
1]) && substr($ary[$i], -3) == "}\r\n") {
113 if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
115 $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+
1])) . '"' . $regs[2];
116 array_splice($ary, $i+
1, 2);
120 /* remove duplicates and ensure array is contiguous */
121 return array_values(array_unique($ary));
125 * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
126 * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
127 * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
129 * Originally stored in functions/strings.php. Since 1.2.6 stored in
130 * functions/imap_mailbox.php
131 * @param string $line imap LIST/LSUB response line
132 * @return string mailbox name
134 function find_mailbox_name($line) {
135 if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
136 if (substr($regs[1], 0, 1) == '"')
137 return stripslashes(substr($regs[1], 1, -1));
144 * Detects if mailbox has noselect flag (can't store messages)
145 * In versions older than 1.4.5 function checks only LSUB responses
146 * and can produce pcre warnings.
147 * @param string $lsub_line mailbox line from untagged LIST or LSUB response
148 * @return bool whether this is a Noselect mailbox.
151 function check_is_noselect ($lsub_line) {
152 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
156 * Detects if mailbox has noinferiors flag (can't store subfolders)
157 * @param string $lsub_line mailbox line from untagged LIST or LSUB response
158 * @return bool whether this is a Noinferiors mailbox.
161 function check_is_noinferiors ($lsub_line) {
162 return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
166 * Detects mailbox's parent folder
168 * If $haystack is a full mailbox name, and $needle is the mailbox
169 * separator character, returns the second last part of the full
170 * mailbox name (i.e. the mailbox's parent mailbox)
172 * Originally stored in functions/strings.php. Since 1.2.6 stored in
173 * functions/imap_mailbox.php
174 * @param string $haystack full mailbox name
175 * @param string $needle delimiter
176 * @return string parent mailbox
178 function readMailboxParent($haystack, $needle) {
182 $parts = explode($needle, $haystack);
183 $elem = array_pop($parts);
184 while ($elem == '' && count($parts)) {
185 $elem = array_pop($parts);
187 $ret = join($needle, $parts);
193 * Check if $subbox is below the specified $parentbox
194 * @param string $subbox potential sub folder
195 * @param string $parentbox potential parent
199 function isBoxBelow( $subbox, $parentbox ) {
202 * Eliminate the obvious mismatch, where the
203 * subfolder path is shorter than that of the potential parent
205 if ( strlen($subbox) < strlen($parentbox) ) {
208 /* check for delimiter */
209 if (substr($parentbox,-1) != $delimiter) {
210 $parentbox .= $delimiter;
213 return (substr($subbox,0,strlen($parentbox)) == $parentbox);
217 * Defines special mailboxes: given a mailbox name, it checks if this is a
218 * "special" one: INBOX, Trash, Sent or Draft.
220 * Since 1.2.5 function includes special_mailbox hook.<br>
221 * Since 1.4.3 hook supports more than one plugin.
222 * @param string $box mailbox name
223 * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
224 * folders are special. if false, subfolders are not special mailboxes
225 * unless they are tagged as special in 'special_mailbox' hook.
229 function isSpecialMailbox($box,$include_subs=true) {
230 $ret = ( (strtolower($box) == 'inbox') ||
231 isTrashMailbox($box,$include_subs) ||
232 isSentMailbox($box,$include_subs) ||
233 isDraftMailbox($box,$include_subs) );
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 * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
245 * folders are special. if false, subfolders are not special mailboxes.
246 * @return bool whether this is a Trash folder
249 function isTrashMailbox ($box,$include_subs=true) {
250 global $trash_folder, $move_to_trash;
251 return $move_to_trash && $trash_folder &&
252 ( $box == $trash_folder ||
253 ($include_subs && isBoxBelow($box, $trash_folder)) );
257 * Detects if mailbox is a Sent folder or subfolder of Sent
258 * @param string $box mailbox name
259 * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
260 * folders are special. if false, subfolders are not special mailboxes.
261 * @return bool whether this is a Sent folder
264 function isSentMailbox($box,$include_subs=true) {
265 global $sent_folder, $move_to_sent;
266 return $move_to_sent && $sent_folder &&
267 ( $box == $sent_folder ||
268 ($include_subs && isBoxBelow($box, $sent_folder)) );
272 * Detects if mailbox is a Drafts folder or subfolder of Drafts
273 * @param string $box mailbox name
274 * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
275 * folders are special. if false, subfolders are not special mailboxes.
276 * @return bool whether this is a Draft folder
279 function isDraftMailbox($box,$include_subs=true) {
280 global $draft_folder, $save_as_draft;
281 return $save_as_draft &&
282 ( $box == $draft_folder ||
283 ($include_subs && isBoxBelow($box, $draft_folder)) );
287 * Is the given folder "sent-like" in nature?
289 * The most obvious use of this is to know what folders you usually
290 * want to show the To field instead of the From field on the mailbox list
292 * This function returns TRUE if the given folder is the sent
293 * folder (or any of its subfolders) or if it is the draft
294 * folder (or any of its subfolders)
296 * @param string $mailbox
298 * @return boolean See explanation above
301 function handleAsSent($mailbox) {
302 global $handleAsSent_result;
304 /* First check if this is the sent or draft folder. */
305 $handleAsSent_result = isSentMailbox($mailbox) ||
isDraftMailbox($mailbox);
307 /* Then check the result of the handleAsSent hook. */
308 do_hook('check_handleAsSent_result', $mailbox);
310 /* And return the result. */
311 return $handleAsSent_result;
317 * WARNING: Select mailbox before calling this function.
319 * permanently removes all messages that have the \Deleted flag
320 * set from the selected mailbox. See EXPUNGE command chapter in
322 * @param stream $imap_stream imap connection resource
323 * @param string $mailbox mailbox name (unused since 1.1.3).
324 * @param boolean $handle_errors error handling control (displays error_box on error).
325 * @param mixed $id (since 1.3.0) integer message id or array with integer ids
326 * @return integer number of expunged messages
327 * @since 1.0 or older
329 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
332 $id = sqimap_message_list_squisher($id);
339 $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
340 $response, $message, $uid);
343 if (is_array($read)) {
344 foreach ($read as $r) {
345 if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
354 * Checks whether or not the specified mailbox exists
356 * @param stream $imap_stream imap connection resource
357 * @param string $mailbox mailbox name
358 * @param array $mailboxlist (since 1.5.1) optional array of mailboxes from
359 * sqimap_get_mailboxes() (to avoid having to talk to imap server)
361 * @since 1.0 or older
363 function sqimap_mailbox_exists ($imap_stream, $mailbox, $mailboxlist=null) {
364 if (!isset($mailbox) ||
empty($mailbox)) {
368 if (is_array($mailboxlist)) {
369 // use previously retrieved mailbox list
370 foreach ($mailboxlist as $mbox) {
371 if ($mbox['unformatted-dm'] == $mailbox) { return true; }
376 $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
377 true, $response, $message);
378 return isset($mbx[0]);
384 * Before 1.3.0 used more arguments and returned data depended on those arguments.
385 * @param stream $imap_stream imap connection resource
386 * @param string $mailbox mailbox name
387 * @return array results of select command (on success - permanentflags, flags and rights)
388 * @since 1.0 or older
390 function sqimap_mailbox_select ($imap_stream, $mailbox) {
391 if (empty($mailbox)) {
395 // cleanup $mailbox in order to prevent IMAP injection attacks
396 $mailbox = str_replace(array("\r","\n"), array("",""),$mailbox);
399 * Default UW IMAP server configuration allows to access other files
400 * on server. $imap_server_type is not checked because interface can
401 * be used with 'other' or any other server type setting. $mailbox
402 * variable can be modified in any script that uses variable from GET
403 * or POST. This code blocks all standard SquirrelMail IMAP API requests
404 * that use mailbox with full path (/etc/passwd) or with ../ characters
405 * in path (../../etc/passwd)
407 if (strstr($mailbox, '../') ||
substr($mailbox, 0, 1) == '/') {
409 error_box(sprintf(_("Invalid mailbox name: %s"),htmlspecialchars($mailbox)));
410 sqimap_logout($imap_stream);
411 $oTemplate->display('footer.tpl');
415 $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
416 true, $response, $message);
418 for ($i = 0, $cnt = count($read); $i < $cnt; $i++
) {
419 if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
420 $result[strtoupper($regs[1])] = $regs[2];
421 } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
422 $result[strtoupper($regs[2])] = $regs[1];
424 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
425 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
426 $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
427 } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
428 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
429 $result['FLAGS'] = explode(' ',strtolower($regs[1]));
433 if (!isset($result['PERMANENTFLAGS'])) {
434 $result['PERMANENTFLAGS'] = $result['FLAGS'];
436 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
437 $result['RIGHTS']=strtoupper($regs[1]);
446 * Mailbox is automatically subscribed.
448 * Set $type to string that does not match 'noselect' (case insensitive),
449 * if you don't want to prepend delimiter to mailbox name. Please note
450 * that 'noinferiors' might be used someday as keyword for folders
451 * that store only messages.
452 * @param stream $imap_steam imap connection resource
453 * @param string $mailbox mailbox name
454 * @param string $type folder type.
455 * @since 1.0 or older
457 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
459 if (strtolower($type) == 'noselect') {
460 $create_mailbox = $mailbox . $delimiter;
462 $create_mailbox = $mailbox;
465 $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
466 sqimap_encode_mailbox_name($create_mailbox),
467 true, $response, $message);
468 sqimap_subscribe ($imap_stream, $mailbox);
472 * Subscribes to an existing folder.
473 * @param stream $imap_stream imap connection resource
474 * @param string $mailbox mailbox name
475 * @param boolean $debug (since 1.5.1)
476 * @since 1.0 or older
478 function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
479 $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
480 sqimap_encode_mailbox_name($mailbox),
481 $debug, $response, $message);
485 * Unsubscribes from an existing folder
486 * @param stream $imap_stream imap connection resource
487 * @param string $mailbox mailbox name
488 * @since 1.0 or older
490 function sqimap_unsubscribe ($imap_stream, $mailbox) {
491 $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
492 sqimap_encode_mailbox_name($mailbox),
493 false, $response, $message);
497 * Deletes the given folder
498 * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
499 * @param stream $imap_stream imap connection resource
500 * @param string $mailbox mailbox name
501 * @since 1.0 or older
503 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
504 global $data_dir, $username;
505 sqimap_unsubscribe ($imap_stream, $mailbox);
507 if (sqimap_mailbox_exists($imap_stream, $mailbox)) {
509 $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
510 sqimap_encode_mailbox_name($mailbox),
511 true, $response, $message);
512 if ($response !== 'OK') {
514 sqimap_subscribe ($imap_stream, $mailbox);
516 $temp = array(&$mailbox, 'delete', '');
517 do_hook('rename_or_delete_folder', $temp);
518 removePref($data_dir, $username, "thread_$mailbox");
519 removePref($data_dir, $username, "collapse_folder_$mailbox");
525 * Determines if the user is subscribed to the folder or not
526 * @param stream $imap_stream imap connection resource
527 * @param string $mailbox mailbox name
531 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
532 $boxesall = sqimap_mailbox_list ($imap_stream);
533 foreach ($boxesall as $ref) {
534 if ($ref['unformatted'] == $folder) {
543 * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
544 * @param stream $imap_stream imap connection resource
545 * @param string $old_name mailbox name
546 * @param string $new_name new mailbox name
549 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
550 if ( $old_name != $new_name ) {
551 global $delimiter, $imap_server_type, $data_dir, $username;
552 if ( substr( $old_name, -1 ) == $delimiter ) {
553 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
554 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
555 $postfix = $delimiter;
560 $boxesall = sqimap_mailbox_list_all($imap_stream);
561 $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
562 ' ' . sqimap_encode_mailbox_name($new_name);
563 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
564 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
565 $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
566 $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
567 removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
568 removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
569 sqimap_subscribe($imap_stream, $new_name.$postfix);
570 setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread);
571 setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse);
572 $temp = array(&$old_name, 'rename', &$new_name);
573 do_hook('rename_or_delete_folder', $temp);
574 $l = strlen( $old_name ) +
1;
577 foreach ($boxesall as $box) {
578 if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
579 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
580 /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */
581 if ($imap_server_type == 'cyrus') {
582 $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
583 $data = sqimap_run_command($imap_stream, $cmd, false,
584 $response, $message);
586 $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]);
587 if ( $was_subscribed ) {
588 sqimap_unsubscribe($imap_stream, $box[$p]);
590 $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]);
591 $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]);
592 removePref($data_dir, $username, 'thread_'.$box[$p]);
593 removePref($data_dir, $username, 'collapse_folder_'.$box[$p]);
594 if ( $was_subscribed ) {
595 sqimap_subscribe($imap_stream, $new_sub);
597 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread);
598 setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse);
599 $temp = array(&$box[$p], 'rename', &$new_sub);
600 do_hook('rename_or_delete_folder', $temp);
607 * Formats a mailbox into parts for the $boxesall array
611 * <li>raw - Raw LIST/LSUB response from the IMAP server
612 * <li>formatted - nicely formatted folder name
613 * <li>unformatted - unformatted, but with delimiter at end removed
614 * <li>unformatted-dm - folder name as it appears in raw response
615 * <li>unformatted-disp - unformatted without $folder_prefix
616 * <li>id - TODO: document me
617 * <li>flags - TODO: document me
619 * Before 1.2.0 used third argument for delimiter.
621 * Before 1.5.1 used second argument for lsub line. Argument was removed in order to use
622 * find_mailbox_name() on the raw input. Since 1.5.1 includes RFC3501 names in flags
623 * array (for example, "\NoSelect" in addition to "noselect")
626 * @since 1.0 or older
627 * @todo document id and flags keys in boxes array and function arguments.
629 function sqimap_mailbox_parse ($line) {
630 global $folder_prefix, $delimiter;
632 /* Process each folder line */
633 for ($g = 0, $cnt = count($line); $g < $cnt; ++
$g) {
634 /* Store the raw IMAP reply */
635 if (isset($line[$g])) {
636 $boxesall[$g]['raw'] = $line[$g];
638 $boxesall[$g]['raw'] = '';
641 /* Count number of delimiters ($delimiter) in folder name */
642 $mailbox = find_mailbox_name($line[$g]);
643 $dm_count = substr_count($mailbox, $delimiter);
644 if (substr($mailbox, -1) == $delimiter) {
645 /* If name ends in delimiter, decrement count by one */
649 /* Format folder name, but only if it's a INBOX.* or has a parent. */
650 $boxesallbyname[$mailbox] = $g;
651 $parentfolder = readMailboxParent($mailbox, $delimiter);
652 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
653 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
654 (isset($boxesallbyname[$parentfolder]) &&
655 (strlen($parentfolder) > 0) ) ) {
656 $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
658 $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
660 $boxesall[$g]['formatted'] = '';
662 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
664 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
667 $boxesall[$g]['unformatted-dm'] = $mailbox;
668 if (substr($mailbox, -1) == $delimiter) {
669 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
671 $boxesall[$g]['unformatted'] = $mailbox;
672 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
673 $mailbox = substr($mailbox, strlen($folder_prefix));
675 $boxesall[$g]['unformatted-disp'] = $mailbox;
676 $boxesall[$g]['id'] = $g;
678 $boxesall[$g]['flags'] = array();
679 if (isset($line[$g])) {
680 ereg("\(([^)]*)\)",$line[$g],$regs);
682 * Since 1.5.1 flags are stored with RFC3501 naming
683 * and also the old way for backwards compatibility
684 * so for example "\NoSelect" and "noselect"
686 $flags = trim($regs[1]);
688 $flagsarr = explode(' ',$flags);
689 $flagsarrnew=$flagsarr;
691 foreach ($flagsarr as $flag) {
692 $flagsarrnew[]=strtolower(str_replace('\\', '',$flag));
694 $boxesall[$g]['flags']=$flagsarrnew;
702 * Returns an array of mailboxes available. Separated from sqimap_mailbox_option_list()
703 * below for template development.
705 * @author Steve Brown
708 function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0,
709 $flag = 'noselect', $use_long_format = false ) {
710 global $username, $data_dir, $translate_special_folders, $sent_folder,
711 $trash_folder, $draft_folder;
713 $delimiter = sqimap_get_delimiter($imap_stream);
716 if ( $use_long_format ) {
717 $shorten_box_names = 0;
719 $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED
);
723 $boxes = sqimap_mailbox_list($imap_stream);
727 foreach ($boxes as $boxes_part) {
728 if ($flag == NULL ||
(is_array($boxes_part['flags'])
729 && !in_array($flag, $boxes_part['flags']))) {
730 $box = $boxes_part['unformatted'];
732 if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
735 $lowerbox = strtolower($box);
736 // mailboxes are casesensitive => inbox.sent != inbox.Sent
737 // nevermind, to many dependencies this should be fixed!
739 if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
742 switch ($shorten_box_names)
744 case SMPREF_MAILBOX_SELECT_DELIMITED
:
745 if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
747 * calculate pad level from number of delimiters. do it inside if control in order
748 * to reduce number of calculations. Other folders don't need it.
750 $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. ');
751 // i18n: Name of Sent folder
752 $box2 = $pad . _("Sent");
753 } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
754 $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. ');
755 // i18n: Name of Trash folder
756 $box2 = $pad . _("Trash");
757 } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
758 $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. ');
759 // i18n: Name of Drafts folder
760 $box2 = $pad . _("Drafts");
762 $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted']));
765 case SMPREF_MAILBOX_SELECT_INDENTED
:
766 if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
767 $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),' ');
768 $box2 = $pad . _("Sent");
769 } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
770 $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),' ');
771 $box2 = $pad . _("Trash");
772 } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
773 $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),' ');
774 $box2 = $pad . _("Drafts");
776 $box2 = str_replace('&nbsp;&nbsp;', ' ', htmlspecialchars($boxes_part['formatted']));
779 default: /* default, long names, style = 0 */
780 $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
785 $a[htmlspecialchars($box)] = $box2;
793 * Returns list of options (to be echoed into select statement
794 * based on available mailboxes and separators
795 * Caller should surround options with <select ...> </select> and
797 * @param stream $imap_stream imap connection resource to query for mailboxes
798 * @param array $show_selected array containing list of mailboxes to pre-select (0 if none)
799 * @param array $folder_skip array of folders to keep out of option list (compared in lower)
800 * @param $boxes list of already fetched boxes (for places like folder panel, where
801 * you know these options will be shown 3 times in a row.. (most often unset).
802 * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes.
803 * 'noselect' by default to remove unselectable mailboxes.
804 * 'noinferiors' used to filter out folders that can not contain subfolders.
805 * NULL to avoid flag check entirely.
806 * NOTE: noselect and noiferiors are used internally. The IMAP representation is
807 * \NoSelect and \NoInferiors
808 * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name.
809 * @return string html formated mailbox selection options
812 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
813 $flag = 'noselect', $use_long_format = false ) {
814 global $username, $data_dir, $translate_special_folders, $sent_folder,
815 $trash_folder, $draft_folder;
817 $boxes = sqimap_mailbox_option_array($imap_stream, $folder_skip, $boxes, $flag, $use_long_format);
820 foreach ($boxes as $value=>$option) {
821 $lowerbox = strtolower(htmlspecialchars($value));
823 if ($show_selected != 0) {
824 reset($show_selected);
825 while (!$sel && (list($x, $val) = each($show_selected))) {
826 if (strtolower($value) == strtolower(htmlspecialchars($val))) {
832 $str .= '<option value="'. $value .'"'. ($sel ?
' selected="selected"' : '').'>'. $option ."</option>\n";
839 * Returns sorted mailbox lists in several different ways.
841 * Since 1.5.1 most of the functionality has been moved to new function sqimap_get_mailboxes
843 * See comment on sqimap_mailbox_parse() for info about the returned array.
844 * @param resource $imap_stream imap connection resource
845 * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
846 * @return array list of mailboxes
847 * @since 1.0 or older
849 function sqimap_mailbox_list($imap_stream, $force=false) {
850 global $boxesnew,$show_only_subscribed_folders;
851 if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION
) ||
$force) {
852 $boxesnew=sqimap_get_mailboxes($imap_stream,$force,$show_only_subscribed_folders);
858 * Returns a list of all folders, subscribed or not
860 * Since 1.5.1 code moved to sqimap_get_mailboxes()
862 * @param stream $imap_stream imap connection resource
863 * @return array see sqimap_mailbox_parse()
864 * @since 1.0 or older
866 function sqimap_mailbox_list_all($imap_stream) {
867 global $show_only_subscribed_folders;
868 // fourth argument prevents registration of retrieved list of mailboxes in session
869 $boxes=sqimap_get_mailboxes($imap_stream,true,false,false);
875 * Gets the list of mailboxes for sqimap_maolbox_tree and sqimap_mailbox_list
877 * This is because both of those functions had duplicated logic, but with slightly different
878 * implementations. This will make both use the same implementation, which should make it
879 * easier to maintain and easier to modify in the future
880 * @param stream $imap_stream imap connection resource
881 * @param bool $force force a reload and ignore cache
882 * @param bool $show_only_subscribed controls listing of visible or all folders
883 * @param bool $session_register controls registration of retrieved data in session.
884 * @return object boxesnew - array of mailboxes and their attributes
887 function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=true,$session_register=true) {
888 global $show_only_subscribed_folders,$noselect_fix_enable,$folder_prefix,
889 $list_special_folders_first,$imap_server_type;
890 $inbox_subscribed = false;
891 $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
893 if ($show_only_subscribed) { $show_only_subscribed=$show_only_subscribed_folders; }
895 //require_once(SM_PATH . 'include/load_prefs.php');
898 * There are three main listing commands we can use in IMAP:
899 * LSUB shows just the list of subscribed folders
900 * may include flags, but these are not necessarily accurate or authoratative
901 * \NoSelect has special meaning: the folder does not exist -OR- it means this
902 * folder is not subscribed but children may be
904 * LIST this shows every mailbox on the system
905 * flags are always included and are accurate and authoratative
906 * \NoSelect means folder should not be selected
908 * LIST (SUBSCRIBED) implemented with LIST-SUBSCRIBED extension
909 * this is like list but returns only subscribed folders
910 * flag meanings are like LIST, not LSUB
911 * \NonExistent means mailbox doesn't exist
912 * \PlaceHolder means parent is not valid (selectable), but one or more children are
913 * \NoSelect indeed means that the folder should not be selected
914 * IMAPEXT-LIST-EXTENSIONS-04 August 2003 B. Leiba
916 if (!$show_only_subscribed) {
918 $sub_cache_name='list_cache';
919 } elseif ($listsubscribed) {
920 $lsub = 'LIST (SUBSCRIBED)';
921 $sub_cache_name='listsub_cache';
924 $sub_cache_name='lsub_cache';
927 // Some IMAP servers allow subfolders to exist even if the parent folders do not
928 // This fixes some problems with the folder list when this is the case, causing the
929 // NoSelect folders to be displayed
930 if ($noselect_fix_enable) {
931 $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
932 $list_args = "LIST \"$folder_prefix\" \"*%\"";
934 $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
935 $list_args = "LIST \"$folder_prefix\" \"*\"";
938 // get subscribed mailbox list from cache (session)
939 // if not there, then get it from the imap server and store in cache
942 sqgetGlobalVar($sub_cache_name,$lsub_cache,SQ_SESSION
);
945 $lsub_assoc_ary=array();
946 if (!empty($lsub_cache)) {
947 $lsub_assoc_ary=$lsub_cache;
949 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, true, $response, $message);
950 $lsub_ary = compact_mailboxes_response($lsub_ary);
951 if (!empty($lsub_ary)) {
952 foreach ($lsub_ary as $rawline) {
953 $temp_mailbox_name=find_mailbox_name($rawline);
954 $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
957 sqsession_register($lsub_assoc_ary,$sub_cache_name);
961 // Now to get the mailbox flags
962 // The LSUB response may return \NoSelect flags, etc. but it is optional
963 // according to RFC3501, and even when returned it may not be accurate
964 // or authoratative. LIST will always return accurate results.
965 if (($lsub == 'LIST') ||
($lsub == 'LIST (SUBSCRIBED)')) {
966 // we've already done a LIST or LIST (SUBSCRIBED)
967 // and NOT a LSUB, so no need to do it again
968 $list_assoc_ary = $lsub_assoc_ary;
970 // we did a LSUB so now we need to do a LIST
971 // first see if it is in cache
972 $list_cache_name='list_cache';
974 sqgetGlobalVar($list_cache_name,$list_cache,SQ_SESSION
);
977 if (!empty($list_cache)) {
978 $list_assoc_ary=$list_cache;
979 // we could store this in list_cache_name but not necessary
981 // not in cache so we need to go get it from the imap server
982 $list_assoc_ary = array();
983 $list_ary = sqimap_run_command($imap_stream, $list_args,
984 true, $response, $message);
985 $list_ary = compact_mailboxes_response($list_ary);
986 if (!empty($list_ary)) {
987 foreach ($list_ary as $rawline) {
988 $temp_mailbox_name=find_mailbox_name($rawline);
989 $list_assoc_ary[$temp_mailbox_name]=$rawline;
992 sqsession_register($list_assoc_ary,$list_cache_name);
997 // If they aren't subscribed to the inbox, then add it anyway (if its in LIST)
998 $inbox_subscribed=false;
999 if (!empty($lsub_assoc_ary)) {
1000 foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
1001 if (strtoupper($temp_mailbox_name) == 'INBOX') {
1002 $inbox_subscribed=true;
1006 if (!$inbox_subscribed) {
1007 if (!empty($list_assoc_ary)) {
1008 foreach ($list_assoc_ary as $temp_mailbox_name=>$rawline) {
1009 if (strtoupper($temp_mailbox_name) == 'INBOX') {
1010 $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
1016 // Now we have the raw output, we need to create an array of mailbox names we will return
1017 if (!$show_only_subscribed) {
1018 $final_folders_assoc_ary=$list_assoc_ary;
1021 * only show subscribed folders
1022 * we need to merge the folders here... we can't trust the flags, etc. from the lsub_assoc_array
1023 * so we use the lsub_assoc_array as the list of folders and the values come from list_assoc_array
1025 if (!empty($lsub_assoc_ary)) {
1026 foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
1027 if (!empty($list_assoc_ary[$temp_mailbox_name])) {
1028 $final_folders_assoc_ary[$temp_mailbox_name]=$list_assoc_ary[$temp_mailbox_name];
1035 // Now produce a flat, sorted list
1036 if (!empty($final_folders_assoc_ary)) {
1037 uksort($final_folders_assoc_ary,'strnatcasecmp');
1038 foreach ($final_folders_assoc_ary as $temp_mailbox_name=>$rawline) {
1039 $final_folders_ary[]=$rawline;
1043 // this will put it into an array we can use later
1045 // raw - Raw LIST/LSUB response from the IMAP server
1046 // formatted - formatted folder name
1047 // unformatted - unformatted, but with the delimiter at the end removed
1048 // unformated-dm - folder name as it appears in raw response
1049 // unformatted-disp - unformatted without $folder_prefix
1050 // id - the array element number (0, 1, 2, etc.)
1051 // flags - mailbox flags
1052 if (!empty($final_folders_ary)) {
1053 $boxesall = sqimap_mailbox_parse($final_folders_ary);
1055 // they have no mailboxes
1059 /* Now, lets sort for special folders */
1060 $boxesnew = $used = array();
1063 $cnt = count($boxesall);
1064 $used = array_pad($used,$cnt,false);
1066 for($k = 0; $k < $cnt; ++
$k) {
1067 if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
1068 $boxesnew[] = $boxesall[$k];
1075 if ($has_inbox == false) {
1076 // do a list request for inbox because we should always show
1077 // inbox even if the user isn't subscribed to it.
1078 $inbox_ary = sqimap_run_command($imap_stream, 'LIST "" "INBOX"',
1079 true, $response, $message);
1080 $inbox_ary = compact_mailboxes_response($inbox_ary);
1081 if (count($inbox_ary)) {
1082 $inbox_entry = sqimap_mailbox_parse($inbox_ary);
1083 // add it on top of the list
1084 if (!empty($boxesnew)) {
1085 array_unshift($boxesnew,$inbox_entry[0]);
1087 $boxesnew[]=$inbox_entry[0];
1089 /* array_unshift($used,true); */
1093 /* List special folders and their subfolders, if requested. */
1094 if ($list_special_folders_first) {
1095 for($k = 0; $k < $cnt; ++
$k) {
1096 if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
1097 $boxesnew[] = $boxesall[$k];
1103 /* Find INBOX's children */
1104 for($k = 0; $k < $cnt; ++
$k) {
1105 $isboxbelow=isBoxBelow(strtoupper($boxesall[$k]['unformatted']),'INBOX');
1106 if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
1112 if (!$used[$k] && $isboxbelow && $is_inbox) {
1113 $boxesnew[] = $boxesall[$k];
1118 /* Rest of the folders */
1119 for($k = 0; $k < $cnt; $k++
) {
1121 $boxesnew[] = $boxesall[$k];
1125 * Don't register boxes in session, if $session_register is set to false
1126 * Prevents registration of sqimap_mailbox_list_all() results.
1128 if ($session_register) sqsession_register($boxesnew,'boxesnew');
1133 * Fills mailbox object
1135 * this is passed the mailbox array by left_main.php
1136 * who has previously obtained it from sqimap_get_mailboxes
1137 * that way, the raw mailbox list is available in left_main to other
1138 * things besides just sqimap_mailbox_tree
1139 * imap_stream is just used now to get status info
1141 * most of the functionality is moved to sqimap_get_mailboxes
1142 * also takes care of TODO items:
1143 * caching mailbox tree
1144 * config setting for UW imap section (not needed now)
1146 * Some code fragments are present in 1.3.0 - 1.4.4.
1147 * @param stream $imap_stream imap connection resource
1148 * @param array $lsub_ary output array from sqimap_get_mailboxes (contains mailboxes and flags)
1149 * @return object see mailboxes class.
1152 function sqimap_mailbox_tree($imap_stream,$lsub_ary) {
1154 $sorted_lsub_ary = array();
1155 $cnt = count($lsub_ary);
1156 for ($i = 0; $i < $cnt; $i++
) {
1157 $mbx=$lsub_ary[$i]['unformatted'];
1158 $flags=$lsub_ary[$i]['flags'];
1161 if (in_array('\Noinferiors',$flags)) { $noinferiors=1; }
1162 if (in_array('\NoInferiors',$flags)) { $noinferiors=1; }
1163 if (in_array('\HasNoChildren',$flags)) { $noinferiors=1; }
1166 if (in_array('\NoSelect',$flags)) { $noselect=1; }
1168 * LIST (SUBSCRIBED) has two new flags, \NonExistent which means the mailbox is subscribed to
1169 * but doesn't exist, and \PlaceHolder which is similar (but not the same) as \NoSelect
1170 * For right now, we'll treat these the same as \NoSelect and this behavior can be changed
1173 if (in_array('\NonExistent',$flags)) { $noselect=1; }
1174 if (in_array('\PlaceHolder',$flags)) { $noselect=1; }
1175 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
1178 $sorted_lsub_ary = array_values($sorted_lsub_ary);
1179 usort($sorted_lsub_ary, 'mbxSort');
1180 $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
1185 * Callback function used for sorting mailboxes in sqimap_mailbox_tree
1188 * @return integer see php strnatcasecmp()
1191 function mbxSort($a, $b) {
1192 return strnatcasecmp($a['mbx'], $b['mbx']);
1196 * Fills mailbox object
1198 * Some code fragments are present in 1.3.0 - 1.4.4.
1199 * @param array $mbx_ary
1201 * @param stream $imap_stream imap connection resource
1202 * @return object see mailboxes class
1205 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
1206 global $data_dir, $username, $list_special_folders_first,
1207 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
1208 $move_to_trash, $move_to_sent, $save_as_draft,
1209 $delimiter, $imap_server_type;
1211 // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
1213 /* create virtual root node */
1214 $mailboxes= new mailboxes();
1215 $mailboxes->is_root
= true;
1219 if (isset($folder_prefix) && ($folder_prefix != '')) {
1220 $start = substr_count($folder_prefix,$delimiter);
1221 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
1222 $mailboxes->mailboxname_full
= substr($folder_prefix,0, (strlen($folder_prefix)-1));
1224 $mailboxes->mailboxname_full
= $folder_prefix;
1227 $mailboxes->mailboxname_sub
= $mailboxes->mailboxname_full
;
1232 $cnt = count($mbx_ary);
1233 for ($i=0; $i < $cnt; $i++
) {
1234 if ($mbx_ary[$i]['mbx'] !='' ) {
1235 $mbx = new mailboxes();
1236 $mailbox = $mbx_ary[$i]['mbx'];
1239 * Set the is_special flag if it concerned a special mailbox.
1240 * Used for displaying the special folders on top in the mailbox
1241 * tree displaying code.
1243 $mbx->is_special |
= ($mbx->is_inbox
= (strtoupper($mailbox) == 'INBOX'));
1244 $mbx->is_special |
= ($mbx->is_trash
= isTrashMailbox($mailbox));
1245 $mbx->is_special |
= ($mbx->is_sent
= isSentMailbox($mailbox));
1246 $mbx->is_special |
= ($mbx->is_draft
= isDraftMailbox($mailbox));
1248 if (!$mbx->is_special
)
1249 $mbx->is_special
= boolean_hook_function('special_mailbox', $mailbox, 1);
1251 if (isset($mbx_ary[$i]['unseen'])) {
1252 $mbx->unseen
= $mbx_ary[$i]['unseen'];
1254 if (isset($mbx_ary[$i]['nummessages'])) {
1255 $mbx->total
= $mbx_ary[$i]['nummessages'];
1258 $mbx->is_noselect
= $mbx_ary[$i]['noselect'];
1259 $mbx->is_noinferiors
= $mbx_ary[$i]['noinferiors'];
1261 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
1263 $mbx->mailboxname_sub
= substr($mbx_ary[$i]['mbx'],$r_del_pos+
1);
1264 } else { /* mailbox is root folder */
1265 $mbx->mailboxname_sub
= $mbx_ary[$i]['mbx'];
1267 $mbx->mailboxname_full
= $mbx_ary[$i]['mbx'];
1269 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
1272 sqimap_utf7_decode_mbx_tree($mailboxes);
1273 sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
1278 * @param object $mbx_tree
1281 function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
1282 global $draft_folder, $sent_folder, $trash_folder, $translate_special_folders;
1284 /* decode folder name and set mailboxname_sub */
1285 if ($translate_special_folders && strtoupper($mbx_tree->mailboxname_full
) == 'INBOX') {
1286 $mbx_tree->mailboxname_sub
= _("INBOX");
1287 } elseif ($translate_special_folders && $mbx_tree->mailboxname_full
== $draft_folder) {
1288 $mbx_tree->mailboxname_sub
= _("Drafts");
1289 } elseif ($translate_special_folders && $mbx_tree->mailboxname_full
== $sent_folder) {
1290 $mbx_tree->mailboxname_sub
= _("Sent");
1291 } elseif ($translate_special_folders && $mbx_tree->mailboxname_full
== $trash_folder) {
1292 $mbx_tree->mailboxname_sub
= _("Trash");
1294 $mbx_tree->mailboxname_sub
= imap_utf7_decode_local($mbx_tree->mailboxname_sub
);
1297 if ($mbx_tree->mbxs
) {
1298 $iCnt = count($mbx_tree->mbxs
);
1299 for ($i=0;$i<$iCnt;++
$i) {
1300 sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs
[$i]);
1306 * @param object $mbx_tree
1307 * @param array $aMbxs
1310 function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
1312 $aMbxs[] =& $mbx_tree;
1313 if ($mbx_tree->mbxs
) {
1314 $iCnt = count($mbx_tree->mbxs
);
1315 for ($i=0;$i<$iCnt;++
$i) {
1316 sqimap_tree_to_ref_array($mbx_tree->mbxs
[$i],$aMbxs);
1322 * @param stream $imap_stream imap connection resource
1323 * @param object $mbx_tree
1324 * @since since 1.5.0
1326 function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
1327 global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
1328 $aMbxs = $aQuery = array();
1329 sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
1330 // remove the root node
1331 array_shift($aMbxs);
1333 if($unseen_notify == 3) {
1334 $cnt = count($aMbxs);
1335 for($i=0;$i<$cnt;++
$i) {
1336 $oMbx =& $aMbxs[$i];
1337 if (!$oMbx->is_noselect
) {
1338 $mbx = $oMbx->mailboxname_full
;
1339 if ($unseen_type == 2 ||
1340 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1341 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN RECENT)';
1343 $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN RECENT)';
1345 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
1347 $oMbx->unseen
= $oMbx->total
= $oMbx->recent
= false;
1351 $aMbxs[$i] =& $oMbx;
1353 // execute all the queries at once
1354 $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
1355 $cnt = count($aMbxs);
1356 for($i=0;$i<$cnt;++
$i) {
1357 $oMbx =& $aMbxs[$i];
1359 if ($tag && $aServerResponse[$tag] == 'OK') {
1360 $sResponse = implode('', $aResponse[$tag]);
1361 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
1362 $oMbx->unseen
= $regs[1];
1364 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
1365 $oMbx->total
= $regs[1];
1367 if (preg_match('/RECENT\s+([0-9]+)/i', $sResponse, $regs)) {
1368 $oMbx->recent
= $regs[1];
1374 } else if ($unseen_notify == 2) { // INBOX only
1375 $cnt = count($aMbxs);
1376 for($i=0;$i<$cnt;++
$i) {
1377 $oMbx =& $aMbxs[$i];
1378 if (strtoupper($oMbx->mailboxname_full
) == 'INBOX' ||
1379 ($move_to_trash && $oMbx->mailboxname_full
== $trash_folder)) {
1380 if ($unseen_type == 2 ||
1381 ($oMbx->mailboxname_full
== $trash_folder && $move_to_trash)) {
1382 $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full
);
1383 $oMbx->unseen
= $aStatus['UNSEEN'];
1384 $oMbx->total
= $aStatus['MESSAGES'];
1385 $oMbx->recent
= $aStatus['RECENT'];
1387 $oMbx->unseen
= sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full
);
1389 $aMbxs[$i] =& $oMbx;
1390 if (!$move_to_trash && $trash_folder) {
1393 // trash comes after INBOX
1394 if ($oMbx->mailboxname_full
== $trash_folder) {
1402 $cnt = count($aMbxs);
1403 for($i=0;$i<$cnt;++
$i) {
1404 $oMbx =& $aMbxs[$i];
1405 unset($hook_status);
1406 if (!empty($oMbx->unseen
)) { $hook_status['UNSEEN']=$oMbx->unseen
; }
1407 if (!empty($oMbx->total
)) { $hook_status['MESSAGES']=$oMbx->total
; }
1408 if (!empty($oMbx->recent
)) { $hook_status['RECENT']=$oMbx->recent
; }
1409 if (!empty($hook_status))
1411 $hook_status['MAILBOX']=$oMbx->mailboxname_full
;
1412 $hook_status['CALLER']='sqimap_get_status_mbx_tree'; // helps w/ debugging
1413 do_hook('folder_status', $hook_status);
1419 * Checks if folder is noselect (can't store messages)
1421 * Function does not check if folder subscribed.
1422 * @param stream $oImapStream imap connection resource
1423 * @param string $sImapFolder imap folder name
1424 * @param object $oBoxes mailboxes class object.
1425 * @return boolean true, when folder has noselect flag. false in any other case.
1428 function sqimap_mailbox_is_noselect($oImapStream,$sImapFolder,&$oBoxes) {
1429 // build mailbox object if it is not available
1430 if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
1431 foreach($oBoxes as $box) {
1432 if ($box['unformatted']==$sImapFolder) {
1433 return (bool) check_is_noselect($box['raw']);
1440 * Checks if folder is noinferiors (can't store other folders)
1442 * Function does not check if folder subscribed.
1443 * @param stream $oImapStream imap connection resource
1444 * @param string $sImapFolder imap folder name
1445 * @param object $oBoxes mailboxes class object.
1446 * @return boolean true, when folder has noinferiors flag. false in any other case.
1449 function sqimap_mailbox_is_noinferiors($oImapStream,$sImapFolder,&$oBoxes) {
1450 // build mailbox object if it is not available
1451 if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
1452 foreach($oBoxes as $box) {
1453 if ($box['unformatted']==$sImapFolder) {
1454 return (bool) check_is_noinferiors($box['raw']);