X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_messages.php;h=7f4614872f8ba91b1f77810e6df169ec4dae7fca;hp=6364be498914a4480c7593582a0bde714a50e91c;hb=9b935fea59803bf507130c9a520e5c1f235ff672;hpb=ffb776c44cc6478fd310be94cd40b31a1c4d7912

diff --git a/functions/imap_messages.php b/functions/imap_messages.php
index 6364be49..7f461487 100755
--- a/functions/imap_messages.php
+++ b/functions/imap_messages.php
@@ -1,110 +1,102 @@
 <?php
 
 /**
-* imap_messages.php
-*
-* Copyright (c) 1999-2004 The SquirrelMail Project Team
-* Licensed under the GNU GPL. For full terms see the file COPYING.
-*
-* This implements functions that manipulate messages
-* NOTE: Quite a few functions in this file are obsolete
-*
-* @version $Id$
-* @package squirrelmail
-* @subpackage imap
-*/
+ * imap_messages.php
+ *
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * This implements functions that manipulate messages
+ * NOTE: Quite a few functions in this file are obsolete
+ *
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
+ */
 
-/**
-* Copies specified messages to specified folder
-* @param int $imap_stream The resource ID for the IMAP connection
-* @param string $start Beginning of range to copy
-* @param string $end End of the range to copy
-* @param string $mailbox Which box to copy to
-* @deprecated This function is obsolete and should not be used
-*/
-function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) {
-    $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
-}
 
 /**
-* copy a range of messages ($id) to another mailbox ($mailbox)
-* @param int $imap_stream The resource ID for the IMAP socket
-* @param string $id The list of messages to copy
-* @param string $mailbox The destination to copy to
-* @return void
-*/
-function sqimap_msgs_list_copy ($imap_stream, $id, $mailbox) {
+ * Copy a set of messages ($id) to another mailbox ($mailbox)
+ * @param int $imap_stream The resource ID for the IMAP socket
+ * @param string $id The list of messages to copy
+ * @param string $mailbox The destination to copy to
+ * @return bool
+ */
+function sqimap_msgs_list_copy($imap_stream, $id, $mailbox) {
     $msgs_id = sqimap_message_list_squisher($id);
     $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
+    if ($response == 'OK') {
+        return true;
+    } else {
+        return false;
+    }
 }
 
+
 /**
-* move a range of messages ($id) to another mailbox. Deletes the originals.
-* @param int $imap_stream The resource ID for the IMAP socket
-* @param string $id The list of messages to move
-* @param string $mailbox The destination to move to
-* @return void
-*/
-function sqimap_msgs_list_move ($imap_stream, $id, $mailbox) {
+ * Move a set of messages ($id) to another mailbox. Deletes the originals.
+ * @param int $imap_stream The resource ID for the IMAP socket
+ * @param string $id The list of messages to move
+ * @param string $mailbox The destination to move to
+ * @return void
+ */
+function sqimap_msgs_list_move($imap_stream, $id, $mailbox) {
     $msgs_id = sqimap_message_list_squisher($id);
-    $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
-    $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response,$message, TRUE);
+    if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox)) {
+        return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
+    } else {
+        return false;
+    }
 }
 
 
 /**
-* Deletes specified messages and moves them to trash if possible
-* @deprecated This function is obsolete and should no longer be used
-* @param int $imap_steam The resource ID for the IMAP connection
-* @param string $start Start of range
-* @param string $end End of range
-* @param string $mailbox Mailbox messages are being deleted from
-* @return void
-*/
-function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox, $bypass_trash=false) {
-    global $move_to_trash, $trash_folder, $auto_expunge;
-
-    if (($move_to_trash == true) && ($bypass_trash != true) &&
-        (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
-        sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
-    }
-    sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true);
-}
-
-function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=false) {
+ * Deletes a message and move it to trash or expunge the mailbox
+ * @param  resource imap connection
+ * @param  string $mailbox mailbox, used for checking if it concerns the trash_folder
+ * @param  array $id list with uid's
+ * @param  bool   $bypass_trash skip copy to trash
+ * @return array  $aMessageList array with messages containing the new flags and UID @see parseFetch
+ */
+function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) {
+    // FIX ME, remove globals by introducing an associative array with properties
+    // as 4th argument as replacement for the bypass_trash var
     global $move_to_trash, $trash_folder;
-    $msgs_id = sqimap_message_list_squisher($id);
+    $bRes = true;
     if (($move_to_trash == true) && ($bypass_trash != true) &&
         (sqimap_mailbox_exists($imap_stream, $trash_folder) &&  ($mailbox != $trash_folder)) ) {
-        $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($trash_folder), true, $response, $message, TRUE);
+        $bRes = sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder);
+    }
+    if ($bRes) {
+        return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
+    } else {
+        return false;
     }
-    $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, TRUE);
 }
 
 
 /**
-* Sets the specified messages with specified flag
-*/
-function sqimap_messages_flag ($imap_stream, $start, $end, $flag, $handle_errors) {
-    $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE);
-}
-
+ * Set a flag on the provided uid list
+ * @param  resource imap connection
+ * @param  array $id list with uid's
+ * @param  string $flag Flags to set/unset flags can be i.e.'\Seen', '\Answered', '\Seen \Answered'
+ * @param  bool   $set  add (true) or remove (false) the provided flag
+ * @param  bool   $handle_errors Show error messages in case of a NO, BAD or BYE response
+ * @return array  $aMessageList array with messages containing the new flags and UID @see parseFetch
+ */
 function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) {
     $msgs_id = sqimap_message_list_squisher($id);
     $set_string = ($set ? '+' : '-');
-    $read = sqimap_run_command ($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE);
+    $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE);
+    // parse the fetch response
+    return parseFetch($aResponse);
 }
 
-/** @deprecated */
-function sqimap_get_small_header ($imap_stream, $id, $sent) {
-    $res = sqimap_get_small_header_list($imap_stream, $id, $sent);
-    return $res[0];
-}
 
 /**
-* Sort the message list and crunch to be as small as possible
-* (overflow could happen, so make it small if possible)
-*/
+ * Sort the message list and crunch to be as small as possible
+ * (overflow could happen, so make it small if possible)
+ */
 function sqimap_message_list_squisher($messages_array) {
     if( !is_array( $messages_array ) ) {
         return $messages_array;
@@ -129,191 +121,197 @@ function sqimap_message_list_squisher($messages_array) {
     return $msgs_str;
 }
 
+
 /**
-* Retrieves an array with a sorted uid list. Sorting is done on the imap server
-*
-* @param resource $imap_stream IMAP socket connection
-* @param string $sSortField Field to sort on
-* @param bool $reverse Reverse order search
-* @return array $id sorted uid list
-*/
-function sqimap_get_sort_order ($imap_stream, $sSortField = 'UID',$reverse) {
-    global  $default_charset,
-            $sent_folder;
-
-    $id = array();
-    $sort_test = array();
-    $sort_query = '';
-
-    if ($sSortField == 'UID') {
-        $query = "SEARCH UID 1:*";
-        $uids = sqimap_run_command ($imap_stream, $query, true, $response, $message, true);
-        if (isset($uids[0])) {
-            if (preg_match("/^\* SEARCH (.+)$/", $uids[0], $regs)) {
-                $id = preg_split("/ /", trim($regs[1]));
-            }
-        }
-        if (!preg_match("/OK/", $response)) {
-            $id = false;
-        }
-        $id = array_reverse($id);
-        return $id;
-    }
+ * Retrieves an array with a sorted uid list. Sorting is done on the imap server
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt
+ * @param resource $imap_stream IMAP socket connection
+ * @param string $sSortField Field to sort on
+ * @param bool $reverse Reverse order search
+ * @return array $id sorted uid list
+ */
+function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') {
+    global  $default_charset;
+
     if ($sSortField) {
         if ($reverse) {
             $sSortField = 'REVERSE '.$sSortField;
         }
-        $query = "SORT ($sSortField) ".strtoupper($default_charset).' ALL';
-        $sort_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
-    }
-    if (isset($sort_test[0])) {
-        for ($i=0,$iCnt=count($sort_test);$i<$iCnt;++$i) {
-            if (preg_match("/^\* SORT (.+)$/", $sort_test[$i], $regs)) {
-                $id = preg_split("/ /", trim($regs[1]));
-            break;
-            }
+        $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search";
+        // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT']
+        $aData = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
+        /* fallback to default charset */
+        if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
+            $query = "SORT ($sSortField) US-ASCII $search";
+            $aData = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
         }
     }
-    if (!preg_match("/OK/", $response)) {
-        return false;
+
+    if ($response == 'OK') {
+        return parseUidList($aData,'SORT');
     } else {
-        return $id;
+        return false;
     }
 }
 
+
 /**
-* Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
-*
-* @param resource $imap_stream IMAP socket connection
-* @param string $sSortField Field to sort on
-* @param bool $reverse Reverse order search
-* @param mixed $key UNDOCUMENTED
-* @return array $id sorted uid list
-*/
-function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
-
-    if ($sSortField == 'UID') {
-        $query = "SEARCH UID 1:*";
-        $uids = sqimap_run_command ($imap_stream, $query, true, $response, $message, true);
-        if (isset($uids[0])) {
-            if (preg_match("/^\* SEARCH (.+)$/", $uids[0], $regs)) {
-                $msgs = preg_split("/ /", trim($regs[1]));
+ * Parses a UID list returned on a SORT or SEARCH request
+ * @param array $aData imap response
+ * @param string $sCommand issued imap command (SEARCH or SORT)
+ * @return array $aUid uid list
+ */
+function parseUidList($aData,$sCommand) {
+    $aUid = array();
+    if (isset($aData) && count($aData)) {
+        for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) {
+            if (preg_match("/^\* $sCommand (.+)$/", $aData[$i], $aMatch)) {
+                $aUid += preg_split("/ /", trim($aMatch[1]));
             }
         }
-        if (!preg_match("/OK/", $response)) {
-            $msgs = false;
-        }
-    } else if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
-        $msgs = sqimap_get_small_header_list($imap_stream, false, '*',
-                                      array($sSortField), array('UID'));
+    }
+    return array_unique($aUid);
+}
+
+/**
+ * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
+ *
+ * @param resource $imap_stream IMAP socket connection
+ * @param string $sSortField Field to sort on
+ * @param bool $reverse Reverse order search
+ * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:*
+ * @return array $aUid sorted uid list
+ */
+function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) {
+    if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
+        $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
+                                      array($sSortField), array());
     } else {
-        $msgs = sqimap_get_small_header_list($imap_stream, false, '*',
-                                      array(), array('UID', $sSortField));
+        $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
+                                      array(), array($sSortField));
     }
+    $aUid = array();
+    $walk = false;
     switch ($sSortField) {
+      // natcasesort section
       case 'FROM':
-        array_walk($msgs, create_function('&$v,&$k',
-              '$from = parseAddress($v["FROM"]);
-               $v["FROM"] = ($from[0][1]) ? decodeHeader($from[0][1]):$from[0][0];'));
-        foreach ($msgs as $item) {
-            $msort["$item[ID]"] = (isset($item['FROM'])) ? $item['FROM'] : '';
-        }
-
-        natcasesort($msort);
-        $msort = array_keys($msort);
-        if ($reverse) {
-           array_reverse($msort);
-        }
-        break;
       case 'TO':
-        array_walk($msgs, create_function('&$v,&$k',
-              '$from = parseAddress($v["TO"]);
-               $v["TO"] = ($from[0][1]) ? decodeHeader($from[0][1]):$from[0][0];'));
-        foreach ($msgs as $item) {
-            $msort["$item[ID]"] = (isset($item['TO'])) ? $item['TO'] : '';
-        }
-
-        natcasesort($msort);
-        $msort = array_keys($msort);
-        if ($reverse) {
-           array_reverse($msort);
-        }
-        break;
-
+      case 'CC':
+        if(!$walk) {
+            array_walk($msgs, create_function('&$v,&$k,$f',
+                '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+                 $addr = reset(parseRFC822Address($v[$f],1));
+                 $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
+                   $addr[SQM_ADDR_PERSONAL] : "";
+                 $sEmail = ($addr[SQM_ADDR_HOST]) ?
+                      $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] :
+                      $addr[SQM_ADDR_HOST];
+                 $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
+            $walk = true;
+        }
+        // nobreak
       case 'SUBJECT':
-        array_walk($msgs, create_function('&$v,&$k',
-              '$v["SUBJECT"] = strtolower(decodeHeader(trim($v["SUBJECT"])));
-               $v["SUBJECT"] = (preg_match("/^(vedr|sv|re|aw):\s*(.*)$/si", $v["SUBJECT"], $matches)) ?
-                                  $matches[2] : $v["SUBJECT"];'));
+        if(!$walk) {
+            array_walk($msgs, create_function('&$v,&$k,$f',
+                '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+                 $v[$f] = strtolower(decodeHeader(trim($v[$f])));
+                 $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ?
+                                    $matches[2] : $v[$f];'),$sSortField);
+            $walk = true;
+        }
         foreach ($msgs as $item) {
-            $msort["$item[ID]"] = $item['SUBJECT'];
+            $aUid[$item['UID']] = $item[$sSortField];
         }
-        natcasesort($msort);
-        $msort = array_keys($msort);
+        natcasesort($aUid);
+        $aUid = array_keys($aUid);
         if ($reverse) {
-           array_reverse($msort);
+             $aUid = array_reverse($aUid);
         }
         break;
+        //  \natcasesort section
+      // sort_numeric section
       case 'DATE':
-        array_walk($msgs, create_function('&$v,$k',
-            '$v["DATE"] = getTimeStamp(explode(" ",$v["DATE"]));'));
-        foreach ($msgs as $item) {
-            $msort[$item['ID']] = $item['DATE'];
-        }
-        if ($reverse) {
-            arsort($msort,SORT_NUMERIC);
-        } else {
-            asort( $msort, SORT_NUMERIC);
+      case 'INTERNALDATE':
+        if(!$walk) {
+            array_walk($msgs, create_function('&$v,$k,$f',
+                '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+                 $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField);
+            $walk = true;
         }
-        $msort = array_keys($msort);
-        break;
+        // nobreak;
       case 'RFC822.SIZE':
-      case 'INTERNALDATE':
-        //array_walk($msgs, create_function('&$v,$k',
-        //    '$v["RFC822.SIZE"] = getTimeStamp(explode(" ",$v["RFC822.SIZE"]));'));
+        if(!$walk) {
+            // redefine $sSortField to maintain the same namespace between
+            // server-side sorting and SquirrelMail sorting
+            $sSortField = 'SIZE';
+        }
         foreach ($msgs as $item) {
-            $msort[$item['ID']] = $item['SIZE'];
+            $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0;
         }
         if ($reverse) {
-            arsort($msort,SORT_NUMERIC);
+            arsort($aUid,SORT_NUMERIC);
         } else {
-            asort($msort, SORT_NUMERIC);
+            asort($aUid, SORT_NUMERIC);
         }
-        $msort = array_keys($msort);
+        $aUid = array_keys($aUid);
         break;
+        // \sort_numeric section
       case 'UID':
-        $msort = array_reverse($msgs);
+        $aUid = array_reverse($msgs);
         break;
     }
-    return $msort;
+    return $aUid;
 }
 
+
 /**
-* Returns an indent array for printMessageinfo()
-* This represents the amount of indent needed (value),
-* for this message number (key)
-*/
-function get_parent_level ($thread_new) {
+ * Returns an indent array for printMessageinfo()
+ * This represents the amount of indent needed (value),
+ * for this message number (key)
+ */
+
+/*
+ * Notes for future work:
+ * indent_array should contain: indent_level, parent and flags,
+ * sibling notes ..
+ * To achieve that we  need to define the following flags:
+ * 0: hasnochildren
+ * 1: haschildren
+ * 2: is first
+ * 4: is last
+ * a node has sibling nodes if it's not the last node
+ * a node has no sibling nodes if it's the last node
+ * By using binary comparations we can store the flag in one var
+ *
+ * example:
+ * -1      par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren,   isfirst, islast)
+ *  \-2    par = 1, level = 1, flag = 0 + 2     = 2 (hasnochildren, isfirst)
+ *  |-3    par = 1, level = 1, flag = 1 + 4     = 5 (haschildren,   islast)
+ *   \-4   par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren,   isfirst, islast)
+ *     \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
+ */
+function get_parent_level($thread_new) {
     $parent = '';
     $child  = '';
     $cutoff = 0;
 
-    /* loop through the threads and take unwanted characters out
-    of the thread string then chop it up
-    */
+    /*
+     * loop through the threads and take unwanted characters out
+     * of the thread string then chop it up
+     */
     for ($i=0;$i<count($thread_new);$i++) {
         $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
         $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
         $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY);
     }
     $indent_array = array();
-        if (!$thread_new) {
-            $thread_new = array();
-        }
+    if (!$thread_new) {
+        $thread_new = array();
+    }
     /* looping through the parts of one message thread */
 
     for ($i=0;$i<count($thread_new);$i++) {
-    /* first grab the parent, it does not indent */
+        /* first grab the parent, it does not indent */
 
         if (isset($thread_new[$i][0])) {
             if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
@@ -322,26 +320,27 @@ function get_parent_level ($thread_new) {
         }
         $indent_array[$parent] = 0;
 
-    /* now the children, checking each thread portion for
-    ),(, and space, adjusting the level and space values
-    to get the indent level
-    */
+        /*
+         * now the children, checking each thread portion for
+         * ),(, and space, adjusting the level and space values
+         * to get the indent level
+         */
         $level = 0;
         $spaces = array();
         $spaces_total = 0;
         $indent = 0;
         $fake = FALSE;
-        for ($k=1;$k<(count($thread_new[$i]))-1;$k++) {
+        for ($k=1,$iCnt=count($thread_new[$i])-1;$k<$iCnt;++$k) {
             $chars = count_chars($thread_new[$i][$k], 1);
             if (isset($chars['40'])) {       /* testing for ( */
-                $level = $level + $chars['40'];
+                $level += $chars['40'];
             }
             if (isset($chars['41'])) {      /* testing for ) */
-                $level = $level - $chars['41'];
+                $level -= $chars['41'];
                 $spaces[$level] = 0;
                 /* if we were faking lets stop, this portion
-                of the thread is over
-                */
+                 * of the thread is over
+                 */
                 if ($level == $cutoff) {
                     $fake = FALSE;
                 }
@@ -350,17 +349,17 @@ function get_parent_level ($thread_new) {
                 if (!isset($spaces[$level])) {
                     $spaces[$level] = 0;
                 }
-                $spaces[$level] = $spaces[$level] + $chars['32'];
+                $spaces[$level] += $chars['32'];
             }
             for ($x=0;$x<=$level;$x++) {
                 if (isset($spaces[$x])) {
-                    $spaces_total = $spaces_total + $spaces[$x];
+                    $spaces_total += $spaces[$x];
                 }
             }
             $indent = $level + $spaces_total;
             /* must have run into a message that broke the thread
-            so we are adjusting for that portion
-            */
+             * so we are adjusting for that portion
+             */
             if ($fake == TRUE) {
                 $indent = $indent +1;
             }
@@ -368,17 +367,17 @@ function get_parent_level ($thread_new) {
                 $child = $regs[1];
             }
             /* the thread must be broken if $indent == 0
-            so indent the message once and start faking it
-            */
+             * so indent the message once and start faking it
+             */
             if ($indent == 0) {
                 $indent = 1;
                 $fake = TRUE;
                 $cutoff = $level;
             }
             /* dont need abs but if indent was negative
-            errors would occur
-            */
-            $indent_array[$child] = abs($indent);
+             * errors would occur
+             */
+            $indent_array[$child] = ($indent < 0) ? 0 : $indent;
             $spaces_total = 0;
         }
     }
@@ -387,75 +386,81 @@ function get_parent_level ($thread_new) {
 
 
 /**
-* Returns an array with each element as a string representing one
-* message-thread as returned by the IMAP server.
-*/
-function get_thread_sort ($imap_stream) {
+ * Returns an array with each element as a string representing one
+ * message-thread as returned by the IMAP server.
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
+ */
+function get_thread_sort($imap_stream, $search='ALL') {
     global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $indent_array;
-    if (sqsession_is_registered('thread_new')) {
-        sqsession_unregister('thread_new');
-    }
-    if (sqsession_is_registered('indent_array')) {
-        sqsession_unregister('indent_array');
-    }
-    if (sqsession_is_registered('server_sort_array')) {
-        sqsession_unregister('server_sort_array');
-    }
+
     $thread_temp = array ();
     if ($sort_by_ref == 1) {
         $sort_type = 'REFERENCES';
-    }
-    else {
+    } else {
         $sort_type = 'ORDEREDSUBJECT';
     }
-    $query = "THREAD $sort_type ".strtoupper($default_charset)." ALL";
-    $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
+    $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
+
+    $thread_test = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
+    /* fallback to default charset */
+    if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) {
+        $query = "THREAD $sort_type US-ASCII $search";
+        $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
+    }
     if (isset($thread_test[0])) {
         for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++$i) {
-        if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
-            $thread_list = trim($regs[1]);
-        break;
-        }
+            if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
+                $thread_list = trim($regs[1]);
+                break;
+            }
         }
-    }
-    else {
-    $thread_list = "";
+    } else {
+        $thread_list = "";
     }
     if (!preg_match("/OK/", $response)) {
-    $server_sort_array = 'no';
-    return $server_sort_array;
+        $server_sort_array = 'no';
+        return $server_sort_array;
     }
     if (isset($thread_list)) {
         $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
     }
-    $char_count = count($thread_temp);
+
     $counter = 0;
     $thread_new = array();
     $k = 0;
     $thread_new[0] = "";
-    for ($i=0;$i<$char_count;$i++) {
+    /*
+     * parse the thread response into separate threads
+     *
+     * example:
+     *         [0] => (540)
+     *         [1] => (1386)
+     *         [2] => (1599 759 959 37)
+     *         [3] => (492 1787)
+     *         [4] => ((933)(1891))
+     *         [5] => (1030 (1497)(845)(1637))
+     */
+    for ($i=0,$iCnt=count($thread_temp);$i<$iCnt;$i++) {
         if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
-                $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
-        }
-        elseif ($thread_temp[$i] == '(') {
+            $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
+        } elseif ($thread_temp[$i] == '(') {
+            $thread_new[$k] .= $thread_temp[$i];
+            $counter++;
+        } elseif ($thread_temp[$i] == ')') {
+            if ($counter > 1) {
                 $thread_new[$k] .= $thread_temp[$i];
-                $counter++;
-        }
-        elseif ($thread_temp[$i] == ')') {
-                if ($counter > 1) {
-                        $thread_new[$k] .= $thread_temp[$i];
-                        $counter = $counter - 1;
-                }
-                else {
-                        $thread_new[$k] .= $thread_temp[$i];
-                        $k++;
-                        $thread_new[$k] = "";
-                        $counter = $counter - 1;
-                }
+                $counter = $counter - 1;
+            } else {
+                $thread_new[$k] .= $thread_temp[$i];
+                $k++;
+                $thread_new[$k] = "";
+                $counter = $counter - 1;
+            }
         }
     }
-    sqsession_register($thread_new, 'thread_new');
+
     $thread_new = array_reverse($thread_new);
+    /* place the threads after each other in one string */
     $thread_list = implode(" ", $thread_new);
     $thread_list = str_replace("(", " ", $thread_list);
     $thread_list = str_replace(")", " ", $thread_list);
@@ -463,10 +468,7 @@ function get_thread_sort ($imap_stream) {
     $server_sort_array = $thread_list;
 
     $indent_array = get_parent_level ($thread_new);
-    sqsession_register($indent_array, 'indent_array');
-
-    sqsession_register($server_sort_array, 'server_sort_array');
-    return $thread_list;
+    return array($thread_list,$indent_array);
 }
 
 
@@ -476,7 +478,39 @@ function elapsedTime($start) {
     return $timepassed;
 }
 
-// only used in sqimap_get_small_header_list
+
+/**
+ * Normalise the different Priority headers into a uniform value,
+ * namely that of the X-Priority header (1, 3, 5). Supports:
+ * Prioirty, X-Priority, Importance.
+ * X-MS-Mail-Priority is not parsed because it always coincides
+ * with one of the other headers.
+ *
+ * DUPLICATE CODE ALERT:
+ * NOTE: this is actually a duplicate from the function in
+ * class/mime/Rfc822Header.php.
+ */
+function parsePriority($value) {
+    $value = strtolower(array_shift(split('/\w/',trim($value))));
+    if ( is_numeric($value) ) {
+        return $value;
+    }
+    if ( $value == 'urgent' || $value == 'high' ) {
+        return 1;
+    } elseif ( $value == 'non-urgent' || $value == 'low' ) {
+        return 5;
+    }
+    return 3;
+}
+
+/**
+ * Parses a string in an imap response. String starts with " or { which means it
+ * can handle double quoted strings and literal strings
+ *
+ * @param string $read imap response
+ * @param integer $i (reference) offset in string
+ * @return string $s parsed string without the double quotes or literal count
+ */
 function parseString($read,&$i) {
     $char = $read{$i};
     $s = '';
@@ -485,29 +519,29 @@ function parseString($read,&$i) {
         while (true) {
             $iPos = strpos($read,'"',$iPos);
             if (!$iPos) break;
-                if ($iPos && $read{$iPos -1} != '\\') {
-                    $s = substr($read,$i,($iPos-$i));
-                    $i = $iPos;
-                    break;
-                }
-                $iPos++;
-                if ($iPos > strlen($read)) {
-                    break;
-                }
+            if ($iPos && $read{$iPos -1} != '\\') {
+                $s = substr($read,$i,($iPos-$i));
+                $i = $iPos;
+                break;
+            }
+            $iPos++;
+            if ($iPos > strlen($read)) {
+                break;
+            }
         }
     } else if ($char == '{') {
         $lit_cnt = '';
         ++$i;
         $iPos = strpos($read,'}',$i);
         if ($iPos) {
-        $lit_cnt = substr($read, $i, $iPos - $i);
-        $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */
-        /* Now read the literal */
-        $s = ($lit_cnt ? substr($read,$i,$lit_cnt): '');
-        $i += $lit_cnt;
-        /* temp bugfix (SM 1.5 will have a working clean version)
-            too much work to implement that version right now */
-        --$i;
+            $lit_cnt = substr($read, $i, $iPos - $i);
+            $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */
+            /* Now read the literal */
+            $s = ($lit_cnt ? substr($read,$i,$lit_cnt): '');
+            $i += $lit_cnt;
+            /* temp bugfix (SM 1.5 will have a working clean version)
+               too much work to implement that version right now */
+            --$i;
         } else { /* should never happen */
             $i += 3; /* } + \r + \n */
             $s = '';
@@ -519,7 +553,14 @@ function parseString($read,&$i) {
     return $s;
 }
 
-// only used in sqimap_get_small_header_list
+
+/**
+ * Parses a string containing an array from an imap response. String starts with ( and end with )
+ *
+ * @param string $read imap response
+ * @param integer $i (reference) offset in string
+ * @return array $a
+ */
 function parseArray($read,&$i) {
     $i = strpos($read,'(',$i);
     $i_pos = strpos($read,')',$i);
@@ -533,41 +574,44 @@ function parseArray($read,&$i) {
     }
 }
 
-function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
-    $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
-    $aFetchItems = array('FLAGS', 'UID', 'RFC822.SIZE', 'INTERNALDATE')) {
 
-    global $squirrelmail_language, $color, $data_dir, $username, $imap_server_type;
-    global $allow_server_sort;
+/**
+ * Retrieves a list with headers, flags, size or internaldate from the imap server
+ * @param resource $imap_stream imap connection
+ * @param array    $msg_list array with id's to create a msgs set from
+ * @param array    $aHeaderFields requested header fields
+ * @param array    $aFetchItems   requested other fetch items like FLAGS, RFC822.SIZE
+ * @return array   $aMessages associative array with messages. Key is the UID, value is an associative array
+ */
+function sqimap_get_small_header_list($imap_stream, $msg_list,
+    $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Importance', 'Priority', 'Content-Type'),
+    $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
+
+    $aMessageList = array();
 
-    $messages = array();
-    $read_list = array();
+    $bUidFetch = ! in_array('UID', $aFetchItems, true);
 
     /* Get the small headers for each message in $msg_list */
-    if ($show_num != '999999' && $show_num != '*' ) {
+    if ($msg_list !== NULL) {
         $msgs_str = sqimap_message_list_squisher($msg_list);
         /*
         * We need to return the data in the same order as the caller supplied
         * in $msg_list, but IMAP servers are free to return responses in
         * whatever order they wish... So we need to re-sort manually
         */
-        for ($i = 0; $i < sizeof($msg_list); $i++) {
-            $messages["$msg_list[$i]"] = array();
+        if ($bUidFetch) {
+            for ($i = 0; $i < sizeof($msg_list); $i++) {
+                $aMessageList["$msg_list[$i]"] = array();
+            }
         }
     } else {
         $msgs_str = '1:*';
     }
 
-
-
     /*
      * Create the query
      */
 
-    $internaldate = getPref($data_dir, $username, 'internal_date_sort');
-    if (($i = array_search('INTERNALDATE',$aFetchItems,true)) !== false && $internaldate == false) {
-        unset($aFetchItems[$i]);
-    }
     $sFetchItems = '';
     $query = "FETCH $msgs_str (";
     if (count($aFetchItems)) {
@@ -578,29 +622,39 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
         $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
     }
     $query .= trim($sFetchItems) . ')';
-    $read_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, TRUE);
-    $i = 0;
+    $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
+    $aMessages = parseFetch($aResponse,$aMessageList);
+    array_reverse($aMessages);
+    return $aMessages;
+}
+
 
-    foreach ($read_list as $r) {
+/**
+ * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID
+ * @param array    $aResponse Imap response
+ * @param array    $aMessageList Placeholder array for results. The keys of the
+ *                 placeholder array should be the UID so we can reconstruct the order.
+ * @return array   $aMessageList associative array with messages. Key is the UID, value is an associative array
+ * @author Marc Groot Koerkamp
+ */
+function parseFetch($aResponse,$aMessageList = array()) {
+    foreach ($aResponse as $r) {
+        $msg = array();
         // use unset because we do isset below
         $read = implode('',$r);
 
         /*
-            * #id<space>FETCH<space>(
-        */
+         * #id<space>FETCH<space>(
+         */
 
         /* extract the message id */
         $i_space = strpos($read,' ',2);
         $id = substr($read,2,$i_space-2);
+        $msg['ID'] = $id;
         $fetch = substr($read,$i_space+1,5);
         if (!is_numeric($id) && $fetch !== 'FETCH') {
-            set_up_language($squirrelmail_language);
-            echo '<br><b><font color=$color[2]>' .
-                _("ERROR : Could not complete request.") .
-                '</b><br>' .
-                _("Unknown response from IMAP server: ") . ' 1.' .
-                htmlspecialchars($read) . "</font><br>\n";
-                break;
+            $msg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
+            break;
         }
         $i = strpos($read,'(',$i_space+5);
         $read = substr($read,$i+1);
@@ -649,9 +703,15 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
                     break 3;
                 }
 
+                break;
+            case 'ENVELOPE':
+                break; // to be implemented, moving imap code out of the nessages class
+                sqimap_parse_address($read,$i,$msg);
+                break; // to be implemented, moving imap code out of the nessages class
+            case 'BODYSTRUCTURE':
                 break;
             case 'INTERNALDATE':
-                $msg['INTERNALDATE'] = parseString($read,$i);
+                $msg['INTERNALDATE'] = trim(str_replace('  ', ' ',parseString($read,$i)));
                 break;
             case 'BODY.PEEK[HEADER.FIELDS':
             case 'BODY[HEADER.FIELDS':
@@ -663,6 +723,7 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
                 /* Now we can make a new header array with */
                 /* each element representing a headerline  */
                 $hdr = explode("\n" , $hdr);
+                $aReceived = array();
                 foreach ($hdr as $line) {
                     $pos = strpos($line, ':');
                     if ($pos > 0) {
@@ -677,7 +738,10 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
                             case 'date':
                                 $msg['DATE'] = str_replace('  ', ' ', $value);
                                 break;
-                            case 'x-priority': $msg['PRIORITY'] = $value; break;
+                            case 'x-priority':
+                            case 'importance':
+                            case 'priority':
+                                $msg['PRIORITY'] = parsePriority($value); break;
                             case 'subject': $msg['SUBJECT'] = $value; break;
                             case 'content-type':
                                 $type = $value;
@@ -685,16 +749,25 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
                                     $type = substr($type, 0, $pos);
                                 }
                                 $type = explode("/", $type);
-                                if(!is_array($type)) {
+                                if(!is_array($type) || count($type) < 2) {
                                     $msg['TYPE0'] = 'text';
                                     $msg['TYPE1'] = 'plain';
+                                } else {
+                                    $msg['TYPE0'] = strtolower($type[0]);
+                                    $msg['TYPE1'] = strtolower($type[1]);
                                 }
                                 break;
+                            case 'received':
+                                $aReceived[] = $value;
+                                break;
                             default: break;
                             }
                         }
                     }
                 }
+                if (count($aReceived)) {
+                    $msg['RECEIVED'] = $aReceived;
+                }
                 break;
             default:
                 ++$i;
@@ -702,24 +775,148 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
             }
         }
         $msgi ="$unique_id";
-        $msg['ID'] = $unique_id;
+        $msg['UID'] = $unique_id;
 
-        $messages[$msgi] = $msg;
+        $aMessageList[$msgi] = $msg;
         ++$msgi;
     }
-    array_reverse($messages);
-    return $messages;
+    return $aMessageList;
 }
 
+
 /**
-* Returns a message array with all the information about a message.
-* See the documentation folder for more information about this array.
-*/
-function sqimap_get_message ($imap_stream, $id, $mailbox) {
+ * Work in process
+ * @private
+ * @author Marc Groot Koerkamp
+ */
+function sqimap_parse_envelope($read, &$i, &$msg) {
+    $arg_no = 0;
+    $arg_a = array();
+    ++$i;
+    for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) {
+        $char = strtoupper($read{$i});
+        switch ($char) {
+            case '{':
+            case '"':
+                $arg_a[] = parseString($read,$i);
+                ++$arg_no;
+                break;
+            case 'N':
+                /* probably NIL argument */
+                if (strtoupper(substr($read, $i, 3)) == 'NIL') {
+                    $arg_a[] = '';
+                    ++$arg_no;
+                    $i += 2;
+                }
+                break;
+            case '(':
+                /* Address structure (with group support)
+                * Note: Group support is useless on SMTP connections
+                *       because the protocol doesn't support it
+                */
+                $addr_a = array();
+                $group = '';
+                $a=0;
+                for (; $i < $cnt && $read{$i} != ')'; ++$i) {
+                    if ($read{$i} == '(') {
+                        $addr = sqimap_parse_address($read, $i);
+                        if (($addr[3] == '') && ($addr[2] != '')) {
+                            /* start of group */
+                            $group = $addr[2];
+                            $group_addr = $addr;
+                            $j = $a;
+                        } else if ($group && ($addr[3] == '') && ($addr[2] == '')) {
+                        /* end group */
+                            if ($a == ($j+1)) { /* no group members */
+                                $group_addr[4] = $group;
+                                $group_addr[2] = '';
+                                $group_addr[0] = "$group: Undisclosed recipients;";
+                                $addr_a[] = $group_addr;
+                                $group ='';
+                            }
+                        } else {
+                            $addr[4] = $group;
+                            $addr_a[] = $addr;
+                        }
+                        ++$a;
+                    }
+                }
+                $arg_a[] = $addr_a;
+                break;
+            default: break;
+        }
+    }
+
+    if (count($arg_a) > 9) {
+        $d = strtr($arg_a[0], array('  ' => ' '));
+        $d = explode(' ', $d);
+        if (!$arg_a[1]) $arg_a[1] = '';
+        $msg['DATE'] = $d; /* argument 1: date */
+        $msg['SUBJECT'] = $arg_a[1];     /* argument 2: subject */
+        $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : '';     /* argument 3: from        */
+        $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : '';   /* argument 4: sender      */
+        $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : '';  /* argument 5: reply-to    */
+        $msg['TO'] = $arg_a[5];          /* argument 6: to          */
+        $msg['CC'] = $arg_a[6];          /* argument 7: cc          */
+        $msg['BCC'] = $arg_a[7];         /* argument 8: bcc         */
+        $msg['IN-REPLY-TO'] = $arg_a[8];   /* argument 9: in-reply-to */
+        $msg['MESSAGE-ID'] = $arg_a[9];  /* argument 10: message-id */
+    }
+}
+
+
+/**
+ * Work in process
+ * @private
+ * @author Marc Groot Koerkamp
+ */
+function sqimap_parse_address($read, &$i) {
+    $arg_a = array();
+    for (; $read{$i} != ')'; ++$i) {
+        $char = strtoupper($read{$i});
+        switch ($char) {
+            case '{':
+            case '"': $arg_a[] =  parseString($read,$i); break;
+            case 'n':
+            case 'N':
+                if (strtoupper(substr($read, $i, 3)) == 'NIL') {
+                    $arg_a[] = '';
+                    $i += 2;
+                }
+                break;
+            default: break;
+        }
+    }
+
+    if (count($arg_a) == 4) {
+        return $arg_a;
+
+//        $adr = new AddressStructure();
+//        $adr->personal = $arg_a[0];
+//        $adr->adl = $arg_a[1];
+//        $adr->mailbox = $arg_a[2];
+//        $adr->host = $arg_a[3];
+    } else {
+        $adr = '';
+    }
+    return $adr;
+}
+
+
+/**
+ * Returns a message array with all the information about a message.
+ * See the documentation folder for more information about this array.
+ *
+ * @param  resource $imap_stream imap connection
+ * @param  integer  $id uid of the message
+ * @param  string   $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere
+ * @return Message  Message object
+ */
+function sqimap_get_message($imap_stream, $id, $mailbox) {
     // typecast to int to prohibit 1:* msgs sets
     $id = (int) $id;
     $flags = array();
-    $read = sqimap_run_command ($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
+    $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
     if ($read) {
         if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
             if (trim($regs[1])) {
@@ -738,11 +935,52 @@ function sqimap_get_message ($imap_stream, $id, $mailbox) {
     }
     $bodystructure = implode('',$read);
     $msg =  mime_structure($bodystructure,$flags);
-    $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
+    $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
     $rfc822_header = new Rfc822Header();
     $rfc822_header->parseHeader($read);
     $msg->rfc822_header = $rfc822_header;
     return $msg;
 }
 
+
+/**
+ * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_copy instead
+ */
+function sqimap_messages_copy($imap_stream, $start, $end, $mailbox) {
+    $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE);
+}
+
+
+/**
+ * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_delete instead
+ */
+function sqimap_messages_delete($imap_stream, $start, $end, $mailbox, $bypass_trash=false) {
+    global $move_to_trash, $trash_folder;
+
+    if (($move_to_trash == true) && ($bypass_trash != true) &&
+        (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
+        sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder);
+    }
+    sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true);
+}
+
+
+/**
+ * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_toggle_flag instead
+ * Set a flag on the provided uid list
+ * @param  resource imap connection
+ */
+function sqimap_messages_flag($imap_stream, $start, $end, $flag, $handle_errors) {
+    $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE);
+}
+
+
+/**
+ * @deprecated
+ */
+function sqimap_get_small_header($imap_stream, $id, $sent) {
+    $res = sqimap_get_small_header_list($imap_stream, $id, $sent);
+    return $res[0];
+}
+
 ?>