<?php
-
/**
* imap_mailbox.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This impliments all functions that manipulate mailboxes
*
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
*/
-require_once('../functions/imap_utf7_encode_local.php');
-require_once('../functions/imap_utf7_decode_local.php');
+
+/** UTF7 support */
+require_once(SM_PATH . 'functions/imap_utf7_local.php');
+
global $boxesnew;
+/**
+ * Mailboxes class
+ *
+ * FIXME. This class should be extracted and placed in a separate file that
+ * can be included before we start the session. That makes caching of the tree
+ * possible. On a refresh mailboxes from left_main.php the only function that
+ * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
+ * / rename / delete / new we have to create methods for adding/changing the
+ * mailbox in the mbx_tree without the need for a refresh.
+ * @package squirrelmail
+*/
+
class mailboxes {
- var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false,
- $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
- $is_trash = false, $is_draft = false, $mbxs = array(),
- $unseen = false, $total = false;
-
- function addMbx($mbx, $delimiter, $start, $specialfirst) {
- $ary = explode($delimiter, $mbx->mailboxname_full);
- $mbx_parent = &$this;
- for ($i=$start; $i < (count($ary) -1); $i++) {
- $mbx_childs = &$mbx_parent->mbxs;
- $found = false;
- if ($mbx_childs) {
- foreach ($mbx_childs as $key => $parent) {
- if ($parent->mailboxname_sub == $ary[$i]) {
- $mbx_parent = &$mbx_parent->mbxs[$key];
- $found = true;
- }
- }
- }
- if (!$found) {
- $no_select_mbx = new mailboxes();
- if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
- $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
- } else {
- $no_select_mbx->mailboxname_full = $ary[$i];
- }
- $no_select_mbx->mailboxname_sub = $ary[$i];
- $no_select_mbx->is_noselect = true;
- $mbx_parent->mbxs[] = $no_select_mbx;
- $i--;
- }
-
- }
- $mbx_parent->mbxs[] = $mbx;
- if ($mbx->is_special && $specialfirst) {
- usort($mbx_parent->mbxs, 'sortSpecialMbx');
- }
-
- }
+ var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
+ $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
+ $is_trash = false, $is_draft = false, $mbxs = array(),
+ $unseen = false, $total = false;
+
+ function addMbx($mbx, $delimiter, $start, $specialfirst) {
+ $ary = explode($delimiter, $mbx->mailboxname_full);
+ $mbx_parent =& $this;
+ for ($i = $start, $c = count($ary)-1; $i < $c; $i++) {
+ $mbx_childs =& $mbx_parent->mbxs;
+ $found = false;
+ if ($mbx_childs) {
+ foreach ($mbx_childs as $key => $parent) {
+ if ($parent->mailboxname_sub == $ary[$i]) {
+ $mbx_parent =& $mbx_parent->mbxs[$key];
+ $found = true;
+ break;
+ }
+ }
+ }
+ if (!$found) {
+ $no_select_mbx = new mailboxes();
+ if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
+ $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
+ } else {
+ $no_select_mbx->mailboxname_full = $ary[$i];
+ }
+ $no_select_mbx->mailboxname_sub = $ary[$i];
+ $no_select_mbx->is_noselect = true;
+ $mbx_parent->mbxs[] = $no_select_mbx;
+ $i--;
+ }
+ }
+ $mbx_parent->mbxs[] = $mbx;
+ if ($mbx->is_special && $specialfirst) {
+ usort($mbx_parent->mbxs, 'sortSpecialMbx');
+ }
+ }
}
function sortSpecialMbx($a, $b) {
if ($a->is_inbox) {
- $acmp = '0'. $a->mailboxname_full;
+ $acmp = '0'. $a->mailboxname_full;
} else if ($a->is_special) {
- $acmp = '1'. $a->mailboxname_full;
+ $acmp = '1'. $a->mailboxname_full;
} else {
- $acmp = '2' . $a->mailboxname_full;
- }
+ $acmp = '2' . $a->mailboxname_full;
+ }
if ($b->is_inbox) {
- $bcmp = '0'. $b->mailboxname_full;
+ $bcmp = '0'. $b->mailboxname_full;
}else if ($b->is_special) {
- $bcmp = '1' . $b->mailboxname_full;
+ $bcmp = '1' . $b->mailboxname_full;
} else {
- $bcmp = '2' . $b->mailboxname_full;
+ $bcmp = '2' . $b->mailboxname_full;
}
- if ($acmp == $bcmp) return 0;
- return ($acmp>$bcmp) ? 1: -1;
-}
+ return strnatcasecmp($acmp, $bcmp);
+}
+function compact_mailboxes_response($ary)
+{
+ /*
+ * Workaround for mailboxes returned as literal
+ * FIXME : Doesn't work if the mailbox name is multiple lines
+ * (larger then fgets buffer)
+ */
+ for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) {
+ if (isset($ary[$i + 1]) && substr($ary[$i], -3) == "}\r\n") {
+ if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
+ $ary[$i], $regs)) {
+ $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+1])) . '"' . $regs[2];
+ array_splice($ary, $i+1, 2);
+ }
+ }
+ }
+ /* remove duplicates and ensure array is contiguous */
+ return array_values(array_unique($ary));
+}
-function find_mailbox_name ($mailbox) {
- if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
+/**
+ * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
+ * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
+ * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
+ */
+function find_mailbox_name($line)
+{
+ if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
+ if (substr($regs[1], 0, 1) == '"')
+ return stripslashes(substr($regs[1], 1, -1));
return $regs[1];
- ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
- return $regs[1];
-
+ }
+ return '';
+}
+
+/**
+ * @return bool whether this is a Noselect mailbox.
+ */
+function check_is_noselect ($lsub_line) {
+ return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
+}
+
+/**
+ * @return bool whether this is a Noinferiors mailbox.
+ */
+function check_is_noinferiors ($lsub_line) {
+ return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
}
/**
* mailbox name (i.e. the mailbox's parent mailbox)
*/
function readMailboxParent($haystack, $needle) {
-
if ($needle == '') {
$ret = '';
} else {
return( $ret );
}
-
-function isBoxBelow( $box2, $box1 ) {
- global $delimiter, $folder_prefix, $imap_server_type;
-
- if ( $imap_server_type == 'uw' ) {
- $boxs = $box2;
- $i = strpos( $box1, $delimiter, strlen( $folder_prefix ) );
- if ( $i === false ) {
- $i = strlen( $box2 );
+/**
+ * Check if $subbox is below the specified $parentbox
+ */
+function isBoxBelow( $subbox, $parentbox ) {
+ global $delimiter;
+ /*
+ * Eliminate the obvious mismatch, where the
+ * subfolder path is shorter than that of the potential parent
+ */
+ if ( strlen($subbox) < strlen($parentbox) ) {
+ return false;
+ }
+ /* check for delimiter */
+ if (!substr($parentbox,-1) == $delimiter) {
+ $parentbox.=$delimiter;
}
- } else {
- $boxs = $box2 . $delimiter;
- /* Skip next second delimiter */
- $i = strpos( $box1, $delimiter );
- $i = strpos( $box1, $delimiter, $i + 1 );
- if ( $i === false ) {
- $i = strlen( $box2 );
+ if (substr($subbox,0,strlen($parentbox)) == $parentbox) {
+ return true;
} else {
- $i++;
+ return false;
}
- }
-
- return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
}
-/* Defines special mailboxes */
+/**
+ * Defines special mailboxes: given a mailbox name, it checks if this is a
+ * "special" one: INBOX, Trash, Sent or Draft.
+ */
function isSpecialMailbox( $box ) {
- global $trash_folder, $sent_folder, $draft_folder,
- $move_to_trash, $move_to_sent, $save_as_draft;
-
$ret = ( (strtolower($box) == 'inbox') ||
- ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) ||
- ( $move_to_sent && isBoxBelow( $box, $sent_folder )) ||
- ($save_as_draft && $box == $draft_folder ) );
+ isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) );
if ( !$ret ) {
- $ret = do_hook_function( 'special_mailbox', $box );
+ $ret = boolean_hook_function('special_mailbox',$box,1);
}
-
return $ret;
}
-/* Expunges a mailbox */
+/**
+ * @return bool whether this is a Trash folder
+ */
+function isTrashMailbox ($box) {
+ global $trash_folder, $move_to_trash;
+ return $move_to_trash && $trash_folder &&
+ ( $box == $trash_folder || isBoxBelow($box, $trash_folder) );
+}
+
+/**
+ * @return bool whether this is a Sent folder
+ */
+function isSentMailbox($box) {
+ global $sent_folder, $move_to_sent;
+ return $move_to_sent && $sent_folder &&
+ ( $box == $sent_folder || isBoxBelow($box, $sent_folder) );
+}
+
+/**
+ * @return bool whether this is a Draft folder
+ */
+function isDraftMailbox($box) {
+ global $draft_folder, $save_as_draft;
+ return $save_as_draft &&
+ ( $box == $draft_folder || isBoxBelow($box, $draft_folder) );
+}
+
+/**
+ * Expunges a mailbox, ie. delete all contents.
+ */
function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
- global $uid_support;
if ($id) {
- if (is_array($id)) {
- $id = sqimap_message_list_squisher($id);
- }
- $id = ' '.$id;
- $uid = $uid_support;
+ if (is_array($id)) {
+ $id = sqimap_message_list_squisher($id);
+ }
+ $id = ' '.$id;
+ $uid = TRUE;
} else {
- $uid = false;
+ $uid = false;
}
$read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
$response, $message, $uid);
- $cnt = 0;
- foreach ($read as $r) {
- if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
- $cnt++;
- }
+ $cnt = 0;
+
+ if (is_array($read)) {
+ foreach ($read as $r) {
+ if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
+ $cnt++;
+ }
+ }
+ }
+ return $cnt;
+}
+
+
+/**
+ * Expunge specified message, updated $msgs and $msort
+ *
+ * Until Marc and I come up with a better way to maintain
+ * these stupid arrays, we'll use this wrapper function to
+ * remove the message with the matching UID .. the order
+ * won't be changed - the array element for the message
+ * will just be removed.
+ */
+function sqimap_mailbox_expunge_dmn($message_id, $aMbxResponse, &$server_sort_array)
+{
+ global $msgs, $msort, $sort, $imapConnection,
+ $mailbox, $auto_expunge,
+ $sort, $allow_server_sort, $thread_sort_messages, $allow_thread_sort,
+ $username, $data_dir;
+ $cnt = 0;
+
+ if (!isset($sort) || $sort === false) {
+ sqgetGlobalVar('sort',$sort,SQ_GET);
}
- return $cnt;
+
+ if ($auto_expunge) {
+ $cnt = sqimap_mailbox_expunge($imapConnection, $mailbox, true);
+ } else {
+ return $cnt;
+ }
+
+ // Got to grab this out of prefs, since it isn't saved from mailbox_view.php
+ if ($allow_thread_sort && getPref($data_dir, $username, "thread_$mailbox",0)) {
+ $mode = 'thread';
+ } else if ($allow_server_sort) {
+ $mode = 'server_sort';
+ } else {
+ $mode = '';
+ }
+ $error = '';
+ if (is_array($server_sort_array)) {
+ $key = array_search($message_id,$server_sort_array,true);
+ if ($key !== false) {
+ unset($server_sort_array[$key]);
+ $server_sort_array = array_values($server_sort_array);
+ } else {
+ $server_sort_array = get_sorted_msgs_list($imapConnection,$sort,$mode,$error);
+ }
+ } else {
+ $server_sort_array = get_sorted_msgs_list($imapConnection,$sort,$mode,$error);
+ }
+ sqsession_register($server_sort_array,'server_sort_array');
+ return $cnt;
}
-/* Checks whether or not the specified mailbox exists */
+/**
+ * Checks whether or not the specified mailbox exists
+ */
function sqimap_mailbox_exists ($imap_stream, $mailbox) {
- if (! isset($mailbox)) {
+ if (!isset($mailbox) || empty($mailbox)) {
return false;
}
- $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
+ $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
true, $response, $message);
return isset($mbx[0]);
}
-/* Selects a mailbox */
+/**
+ * Selects a mailbox
+ */
function sqimap_mailbox_select ($imap_stream, $mailbox) {
- global $auto_expunge;
-
- if ( $mailbox == 'None' ) {
+ if ($mailbox == 'None') {
return;
}
- $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
+ $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
true, $response, $message);
$result = array();
- for ($i=0; $i<count($read); $i++) {
+ for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
- $result[strtoupper($regs[1])] = $regs[2];
- } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
- $result[strtoupper($regs[2])] = $regs[1];
- } else {
- if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
- $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
- $result['PERMANENTFLAGS'] = $regs[1];
- }
- else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
- $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
- $result['FLAGS'] = $regs[1];
- }
- }
+ $result[strtoupper($regs[1])] = $regs[2];
+ } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
+ $result[strtoupper($regs[2])] = $regs[1];
+ } else {
+ if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
+ $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
+ $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
+ } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
+ $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
+ $result['FLAGS'] = explode(' ',strtolower($regs[1]));
+ }
+ }
+ }
+ if (!isset($result['PERMANENTFLAGS'])) {
+ $result['PERMANENTFLAGS'] = $result['FLAGS'];
}
if (preg_match('/^\[(.+)\]/',$message, $regs)) {
- $result['RIGHTS']=$regs[1];
+ $result['RIGHTS']=strtoupper($regs[1]);
}
- if ($auto_expunge) {
- $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
- }
return $result;
}
-/* Creates a folder */
+/**
+ * Creates a folder.
+ */
function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
global $delimiter;
if (strtolower($type) == 'noselect') {
$mailbox .= $delimiter;
}
- $mailbox = imap_utf7_encode_local($mailbox);
- $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
+
+ $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
+ sqimap_encode_mailbox_name($mailbox),
true, $response, $message);
sqimap_subscribe ($imap_stream, $mailbox);
}
-/* Subscribes to an existing folder */
-function sqimap_subscribe ($imap_stream, $mailbox) {
- $read_ary = sqimap_run_command($imap_stream, "SUBSCRIBE \"$mailbox\"",
- true, $response, $message);
+/**
+ * Subscribes to an existing folder.
+ */
+function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
+ $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
+ sqimap_encode_mailbox_name($mailbox),
+ $debug, $response, $message);
}
-/* Unsubscribes to an existing folder */
+/**
+ * Unsubscribes from an existing folder
+ */
function sqimap_unsubscribe ($imap_stream, $mailbox) {
- global $imap_server_type;
- $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
- true, $response, $message);
+ $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
+ sqimap_encode_mailbox_name($mailbox),
+ false, $response, $message);
}
-/* Deletes the given folder */
+/**
+ * Deletes the given folder
+ */
function sqimap_mailbox_delete ($imap_stream, $mailbox) {
global $data_dir, $username;
- $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
- true, $response, $message);
sqimap_unsubscribe ($imap_stream, $mailbox);
- do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
- removePref($data_dir, $username, "thread_$mailbox");
+ $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
+ sqimap_encode_mailbox_name($mailbox),
+ true, $response, $message);
+ if ($response !== 'OK') {
+ // subscribe again
+ sqimap_subscribe ($imap_stream, $mailbox);
+ } else {
+ do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
+ removePref($data_dir, $username, "thread_$mailbox");
+ }
}
-/* Determines if the user is subscribed to the folder or not */
+/**
+ * Determines if the user is subscribed to the folder or not
+ */
function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
$boxesall = sqimap_mailbox_list ($imap_stream);
foreach ($boxesall as $ref) {
return false;
}
-/* Renames a mailbox */
+/**
+ * Renames a mailbox.
+ */
function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
if ( $old_name != $new_name ) {
global $delimiter, $imap_server_type, $data_dir, $username;
} else {
$postfix = '';
}
+
$boxesall = sqimap_mailbox_list($imap_stream);
- $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' . quoteIMAP($new_name) . '"';
+ $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
+ ' ' . sqimap_encode_mailbox_name($new_name);
$data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
sqimap_unsubscribe($imap_stream, $old_name.$postfix);
- $oldpref = getPref($data_dir, $username, "thread_".$old_name.$postfix);
- removePref($data_dir, $username, "thread_".$old_name.$postfix);
+ $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
+ removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
sqimap_subscribe($imap_stream, $new_name.$postfix);
- setPref($data_dir, $username, "thread_".$new_name.$postfix, $oldpref);
- do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
+ setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref);
+ do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
$l = strlen( $old_name ) + 1;
$p = 'unformatted';
- foreach ( $boxesall as $box ) {
- if ( substr( $box[$p], 0, $l ) == $old_name . $delimiter ) {
+
+ foreach ($boxesall as $box) {
+ if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
$new_sub = $new_name . $delimiter . substr($box[$p], $l);
if ($imap_server_type == 'cyrus') {
- $cmd = 'RENAME "' . quoteIMAP($box[$p]) . '" "' . quoteIMAP($new_sub) . '"';
+ $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
$data = sqimap_run_command($imap_stream, $cmd, true,
$response, $message);
}
sqimap_unsubscribe($imap_stream, $box[$p]);
- $oldpref = getPref($data_dir, $username, "thread_".$box[$p]);
- removePref($data_dir, $username, "thread_".$box[$p]);
+ $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
+ removePref($data_dir, $username, 'thread_'.$box[$p]);
sqimap_subscribe($imap_stream, $new_sub);
- setPref($data_dir, $username, "thread_".$new_sub, $oldpref);
- do_hook_function("rename_or_delete_folder",
+ setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
+ do_hook_function('rename_or_delete_folder',
$args = array($box[$p], 'rename', $new_sub));
}
}
}
}
-/*
- * Formats a mailbox into 4 parts for the $boxesall array
+/**
+ * Formats a mailbox into parts for the $boxesall array
*
- * The four parts are:
+ * The parts are:
*
* raw - Raw LIST/LSUB response from the IMAP server
* formatted - nicely formatted folder name
global $folder_prefix, $delimiter;
/* Process each folder line */
- for ($g=0; $g < count($line); $g++) {
-
+ for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) {
/* Store the raw IMAP reply */
if (isset($line[$g])) {
- $boxesall[$g]["raw"] = $line[$g];
- }
- else {
- $boxesall[$g]["raw"] = '';
+ $boxesall[$g]['raw'] = $line[$g];
+ } else {
+ $boxesall[$g]['raw'] = '';
}
-
/* Count number of delimiters ($delimiter) in folder name */
- $mailbox = trim($line_lsub[$g]);
- $dm_count = substr_count($mailbox, $delimiter);
+ $mailbox = /*trim(*/$line_lsub[$g]/*)*/;
+ $dm_count = substr_count($mailbox, $delimiter);
if (substr($mailbox, -1) == $delimiter) {
/* If name ends in delimiter, decrement count by one */
$dm_count--;
$parentfolder = readMailboxParent($mailbox, $delimiter);
if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
(substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
- ( isset($boxesallbyname[$parentfolder]) &&
- (strlen($parentfolder) > 0) ) ) {
- $indent = $dm_count - ( substr_count($folder_prefix, $delimiter));
+ (isset($boxesallbyname[$parentfolder]) &&
+ (strlen($parentfolder) > 0) ) ) {
+ $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
if ($indent > 0) {
- $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
- }
- else {
+ $boxesall[$g]['formatted'] = str_repeat(' ', $indent);
+ } else {
$boxesall[$g]['formatted'] = '';
}
$boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
- }
- else {
+ } else {
$boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
}
$boxesall[$g]['flags'] = array();
if (isset($line[$g])) {
ereg("\(([^)]*)\)",$line[$g],$regs);
+ // FIXME Flags do contain the \ character. \NoSelect \NoInferiors
+ // and $MDNSent <= last one doesn't have the \
+ // It's better to follow RFC3501 instead of using our own naming.
$flags = trim(strtolower(str_replace('\\', '',$regs[1])));
if ($flags) {
$boxesall[$g]['flags'] = explode(' ', $flags);
}
}
}
-
return $boxesall;
}
-/*
- * Sorting function used to sort mailbox names.
- * + Original patch from dave_michmerhuizen@yahoo.com
- * + Allows case insensitivity when sorting folders
- * + Takes care of the delimiter being sorted to the end, causing
- * subfolders to be listed in below folders that are prefixed
- * with their parent folders name.
- *
- * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
- * Without special sort function: foobar between foo and foo.bar
- * With special sort function: foobar AFTER foo and foo.bar :)
+/**
+ * Returns list of options (to be echoed into select statement
+ * based on available mailboxes and separators
+ * Caller should surround options with <SELECT..> </SELECT> and
+ * any formatting.
+ * $imap_stream - $imapConnection to query for mailboxes
+ * $show_selected - array containing list of mailboxes to pre-select (0 if none)
+ * $folder_skip - array of folders to keep out of option list (compared in lower)
+ * $boxes - list of already fetched boxes (for places like folder panel, where
+ * you know these options will be shown 3 times in a row.. (most often unset).
+ * $flag - flag to check for in mailbox flags, used to filter out mailboxes.
+ * 'noselect' by default to remove unselectable mailboxes.
+ * 'noinferiors' used to filter out folders that can not contain subfolders.
+ * NULL to avoid flag check entirely.
+ * NOTE: noselect and noiferiors are used internally. The IMAP representation is
+ * \NoSelect and \NoInferiors
+ * $use_long_format - override folder display preference and always show full folder name.
*/
-function user_strcasecmp($a, $b) {
- global $delimiter;
-
- /* Calculate the length of some strings. */
- $a_length = strlen($a);
- $b_length = strlen($b);
- $min_length = min($a_length, $b_length);
- $delimiter_length = strlen($delimiter);
-
- /* Set the initial result value. */
- $result = 0;
-
- /* Check the strings... */
- for ($c = 0; $c < $min_length; ++$c) {
- $a_del = substr($a, $c, $delimiter_length);
- $b_del = substr($b, $c, $delimiter_length);
-
- if (($a_del == $delimiter) && ($b_del == $delimiter)) {
- $result = 0;
- } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
- $result = -1;
- } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
- $result = 1;
- } else {
- $result = strcasecmp($a{$c}, $b{$c});
- }
+function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
+ $flag = 'noselect', $use_long_format = false ) {
+ global $username, $data_dir;
+ $mbox_options = '';
+ if ( $use_long_format ) {
+ $shorten_box_names = 0;
+ } else {
+ $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF);
+ }
- if ($result != 0) {
- break;
- }
+ if ($boxes == 0) {
+ $boxes = sqimap_mailbox_list($imap_stream);
}
- /* If one string is a prefix of the other... */
- if ($result == 0) {
- if ($a_length < $b_length) {
- $result = -1;
- } else if ($a_length > $b_length) {
- $result = 1;
+ foreach ($boxes as $boxes_part) {
+ if ($flag == NULL || !in_array($flag, $boxes_part['flags'])) {
+ $box = $boxes_part['unformatted'];
+
+ if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
+ continue;
+ }
+ $lowerbox = strtolower($box);
+ // mailboxes are casesensitive => inbox.sent != inbox.Sent
+ // nevermind, to many dependencies this should be fixed!
+
+ if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
+ $box2 = _("INBOX");
+ } else {
+ switch ($shorten_box_names)
+ {
+ case 2: /* delimited, style = 2 */
+ $box2 = str_replace(' ', '. ', $boxes_part['formatted']);
+ break;
+ case 1: /* indent, style = 1 */
+ $box2 = $boxes_part['formatted'];
+ break;
+ default: /* default, long names, style = 0 */
+ $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
+ break;
+ }
+ }
+ if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
+ $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'" SELECTED>'.$box2.'</OPTION>' . "\n";
+ } else {
+ $mbox_options .= '<OPTION VALUE="' . htmlspecialchars($box) .'">'.$box2.'</OPTION>' . "\n";
+ }
}
}
-
- return $result;
+ return $mbox_options;
}
-
-/*
- * Returns sorted mailbox lists in several different ways.
+/**
+ * Returns sorted mailbox lists in several different ways.
* See comment on sqimap_mailbox_parse() for info about the returned array.
*/
-function sqimap_mailbox_list($imap_stream) {
- global $default_folder_prefix;
- if ( !isset( $boxesnew ) ) {
+function sqimap_mailbox_list($imap_stream, $force=false) {
+ global $default_folder_prefix;
+
+ if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
global $data_dir, $username, $list_special_folders_first,
$folder_prefix, $trash_folder, $sent_folder, $draft_folder,
$move_to_trash, $move_to_sent, $save_as_draft,
- $delimiter, $noselect_fix_enable;
-
+ $delimiter, $noselect_fix_enable, $imap_server_type;
$inbox_in_list = false;
$inbox_subscribed = false;
+ $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
- require_once('../src/load_prefs.php');
- require_once('../functions/array.php');
+ require_once(SM_PATH . 'include/load_prefs.php');
- if ($noselect_fix_enable) {
- $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
- }
- else {
- $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
- }
+
+ if ($listsubscribed) {
+ $lsub = 'LIST (SUBSCRIBED)';
+ } else {
+ $lsub = 'LSUB';
+ }
+
+ if ($noselect_fix_enable) {
+
+ $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
+ } else {
+ $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
+ }
/* LSUB array */
$lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
true, $response, $message);
-
-
- /*
- * Section about removing the last element was removed
- * We don't return "* OK" anymore from sqimap_read_data
- */
+ $lsub_ary = compact_mailboxes_response($lsub_ary);
$sorted_lsub_ary = array();
- for ($i=0;$i < count($lsub_ary); $i++) {
- /*
- * Workaround for EIMS
- * Doesn't work if the mailbox name is multiple lines
- */
- if (isset($lsub_ary[$i + 1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
- $lsub_ary[$i], $regs)) {
- $i ++;
- $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
- }
+ for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) {
+
$temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
$sorted_lsub_ary[] = $temp_mailbox_name;
- if (strtoupper($temp_mailbox_name) == 'INBOX') {
+ if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') {
$inbox_subscribed = true;
}
}
- $new_ary = array();
- for ($i=0; $i < count($sorted_lsub_ary); $i++) {
- if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
- $new_ary[] = $sorted_lsub_ary[$i];
- }
- }
- $sorted_lsub_ary = $new_ary;
+
+ /* natural sort mailboxes */
if (isset($sorted_lsub_ary)) {
- usort($sorted_lsub_ary, 'user_strcasecmp');
+ usort($sorted_lsub_ary, 'strnatcasecmp');
}
-
- /* LIST array */
+ /*
+ * The LSUB response doesn't provide us information about \Noselect
+ * mail boxes. The LIST response does, that's why we need to do a LIST
+ * call to retrieve the flags for the mailbox
+ * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response.
+ * in other words, we cannot rely on it.
+ */
$sorted_list_ary = array();
- for ($i=0; $i < count($sorted_lsub_ary); $i++) {
+ // if (!$listsubscribed) {
+ for ($i=0; $i < count($sorted_lsub_ary); $i++) {
if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
$mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
}
$mbx = $sorted_lsub_ary[$i];
}
- $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
+ $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx),
true, $response, $message);
- /* Another workaround for EIMS */
- if (isset($read[1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
- $read[0], $regs)) {
- $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
- }
- if (isset($sorted_list_ary[$i])) {
- $sorted_list_ary[$i] = '';
- }
+ $read = compact_mailboxes_response($read);
if (isset($read[0])) {
$sorted_list_ary[$i] = $read[0];
- }
- else {
+ } else {
$sorted_list_ary[$i] = '';
}
-
- if (isset($sorted_list_ary[$i]) &&
- strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
- $inbox_in_list = true;
- }
- }
-
+ }
+ // }
/*
* Just in case they're not subscribed to their inbox,
* we'll get it for them anyway
*/
- if (!$inbox_subscribed || !$inbox_in_list) {
- $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
+ if (!$inbox_subscribed) {
+ $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"',
true, $response, $message);
- /* Another workaround for EIMS */
- if (isset($inbox_ary[1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
- $inbox_ary[0], $regs)) {
- $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
- '"' . $regs[2];
- }
-
- $sorted_list_ary[] = $inbox_ary[0];
+ $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary));
$sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
}
$boxesnew = $used = array();
/* Find INBOX */
- foreach ( $boxesall as $k => $box ) {
- if ( strtolower($box['unformatted']) == 'inbox') {
- $boxesnew[] = $box;
+ $cnt = count($boxesall);
+ $used = array_pad($used,$cnt,false);
+ for($k = 0; $k < $cnt; ++$k) {
+ if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
+ $boxesnew[] = $boxesall[$k];
$used[$k] = true;
- } else {
- $used[$k] = false;
+ break;
}
}
/* List special folders and their subfolders, if requested. */
if ($list_special_folders_first) {
- foreach ( $boxesall as $k => $box ) {
- if ( !$used[$k] && isSpecialMailbox( $box['unformatted'] ) ) {
- $boxesnew[] = $box;
- $used[$k] = true;
- }
- $spec_sub = str_replace(' ', '', $box['formatted']);
- $spec_sub = str_replace('*', '', $spec_sub);
- $spec_sub = str_replace('?', '\?', $spec_sub);
-
- /* In case of problems with preg
- here is a ereg version
- if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */
-
- if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) {
- $boxesnew[] = $box;
- $used[$k] = true;
+ for($k = 0; $k < $cnt; ++$k) {
+ if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
+ $boxesnew[] = $boxesall[$k];
+ $used[$k] = true;
}
}
-
}
- /* Rest of the folders */
- foreach ( $boxesall as $k => $box ) {
- if ( !$used[$k] ) {
- $boxesnew[] = $box;
+ /* Rest of the folders */
+ for($k = 0; $k < $cnt; $k++) {
+ if (!$used[$k]) {
+ $boxesnew[] = $boxesall[$k];
}
}
+ sqsession_register($boxesnew,'boxesnew');
}
return $boxesnew;
}
-/*
+/**
* Returns a list of all folders, subscribed or not
*/
function sqimap_mailbox_list_all($imap_stream) {
global $list_special_folders_first, $folder_prefix, $delimiter;
- require_once('../functions/array.php');
+ $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false);
+ $read_ary = compact_mailboxes_response($read_ary);
- $ssid = sqimap_session_id();
- $lsid = strlen( $ssid );
- fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
- $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
$g = 0;
$phase = 'inbox';
+ $fld_pre_length = strlen($folder_prefix);
+ for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++) {
+ /* Store the raw IMAP reply */
+ $boxes[$g]['raw'] = $read_ary[$i];
- for ($i = 0; $i < count($read_ary); $i++) {
- /* Another workaround for EIMS */
- if (isset($read_ary[$i + 1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
- $read_ary[$i], $regs)) {
- $i ++;
- $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
- }
- if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
-
- /* Store the raw IMAP reply */
- $boxes[$g]['raw'] = $read_ary[$i];
-
- /* Count number of delimiters ($delimiter) in folder name */
- $mailbox = find_mailbox_name($read_ary[$i]);
- $dm_count = substr_count($mailbox, $delimiter);
- if (substr($mailbox, -1) == $delimiter) {
- /* If name ends in delimiter - decrement count by one */
- $dm_count--;
- }
-
- /* Format folder name, but only if it's a INBOX.* or has a parent. */
- $boxesallbyname[$mailbox] = $g;
- $parentfolder = readMailboxParent($mailbox, $delimiter);
- if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
- (ereg('^'.$folder_prefix, $mailbox)) ||
- ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
- if ($dm_count) {
- $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
- }
- else {
- $boxes[$g]['formatted'] = '';
- }
- $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
- }
- else {
- $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
- }
-
- $boxes[$g]['unformatted-dm'] = $mailbox;
- if (substr($mailbox, -1) == $delimiter) {
- $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
- }
- $boxes[$g]['unformatted'] = $mailbox;
- $boxes[$g]['unformatted-disp'] = ereg_replace('^' . $folder_prefix, '', $mailbox);
- $boxes[$g]['id'] = $g;
-
- /* Now lets get the flags for this mailbox */
- $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
- true, $response, $message);
-
- /* Another workaround for EIMS */
- if (isset($read_mlbx[1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
- $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
- }
+ /* Count number of delimiters ($delimiter) in folder name */
+ $mailbox = find_mailbox_name($read_ary[$i]);
+ $dm_count = substr_count($mailbox, $delimiter);
+ if (substr($mailbox, -1) == $delimiter) {
+ /* If name ends in delimiter - decrement count by one */
+ $dm_count--;
+ }
- $flags = substr($read_mlbx[0], strpos($read_mlbx[0], '(')+1);
- $flags = substr($flags, 0, strpos($flags, ')'));
- $flags = str_replace('\\', '', $flags);
- $flags = trim(strtolower($flags));
- if ($flags) {
- $boxes[$g]['flags'] = explode(' ', $flags);
+ /* Format folder name, but only if it's a INBOX.* or has a parent. */
+ $boxesallbyname[$mailbox] = $g;
+ $parentfolder = readMailboxParent($mailbox, $delimiter);
+ if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
+ (ereg('^'.$folder_prefix, $mailbox)) ||
+ ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
+ if ($dm_count) {
+ $boxes[$g]['formatted'] = str_repeat(' ', $dm_count);
} else {
- $boxes[$g]['flags'] = array();
+ $boxes[$g]['formatted'] = '';
}
+ $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
+ } else {
+ $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
+ }
+
+ $boxes[$g]['unformatted-dm'] = $mailbox;
+ if (substr($mailbox, -1) == $delimiter) {
+ $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
+ }
+ $boxes[$g]['unformatted'] = $mailbox;
+ $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
+
+ $boxes[$g]['id'] = $g;
+
+ /* Now lets get the flags for this mailbox */
+ $read_mlbx = $read_ary[$i];
+ $flags = substr($read_mlbx, strpos($read_mlbx, '(')+1);
+ $flags = substr($flags, 0, strpos($flags, ')'));
+ $flags = str_replace('\\', '', $flags);
+ $flags = trim(strtolower($flags));
+ if ($flags) {
+ $boxes[$g]['flags'] = explode(' ', $flags);
+ } else {
+ $boxes[$g]['flags'] = array();
}
$g++;
}
if(is_array($boxes)) {
- $boxes = ary_sort ($boxes, 'unformatted', 1);
+ sort ($boxes);
}
return $boxes;
function sqimap_mailbox_tree($imap_stream) {
global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
- if ( !isset( $boxesnew ) ) {
+ if (true) {
global $data_dir, $username, $list_special_folders_first,
- $folder_prefix, $delimiter, $trash_folder, $move_to_trash;
+ $folder_prefix, $delimiter, $trash_folder, $move_to_trash,
+ $imap_server_type;
$inbox_in_list = false;
$inbox_subscribed = false;
+ $noselect = false;
+ $noinferiors = false;
- require_once('../src/load_prefs.php');
- require_once('../functions/array.php');
+ require_once(SM_PATH . 'include/load_prefs.php');
/* LSUB array */
$lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
true, $response, $message);
+ $lsub_ary = compact_mailboxes_response($lsub_ary);
+
+ /* Check to see if we have an INBOX */
+ $has_inbox = false;
+
+ for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) {
+ if (preg_match("/^\*\s+LSUB.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) {
+ $lsub_ary[$i] = strtoupper($lsub_ary[$i]);
+ // in case of an unsubscribed inbox an imap server can
+ // return the inbox in the lsub results with a \NoSelect
+ // flag.
+ if (!preg_match("/\*\s+LSUB\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) {
+ $has_inbox = true;
+ } else {
+ // remove the result and request it again with a list
+ // response at a later stage.
+ unset($lsub_ary[$i]);
+ // re-index the array otherwise the addition of the LIST
+ // response will fail in PHP 4.1.2 and probably other older versions
+ $lsub_ary = array_values($lsub_ary);
+ }
+ break;
+ }
+ }
+
+ if ($has_inbox == false) {
+ // do a list request for inbox because we should always show
+ // inbox even if the user isn't subscribed to it.
+ $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" INBOX',
+ true, $response, $message);
+ $inbox_ary = compact_mailboxes_response($inbox_ary);
+ if (count($inbox_ary)) {
+ $lsub_ary[] = $inbox_ary[0];
+ }
+ }
/*
- * Section about removing the last element was removed
+ * Section about removing the last element was removed
* We don't return "* OK" anymore from sqimap_read_data
*/
+
$sorted_lsub_ary = array();
$cnt = count($lsub_ary);
- for ($i=0;$i < $cnt; $i++) {
- /*
- * Workaround for EIMS
- * Doesn't work if the mailbox name is multiple lines
- */
- if (isset($lsub_ary[$i + 1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
- $lsub_ary[$i], $regs)) {
- $i ++;
- $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
- }
+ for ($i = 0; $i < $cnt; $i++) {
+ $mbx = find_mailbox_name($lsub_ary[$i]);
-// if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) {
-// $flag = $regs[1];
-// $mbx = trim($regs[3]);
-// $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
-// }
- $mbx = find_mailbox_name($lsub_ary[$i]);
- if (substr($mbx, -1) == $delimiter) {
- $mbx = substr($mbx, 0, strlen($mbx) - 1);
- }
- $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
- }
- array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
-
- foreach ($sorted_lsub_ary as $mbx) {
- if ($mbx['mbx'] == 'INBOX') {
- $inbox_in_list = true;
- break;
+ // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting
+ if ($imap_server_type != "uw") {
+ $noselect = check_is_noselect($lsub_ary[$i]);
+ $noinferiors = check_is_noinferiors($lsub_ary[$i]);
}
- }
-
- /*
- * Just in case they're not subscribed to their inbox,
- * we'll get it for them anyway
- */
- if (!$inbox_in_list) {
- $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
- true, $response, $message);
- /* Another workaround for EIMS */
- if (isset($inbox_ary[1]) &&
- ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
- $inbox_ary[0], $regs)) {
- $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
- '"' . $regs[2];
+ if (substr($mbx, -1) == $delimiter) {
+ $mbx = substr($mbx, 0, strlen($mbx) - 1);
}
- $mbx = find_mailbox_name($inbox_ary[0]);
- if (substr($mbx, -1) == $delimiter) {
- $mbx = substr($mbx, 0, strlen($mbx) - 1);
- }
- if ( $mbx == 'INBOX') {
- $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
- sqimap_subscribe($imap_stream, 'INBOX');
- }
-
-// if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) {
-// $flag = $regs[1];
-// $mbx = trim($regs[3]);
-// if (substr($mbx, -1) == $delimiter) {
-// $mbx = substr($mbx, 0, strlen($mbx) - 1);
-// }
-// $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
-// }
- }
- $cnt = count($sorted_lsub_ary);
- for ($i=0 ; $i < $cnt; $i++) {
- $mbx = $sorted_lsub_ary[$i]['mbx'];
- if (($unseen_notify == 2 && $mbx == 'INBOX')
- || $unseen_notify == 3
- || ($move_to_trash && ($mbx == $trash_folder))) {
- $sorted_lsub_ary[$i]['unseen'] = sqimap_unseen_messages($imap_stream, $mbx);
- if ($unseen_type == 2 || ($move_to_trash
- && ($mbx == $trash_folder) )) {
- $sorted_lsub_ary[$i]['nummessages'] = sqimap_get_num_messages($imap_stream, $mbx);
- }
- if ($mbx == $trash_folder) {
- $sorted_lsub_ary[$i]['nummessages'] = sqimap_get_num_messages($imap_stream, $mbx);
- }
- }
- }
- $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary);
- return $boxesnew;
+ $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
+ }
+ // FIX ME this requires a config setting inside conf.pl instead of checking on server type
+ if ($imap_server_type == "uw") {
+ $aQuery = array();
+ $aTag = array();
+ // prepare an array with queries
+ foreach ($sorted_lsub_ary as $aMbx) {
+ $mbx = stripslashes($aMbx['mbx']);
+ sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false);
+ $aTag[$tag] = $mbx;
+ }
+ $sorted_lsub_ary = array();
+ // execute all the queries at once
+ $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
+ foreach($aTag as $tag => $mbx) {
+ if ($aServerResponse[$tag] == 'OK') {
+ $sResponse = implode('', $aResponse[$tag]);
+ $noselect = check_is_noselect($sResponse);
+ $noinferiors = check_is_noinferiors($sResponse);
+ $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
+ }
+ }
+ $cnt = count($sorted_lsub_ary);
+ }
+ $sorted_lsub_ary = array_values($sorted_lsub_ary);
+ array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
+ $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
+ return $boxesnew;
}
}
-
-function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) {
+function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
global $data_dir, $username, $list_special_folders_first,
$folder_prefix, $trash_folder, $sent_folder, $draft_folder,
$move_to_trash, $move_to_sent, $save_as_draft,
- $delimiter;
+ $delimiter, $imap_server_type;
$special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
-
+
/* create virtual root node */
$mailboxes= new mailboxes();
$mailboxes->is_root = true;
- $trail_del = false;
- if (isset($folder_prefix) && $folder_prefix != '') {
- $start = substr_count($folder_prefix,$delimiter);
- if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
- $trail_del = true;
- $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
- } else {
- $mailboxes->mailboxname_full = $folder_prefix;
- $start++;
- }
- $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
- } else $start = 0;
+ $trail_del = false;
+ $start = 0;
+
+
+ if (isset($folder_prefix) && ($folder_prefix != '')) {
+ $start = substr_count($folder_prefix,$delimiter);
+ if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
+ $trail_del = true;
+ $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
+ } else {
+ $mailboxes->mailboxname_full = $folder_prefix;
+ $start++;
+ }
+ $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
+ } else {
+ $start = 0;
+ }
+
$cnt = count($mbx_ary);
for ($i=0; $i < $cnt; $i++) {
- if ($mbx_ary[$i]['mbx'] !='' ) {
- $mbx = new mailboxes();
- $mailbox = $mbx_ary[$i]['mbx'];
- switch ($mailbox) {
- case 'INBOX':
- $mbx->is_inbox = true;
- $mbx->is_special = true;
- break;
- case $trash_folder:
- $mbx->is_trash = true;
- $mbx->is_special = true;
- break;
- case $sent_folder:
- $mbx->is_sent = true;
- $mbx->is_special = true;
- break;
- case $draft_folder:
- $mbx->is_draft = true;
- $mbx->is_special = true;
- break;
- }
-
- if (isset($mbx_ary[$i]['unseen'])) {
- $mbx->unseen = $mbx_ary[$i]['unseen'];
- }
- if (isset($mbx_ary[$i]['nummessages'])) {
- $mbx->total = $mbx_ary[$i]['nummessages'];
- }
-
+ if ($mbx_ary[$i]['mbx'] !='' ) {
+ $mbx = new mailboxes();
+ $mailbox = $mbx_ary[$i]['mbx'];
+
+ /*
+ sent subfolders messes up using existing code as subfolders
+ were marked, but the parents were ordered somewhere else in
+ the list, despite having "special folders at top" option set.
+ Need a better method than this.
+ */
+/*
+ if ($mailbox == 'INBOX') {
+ $mbx->is_special = true;
+ } elseif (stristr($trash_folder , $mailbox)) {
+ $mbx->is_special = true;
+ } elseif (stristr($sent_folder , $mailbox)) {
+ $mbx->is_special = true;
+ } elseif (stristr($draft_folder , $mailbox)) {
+ $mbx->is_special = true;
+ }
+
+ switch ($mailbox) {
+ case 'INBOX':
+ $mbx->is_inbox = true;
+ $mbx->is_special = true;
+ $mbx_ary[$i]['noselect'] = false;
+ break;
+ case $trash_folder:
+ $mbx->is_trash = true;
+ $mbx->is_special = true;
+ break;
+ case $sent_folder:
+ $mbx->is_sent = true;
+ $mbx->is_special = true;
+ break;
+ case $draft_folder:
+ $mbx->is_draft = true;
+ $mbx->is_special = true;
+ break;
+ }
+*/
+ $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX'));
+ $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox));
+ $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox));
+ $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox));
+ if (!$mbx->is_special)
+ $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1);
+
+ if (isset($mbx_ary[$i]['unseen'])) {
+ $mbx->unseen = $mbx_ary[$i]['unseen'];
+ }
+ if (isset($mbx_ary[$i]['nummessages'])) {
+ $mbx->total = $mbx_ary[$i]['nummessages'];
+ }
+
+ $mbx->is_noselect = $mbx_ary[$i]['noselect'];
+ $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors'];
+
$r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
- if ($r_del_pos) {
- $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
- } else { /* mailbox is root folder */
- $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
- }
- $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
- $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
- }
- }
+ if ($r_del_pos) {
+ $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
+ } else { /* mailbox is root folder */
+ $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
+ }
+ $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
+ $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
+ }
+ }
+ sqimap_utf7_decode_mbx_tree($mailboxes);
+ sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
return $mailboxes;
}
+function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
+ if (strtoupper($mbx_tree->mailboxname_full) == 'INBOX')
+ $mbx_tree->mailboxname_sub = _("INBOX");
+ else
+ $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub);
+ if ($mbx_tree->mbxs) {
+ $iCnt = count($mbx_tree->mbxs);
+ for ($i=0;$i<$iCnt;++$i) {
+ $mbxs_tree->mbxs[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]);
+ }
+ }
+}
+
+
+function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
+ if ($mbx_tree)
+ $aMbxs[] =& $mbx_tree;
+ if ($mbx_tree->mbxs) {
+ $iCnt = count($mbx_tree->mbxs);
+ for ($i=0;$i<$iCnt;++$i) {
+ sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs);
+ }
+ }
+}
+
+function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
+ global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
+ $aMbxs = $aQuery = $aTag = array();
+ sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
+ // remove the root node
+ array_shift($aMbxs);
+
+ if($unseen_notify == 3) {
+ $cnt = count($aMbxs);
+ for($i=0;$i<$cnt;++$i) {
+ $oMbx =& $aMbxs[$i];
+ if (!$oMbx->is_noselect) {
+ $mbx = $oMbx->mailboxname_full;
+ if ($unseen_type == 2 ||
+ ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
+ $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)';
+ } else {
+ $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)';
+ }
+ sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
+ } else {
+ $oMbx->unseen = $oMbx->total = false;
+ $tag = false;
+ }
+ $oMbx->tag = $tag;
+ $aMbxs[$i] =& $oMbx;
+ }
+ // execute all the queries at once
+ $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
+ $cnt = count($aMbxs);
+ for($i=0;$i<$cnt;++$i) {
+ $oMbx =& $aMbxs[$i];
+ $tag = $oMbx->tag;
+ if ($tag && $aServerResponse[$tag] == 'OK') {
+ $sResponse = implode('', $aResponse[$tag]);
+ if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
+ $oMbx->unseen = $regs[1];
+ }
+ if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
+ $oMbx->total = $regs[1];
+ }
+ }
+ unset($oMbx->tag);
+ }
+ } else if ($unseen_notify == 2) { // INBOX only
+ $cnt = count($aMbxs);
+ for($i=0;$i<$cnt;++$i) {
+ $oMbx =& $aMbxs[$i];
+ if (strtoupper($oMbx->mailboxname_full) == 'INBOX' ||
+ ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
+ if ($unseen_type == 2 ||
+ ($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) {
+ $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full);
+ $oMbx->unseen = $aStatus['UNSEEN'];
+ $oMbx->total = $aStatus['MESSAGES'];
+ } else {
+ $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full);
+ }
+ $aMbxs[$i] =& $oMbx;
+ if (!$move_to_trash && $trash_folder) {
+ break;
+ } else {
+ // trash comes after INBOX
+ if ($oMbx->mailboxname_full == $trash_folder) {
+ break;
+ }
+ }
+ }
+ }
+ }
+}
?>