X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_messages.php;h=74a2448542e48d22739432351bd13cccfae71f4a;hp=2edf381cbba2ea9501b851a887263d6ccb1e0326;hb=0a496c763fc9c26c8d5915ad64dbf1e9bdba62b3;hpb=544ab9e2beb181d3f788f7532c500af986937ad5

diff --git a/functions/imap_messages.php b/functions/imap_messages.php
index 2edf381c..74a24485 100755
--- a/functions/imap_messages.php
+++ b/functions/imap_messages.php
@@ -1,188 +1,239 @@
 <?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
+ *
+ * This implements functions that manipulate messages
+ * NOTE: Quite a few functions in this file are obsolete
+ *
+ * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @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
+ * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
+ * @return bool If the copy completed without errors
+ */
+function sqimap_msgs_list_copy($imap_stream, $id, $mailbox, $handle_errors = true) {
     $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, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), $handle_errors, $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
+ * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
+ * @param string $source_mailbox (since 1.5.1) name of source mailbox. It is used to
+ *  validate that target mailbox != source mailbox.
+ * @return bool If the move completed without errors
+ */
+function sqimap_msgs_list_move($imap_stream, $id, $mailbox, $handle_errors = true, $source_mailbox = false) {
+    if ($source_mailbox!==false && $source_mailbox==$mailbox) {
+        return false;
+    }
     $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, $handle_errors)) {
+        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 (since 1.5.0) skip copy to trash
+ * @return array  $aMessageList array with messages containing the new flags and UID @see parseFetch
+ * @since 1.4.0
+ */
+function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) {
+    // FIXME: Remove globals by introducing an associative array with properties as 4th argument as replacement for the $bypass_trash variable.
     global $move_to_trash, $trash_folder;
-    $msgs_id = sqimap_message_list_squisher($id);
     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);
+        /**
+         * turn off internal error handling (fourth argument = false) and
+         * ignore copy to trash errors (allows to delete messages when overquota)
+         */
+        sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder, false);
     }
-    $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, TRUE);
+    return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, 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);
-}
 
-/** @deprecated */
-function sqimap_get_small_header ($imap_stream, $id, $sent) {
-    $res = sqimap_get_small_header_list($imap_stream, $id, $sent);
-    return $res[0];
+    for ($i=0; $i<sizeof($id); $i++) {
+        $aMessageList["$id[$i]"] = array();
+    }
+
+    $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE);
+
+    // parse the fetch response
+    $parseFetchResults=parseFetch($aResponse,$aMessageList);
+
+    // some broken IMAP servers do not return UID elements on UID STORE
+    // if this is the case, then we need to do a UID FETCH
+    $testkey=$id[0];
+    if (!isset($parseFetchResults[$testkey]['UID'])) {
+        $aResponse = sqimap_run_command_list($imap_stream, "FETCH $msgs_id (FLAGS)", $handle_errors, $response, $message, TRUE);
+        $parseFetchResults = parseFetch($aResponse,$aMessageList);
+    }
+
+    return ($parseFetchResults);
 }
 
+
 /**
-* 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;
+ * Sort the message list and crunch to be as small as possible
+ * (overflow could happen, so make it small if possible)
+ * @param array $aUid array with uid's
+ * @return string $s message set string
+ */
+function sqimap_message_list_squisher($aUid) {
+    if( !is_array( $aUid ) ) {
+        return $aUid;
     }
-
-    sort($messages_array, SORT_NUMERIC);
-    $msgs_str = '';
-    while ($messages_array) {
-        $start = array_shift($messages_array);
-        $end = $start;
-        while (isset($messages_array[0]) && $messages_array[0] == $end + 1) {
-            $end = array_shift($messages_array);
-        }
-        if ($msgs_str != '') {
-            $msgs_str .= ',';
-        }
-        $msgs_str .= $start;
-        if ($start != $end) {
-            $msgs_str .= ':' . $end;
+    sort($aUid, SORT_NUMERIC);
+
+    if (count($aUid)) {
+        $s = '';
+        for ($i=0,$iCnt=count($aUid);$i<$iCnt;++$i) {
+            $iStart = $aUid[$i];
+            $iEnd = $iStart;
+            while ($i<($iCnt-1) && $aUid[$i+1] == $iEnd +1) {
+                $iEnd = $aUid[$i+1];
+                ++$i;
+            }
+            if ($s) {
+                $s .= ',';
+            }
+            $s .= $iStart;
+            if ($iStart != $iEnd) {
+                $s .= ':' . $iEnd;
+            }
         }
     }
-    return $msgs_str;
+    return $s;
 }
 
+
 /**
-* 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,$reverse) {
-    global  $default_charset,
-            $sent_folder;
-
-    $id = array();
-    $sort_test = array();
-    $sort_query = '';
+ * 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";
+        // FIXME: sqimap_run_command() should return the parsed data accessible by $aDATA['SORT']
+        // use sqimap_run_command_list() in case of unsolicited responses. If we don't we could loose the SORT response.
+        $aData = sqimap_run_command_list ($imap_stream, $query, false, $response, $message, TRUE);
+        /* fallback to default charset */
+        if ($response == 'NO') {
+            if (strpos($message,'BADCHARSET') !== false ||
+                strpos($message,'character') !== false) {
+                sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
+                $query = "SORT ($sSortField) US-ASCII $search";
+                $aData = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, TRUE);
+            } else {
+                sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
             }
+        } else if ($response == 'BAD') {
+            sqm_trigger_imap_error('SQM_IMAP_NO_SORT',$query, $response, $message);
         }
     }
-    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
-* @return array $aUid sorted uid list
-*/
-function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
+ * Parses a UID list returned on a SORT or SEARCH request
+ * @param array $aData imap response (retrieved from sqimap_run_command_list)
+ * @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) {
+            for ($j=0,$jCnt=count($aData[$i]);$j<$jCnt;++$j) {
+                if (preg_match("/^\* $sCommand (.+)$/", $aData[$i][$j], $aMatch)) {
+                    $aUid += explode(' ', trim($aMatch[1]));
+                }
+            }
+        }
+    }
+    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, false, '*',
+        $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
                                       array($sSortField), array());
     } else {
-        $msgs = sqimap_get_small_header_list($imap_stream, false, '*',
+        $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
                                       array(), array($sSortField));
     }
+
+    // sqimap_get_small_header (see above) returns fields in lower case,
+    // but the code below uses all upper case
+    foreach ($msgs as $k => $v) 
+        if (isset($msgs[$k][strtolower($sSortField)])) 
+            $msgs[$k][strtoupper($sSortField)] = $msgs[$k][strtolower($sSortField)];
+
     $aUid = array();
     $walk = false;
     switch ($sSortField) {
@@ -197,9 +248,9 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
                  $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
                    $addr[SQM_ADDR_PERSONAL] : "";
                  $sEmail = ($addr[SQM_ADDR_HOST]) ?
-                      $addr[SQM_ADDR_HOST] . "@".$addr[SQM_ADDR_HOST] :
+                      $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] :
                       $addr[SQM_ADDR_HOST];
-                 $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
+                 $v[$f] = ($sPersonal) ? decodeHeader($sPersonal, true, false):$sEmail;'),$sSortField);
             $walk = true;
         }
         // nobreak
@@ -207,13 +258,13 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
         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);
+                 $v[$f] = strtolower(decodeHeader(trim($v[$f]), true, false));
+                 $v[$f] = (preg_match("/^(?:(?:vedr|sv|re|aw|fw|fwd|\[\w\]):\s*)*\s*(.*)$/si", $v[$f], $matches)) ?
+                                    $matches[1] : $v[$f];'),$sSortField);
             $walk = true;
         }
         foreach ($msgs as $item) {
-            $aUid[$item['ID']] = $item[$sSortField];
+            $aUid[$item['UID']] = $item[$sSortField];
         }
         natcasesort($aUid);
         $aUid = array_keys($aUid);
@@ -235,11 +286,11 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
       case 'RFC822.SIZE':
         if(!$walk) {
             // redefine $sSortField to maintain the same namespace between
-            // server-side sorting and squirrelmail sorting
+            // server-side sorting and SquirrelMail sorting
             $sSortField = 'SIZE';
         }
         foreach ($msgs as $item) {
-            $aUid[$item['ID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0;
+            $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0;
         }
         if ($reverse) {
             arsort($aUid,SORT_NUMERIC);
@@ -257,15 +308,71 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
 }
 
 /**
-* Returns an indent array for printMessageinfo()
-* This represents the amount of indent needed (value),
-* for this message number (key)
-*/
+ * Returns an array with each element as a string representing one
+ * message-thread as returned by the IMAP server.
+ * @param resource $imap_stream IMAP socket connection
+ * @param string $search optional search string
+ * @return array
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
+ */
+function get_thread_sort($imap_stream, $search='ALL') {
+    global $sort_by_ref, $default_charset;
+
+    if ($sort_by_ref == 1) {
+        $sort_type = 'REFERENCES';
+    } else {
+        $sort_type = 'ORDEREDSUBJECT';
+    }
+    $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
+
+    // TODO use sqimap_run_command_list as we do in get_server_sort()
+    $sRead = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
+
+    /* fallback to default charset */
+    if ($response == 'NO') {
+        if (strpos($message,'BADCHARSET') !== false ||
+            strpos($message,'character') !== false) {
+            sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
+            $query = "THREAD $sort_type US-ASCII $search";
+            $sRead = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
+        } else {
+            sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
+        }
+    } elseif ($response == 'BAD') {
+        sqm_trigger_imap_error('SQM_IMAP_NO_THREAD',$query, $response, $message);
+    }
+    $sThreadResponse = '';
+    if (isset($sRead[0])) {
+        for ($i=0,$iCnt=count($sRead);$i<$iCnt;++$i) {
+            if (preg_match("/^\* THREAD (.+)$/", $sRead[$i], $aMatch)) {
+                $sThreadResponse = trim($aMatch[1]);
+                break;
+            }
+        }
+    }
+    unset($sRead);
+
+    if ($response !== 'OK') {
+        return false;
+    }
 
+    /* Example response
+     *  S: * THREAD (2)(3 6 (4 23)(44 7 96))
+     * -- 2
+     *
+     * -- 3
+     *    \-- 6
+     *        |-- 4
+     *        |   \-- 23
+     *        |
+     *        \-- 44
+     *             \-- 7
+     *                 \-- 96
+     */
 /*
  * Notes for future work:
  * indent_array should contain: indent_level, parent and flags,
- * sibling notes ..
+ * sibling nodes ..
  * To achieve that we  need to define the following flags:
  * 0: hasnochildren
  * 1: haschildren
@@ -282,190 +389,68 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
  *   \-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
-     */
-    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();
-    }
-    /* looping through the parts of one message thread */
-
-    for ($i=0;$i<count($thread_new);$i++) {
-        /* first grab the parent, it does not indent */
-
-        if (isset($thread_new[$i][0])) {
-            if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
-                $parent = $regs[1];
-            }
-        }
-        $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
-         */
-        $level = 0;
-        $spaces = array();
-        $spaces_total = 0;
-        $indent = 0;
-        $fake = FALSE;
-        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 += $chars['40'];
-            }
-            if (isset($chars['41'])) {      /* testing for ) */
-                $level -= $chars['41'];
-                $spaces[$level] = 0;
-                /* if we were faking lets stop, this portion
-                 * of the thread is over
-                 */
-                if ($level == $cutoff) {
-                    $fake = FALSE;
-                }
-            }
-            if (isset($chars['32'])) {      /* testing for space */
-                if (!isset($spaces[$level])) {
-                    $spaces[$level] = 0;
-                }
-                $spaces[$level] += $chars['32'];
-            }
-            for ($x=0;$x<=$level;$x++) {
-                if (isset($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
-             */
-            if ($fake == TRUE) {
-                $indent = $indent +1;
-            }
-            if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) {
-                $child = $regs[1];
-            }
-            /* the thread must be broken if $indent == 0
-             * 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] = ($indent < 0) ? 0 : $indent;
-            $spaces_total = 0;
-        }
-    }
-    return $indent_array;
-}
-
 
-/**
-* 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) {
-    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 {
-        $sort_type = 'ORDEREDSUBJECT';
-    }
-    $query = "THREAD $sort_type ".strtoupper($default_charset)." ALL";
-    $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;
-            }
-        }
-    } else {
-        $thread_list = "";
-    }
-    if (!preg_match("/OK/", $response)) {
-        $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();
+    $j = 0;
     $k = 0;
-    $thread_new[0] = "";
-    /*
-     * 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_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;
+    $l = 0;
+    $aUidThread = array();
+    $aIndent = array();
+    $aUidSubThread = array();
+    $aDepthStack = array();
+    $sUid = '';
+
+    if ($sThreadResponse) {
+        for ($i=0,$iCnt = strlen($sThreadResponse);$i<$iCnt;++$i) {
+            $cChar = $sThreadResponse{$i};
+            switch ($cChar) {
+                case '(': // new sub thread
+                    // correction for a subthread of a thread with no parents in thread
+                    if (!count($aUidSubThread) && $j > 0) {
+                       --$l;
+                    }
+                    $aDepthStack[$j] = $l;
+                    ++$j;
+                    break;
+                case ')': // close sub thread
+                    if($sUid !== '') {
+                        $aUidSubThread[] = $sUid;
+                        $aIndent[$sUid] = $j + $l - 1;
+                        ++$l;
+                        $sUid = '';
+                    }
+                    --$j;
+                    if ($j === 0) {
+                        // show message that starts the thread first.
+                        $aUidSubThread = array_reverse($aUidSubThread);
+                        // do not use array_merge because it's extremely slow and is causing timeouts
+                        foreach ($aUidSubThread as $iUid) {
+                            $aUidThread[] = $iUid;
+                        }
+                        $aUidSubThread = array();
+                        $l = 0;
+                        $aDepthStack = array();
+                    } else {
+                        $l = $aDepthStack[$j];
+                    }
+                    break;
+                case ' ': // new child
+                    if ($sUid !== '') {
+                        $aUidSubThread[] = $sUid;
+                        $aIndent[$sUid] = $j + $l - 1;
+                        ++$l;
+                        $sUid = '';
+                    }
+                    break;
+                default: // part of UID
+                    $sUid .= $cChar;
+                    break;
             }
         }
     }
-    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);
-    $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
-    $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;
+    unset($sThreadResponse);
+    // show newest threads first
+    $aUidThread = array_reverse($aUidThread);
+    return array($aUidThread,$aIndent);
 }
 
 
@@ -475,7 +460,14 @@ function elapsedTime($start) {
     return $timepassed;
 }
 
-// only used in sqimap_get_small_header_list
+/**
+ * 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 = '';
@@ -484,29 +476,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 = '';
@@ -518,7 +510,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);
@@ -532,17 +531,37 @@ function parseArray($read,&$i) {
     }
 }
 
-function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
+
+/**
+ * Retrieves a list with headers, flags, size or internaldate from the imap server
+ *
+ * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x.
+ * Output format, third argument and $msg_list array format requirements differ.
+ * @param stream $imap_stream imap connection
+ * @param array  $msg_list array with id's to create a msgs set from
+ * @param array  $aHeaderFields (since 1.5.0) requested header fields
+ * @param array  $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE
+ * @return array $aMessages associative array with messages. Key is the UID, value is an associative array
+ * @since 1.1.3
+ */
+function sqimap_get_small_header_list($imap_stream, $msg_list,
     $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
     $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
 
-    $messages = array();
-    $read_list = array();
+    $aMessageList = array();
+
+    /**
+     * Catch other priority headers as well
+     */
+    if (in_array('X-Priority',$aHeaderFields,true)) {
+        $aHeaderFields[] = 'Importance';
+        $aHeaderFields[] = 'Priority';
+    }
 
     $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
@@ -551,15 +570,13 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
         */
         if ($bUidFetch) {
             for ($i = 0; $i < sizeof($msg_list); $i++) {
-                $messages["$msg_list[$i]"] = array();
+                $aMessageList["$msg_list[$i]"] = array();
             }
         }
     } else {
         $msgs_str = '1:*';
     }
 
-
-
     /*
      * Create the query
      */
@@ -574,25 +591,39 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
         $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
     }
     $query .= trim($sFetchItems) . ')';
+    $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
+    $aMessages = parseFetch($aResponse,$aMessageList);
+    array_reverse($aMessages);
+    return $aMessages;
+}
 
-    $read_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
-    $i = 0;
 
-    foreach ($read_list as $r) {
-        $msg = array();
-        // use unset because we do isset below
-        $read = implode('',$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()) {
+    for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) {
+        $aMsg = array();
 
+        $read = implode('',$aResponse[$j]);
+        // free up memmory
+        unset($aResponse[$j]); /* unset does not reindex the array. the for loop is safe */
         /*
             * #id<space>FETCH<space>(
         */
 
         /* extract the message id */
-        $i_space = strpos($read,' ',2);
-        $id = substr($read,2,$i_space-2);
+        $i_space = strpos($read,' ',2);/* position 2ed <space> */
+        $id = substr($read,2/* skip "*<space>" */,$i_space -2);
+        $aMsg['ID'] = $id;
         $fetch = substr($read,$i_space+1,5);
         if (!is_numeric($id) && $fetch !== 'FETCH') {
-            $msg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
+            $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
             break;
         }
         $i = strpos($read,'(',$i_space+5);
@@ -606,6 +637,9 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
             $i = strpos($read,' ');
             $arg = substr($read,0,$i);
             ++$i;
+            /*
+             * use allcaps for imap items and lowcaps for headers as key for the $aMsg array
+             */
             switch ($arg)
             {
             case 'UID':
@@ -628,7 +662,7 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
                     $flag = strtolower($flag);
                     $aFlags[$flag] = true;
                 }
-                $msg['FLAGS'] = $aFlags;
+                $aMsg['FLAGS'] = $aFlags;
                 break;
             case 'RFC822.SIZE':
                 $i_pos = strpos($read,' ',$i);
@@ -636,90 +670,106 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false,
                     $i_pos = strpos($read,')',$i);
                 }
                 if ($i_pos) {
-                    $msg['SIZE'] = substr($read,$i,$i_pos-$i);
+                    $aMsg['SIZE'] = substr($read,$i,$i_pos-$i);
                     $i = $i_pos+1;
                 } else {
                     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
+                // sqimap_parse_address($read,$i,$aMsg);
+                break; // to be implemented, moving imap code out of the Message class
             case 'BODYSTRUCTURE':
-                break;
+                break; // to be implemented, moving imap code out of the Message class
             case 'INTERNALDATE':
-                $msg['INTERNALDATE'] = str_replace('  ', ' ',parseString($read,$i));
+                $aMsg['INTERNALDATE'] = trim(str_replace('  ', ' ',parseString($read,$i)));
                 break;
             case 'BODY.PEEK[HEADER.FIELDS':
             case 'BODY[HEADER.FIELDS':
-                $i = strpos($read,'{',$i);
+                $i = strpos($read,'{',$i); // header is always returned as literal because it contain \n characters
                 $header = parseString($read,$i);
                 if ($header === false) break 2;
                 /* First we replace all \r\n by \n, and unfold the header */
                 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header));
-                /* Now we can make a new header array with */
-                /* each element representing a headerline  */
-                $hdr = explode("\n" , $hdr);
+                /* Now we can make a new header array with
+                   each element representing a headerline  */
+                $aHdr = explode("\n" , $hdr);
                 $aReceived = array();
-                foreach ($hdr as $line) {
+                foreach ($aHdr as $line) {
                     $pos = strpos($line, ':');
                     if ($pos > 0) {
                         $field = strtolower(substr($line, 0, $pos));
                         if (!strstr($field,' ')) { /* valid field */
                             $value = trim(substr($line, $pos+1));
-                            switch($field)
-                            {
-                            case 'to': $msg['TO'] = $value; break;
-                            case 'cc': $msg['CC'] = $value; break;
-                            case 'from': $msg['FROM'] = $value; break;
-                            case 'date':
-                                $msg['DATE'] = str_replace('  ', ' ', $value);
-                                break;
-                            case 'x-priority': $msg['PRIORITY'] = $value; break;
-                            case 'subject': $msg['SUBJECT'] = $value; break;
-                            case 'content-type':
-                                $type = $value;
-                                if ($pos = strpos($type, ";")) {
-                                    $type = substr($type, 0, $pos);
-                                }
-                                $type = explode("/", $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;
+                            switch($field) {
+                                case 'date':
+                                    $aMsg['date'] = trim(str_replace('  ', ' ', $value));
+                                    break;
+                                case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break;
+                                case 'priority':
+                                case 'importance':
+                                    // duplicate code with Rfc822Header.cls:parsePriority()
+                                    if (!isset($aMsg['x-priority'])) {
+                                        $aPrio = preg_split('/\s/',trim($value));
+                                        $sPrio = strtolower(array_shift($aPrio));
+                                        if  (is_numeric($sPrio)) {
+                                            $iPrio = (int) $sPrio;
+                                        } elseif ( $sPrio == 'non-urgent' || $sPrio == 'low' ) {
+                                            $iPrio = 5;
+                                        } elseif ( $sPrio == 'urgent' || $sPrio == 'high' ) {
+                                            $iPrio = 1;
+                                        } else {
+                                            // default is normal priority
+                                            $iPrio = 3;
+                                        }
+                                        $aMsg['x-priority'] = $iPrio;
+                                    }
+                                    break;
+                                case 'content-type':
+                                    $type = $value;
+                                    if ($pos = strpos($type, ";")) {
+                                        $type = substr($type, 0, $pos);
+                                    }
+                                    $type = explode("/", $type);
+                                    if(!is_array($type) || count($type) < 2) {
+                                        $aMsg['content-type'] = array('text','plain');
+                                    } else {
+                                        $aMsg['content-type'] = array(strtolower($type[0]),strtolower($type[1]));
+                                    }
+                                    break;
+                                case 'received':
+                                    $aMsg['received'][] = $value;
+                                    break;
+                                default:
+                                    $aMsg[$field] = $value;
+                                    break;
                             }
                         }
                     }
                 }
-                if (count($aReceived)) {
-                    $msg['RECEIVED'] = $aReceived;
-                }
                 break;
             default:
                 ++$i;
                 break;
             }
         }
-        $msgi ="$unique_id";
-        $msg['ID'] = $unique_id;
-
-        $messages[$msgi] = $msg;
-        ++$msgi;
+        if (!empty($unique_id)) {
+            $msgi = "$unique_id";
+            $aMsg['UID'] = $unique_id;
+       } else {
+            $msgi = '';
+       }
+       $aMessageList[$msgi] = $aMsg;
+       $aResponse[$j] = NULL;
     }
-    array_reverse($messages);
-    return $messages;
+    return $aMessageList;
 }
 
+/**
+ * Work in process
+ * @private
+ * @author Marc Groot Koerkamp
+ */
 function sqimap_parse_envelope($read, &$i, &$msg) {
     $arg_no = 0;
     $arg_a = array();
@@ -781,7 +831,7 @@ function sqimap_parse_envelope($read, &$i, &$msg) {
     if (count($arg_a) > 9) {
         $d = strtr($arg_a[0], array('  ' => ' '));
         $d = explode(' ', $d);
-        if (!$arg_a[1]) $arg_1[1] = '';
+        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        */
@@ -795,6 +845,12 @@ function sqimap_parse_envelope($read, &$i, &$msg) {
     }
 }
 
+
+/**
+ * Work in process
+ * @private
+ * @author Marc Groot Koerkamp
+ */
 function sqimap_parse_address($read, &$i) {
     $arg_a = array();
     for (; $read{$i} != ')'; ++$i) {
@@ -827,38 +883,85 @@ function sqimap_parse_address($read, &$i) {
     return $adr;
 }
 
+
 /**
-* 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) {
+ * 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
+ * @param  int      $hide Indicates whether or not to hide any errors: 0 = don't hide, 1 = hide (just exit), 2 = hide (return FALSE), 3 = hide (return error string) (OPTIONAL; default don't hide)
+ * @return mixed  Message object or FALSE/error string if error occurred and $hide is set to 2/3
+ */
+function sqimap_get_message($imap_stream, $id, $mailbox, $hide=0) {
     // 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])) {
-                $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY');
+                $flags = preg_split('/ /', $regs[1],-1,PREG_SPLIT_NO_EMPTY);
             }
         }
     } else {
+
+        if ($hide == 1) exit;
+        if ($hide == 2) return FALSE;
+
         /* the message was not found, maybe the mailbox was modified? */
-        global $sort, $startMessage, $color;
+        global $sort, $startMessage;
+
+        $errmessage = _("The server couldn't find the message you requested.");
+
+        if ($hide == 3) return $errmessage;
+
+        $errmessage .= '<p>'._("Most probably your message list was out of date and the message has been moved away or deleted (perhaps by another program accessing the same mailbox).");
 
-        $errmessage = _("The server couldn't find the message you requested.") .
-            '<p>'._("Most probably your message list was out of date and the message has been moved away or deleted (perhaps by another program accessing the same mailbox).");
         /* this will include a link back to the message list */
-        error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color);
+        error_message($errmessage, $mailbox, $sort, (int) $startMessage);
         exit;
     }
     $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;
+
+    parse_message_entities($msg, $id, $imap_stream);
     return $msg;
-}
+ }
+
 
-?>
+/**
+ * Recursively parse embedded messages (if any) in the given
+ * message, building correct rfc822 headers for each one
+ *
+ * @param object $msg The message object to scan for attached messages
+ *                    NOTE: this is passed by reference!  Changes made
+ *                    within will affect the caller's copy of $msg!
+ * @param int $id The top-level message UID on the IMAP server, even
+ *                if the $msg being passed in is only an attached entity
+ *                thereof.
+ * @param resource $imap_stream A live connection to the IMAP server.
+ *
+ * @return void
+ *
+ * @since 1.5.2
+ *
+ */
+function parse_message_entities(&$msg, $id, $imap_stream) {
+    if (!empty($msg->entities)) foreach ($msg->entities as $i => $entity) {
+        if (is_object($entity) && strtolower(get_class($entity)) == 'message') {
+            if (!empty($entity->rfc822_header)) {
+                $read = sqimap_run_command($imap_stream, "FETCH $id BODY[". $entity->entity_id .".HEADER]", true, $response, $message, TRUE);
+                $rfc822_header = new Rfc822Header();
+                $rfc822_header->parseHeader($read);
+                $msg->entities[$i]->rfc822_header = $rfc822_header;
+            }
+            parse_message_entities($msg->entities[$i], $id, $imap_stream);
+        }
+    }
+}