Removed variables that were initialized, but never actually used
[squirrelmail.git] / functions / imap_messages.php
index 5930134d09f5c52770f49529072765ad6ea9d46f..de96678592661fd5836e610c212b5124d0f78021 100755 (executable)
 <?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-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
+ */
 
-/**
-* 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,58 +121,73 @@ 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,$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";
+        // 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
-* @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
+ * @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]));
+            }
+        }
+    }
+    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));
     }
     $aUid = array();
@@ -193,8 +200,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] : "";
-                 $addr = parseAddress($v[$f]);
-                 $v[$f] = ($addr[0][1]) ? decodeHeader($addr[0][1]):$addr[0][0];'),$sSortField);
+                 $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_HOST] . "@".$addr[SQM_ADDR_HOST] :
+                      $addr[SQM_ADDR_HOST];
+                 $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
             $walk = true;
         }
         // nobreak
@@ -208,7 +220,7 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
             $walk = true;
         }
         foreach ($msgs as $item) {
-            $aUid[$item['ID']] = $item[$sSortField];
+            $aUid[$item['UID']] = $item[$sSortField];
         }
         natcasesort($aUid);
         $aUid = array_keys($aUid);
@@ -234,7 +246,7 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
             $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);
@@ -251,11 +263,12 @@ function get_squirrel_sort ($imap_stream, $sSortField, $reverse = false) {
     return $aUid;
 }
 
+
 /**
-* Returns an indent array for printMessageinfo()
-* This represents the amount of indent needed (value),
-* for this message number (key)
-*/
+ * Returns an indent array for printMessageinfo()
+ * This represents the amount of indent needed (value),
+ * for this message number (key)
+ */
 
 /*
  * Notes for future work:
@@ -277,7 +290,7 @@ 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) {
+function get_parent_level($thread_new) {
     $parent = '';
     $child  = '';
     $cutoff = 0;
@@ -373,28 +386,27 @@ 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 {
         $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)) {
@@ -413,7 +425,6 @@ function get_thread_sort ($imap_stream) {
         $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
     }
 
-    $char_count = count($thread_temp);
     $counter = 0;
     $thread_new = array();
     $k = 0;
@@ -431,10 +442,10 @@ function get_thread_sort ($imap_stream) {
      */
     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];
+            $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
         } elseif ($thread_temp[$i] == '(') {
-                $thread_new[$k] .= $thread_temp[$i];
-                $counter++;
+            $thread_new[$k] .= $thread_temp[$i];
+            $counter++;
         } elseif ($thread_temp[$i] == ')') {
             if ($counter > 1) {
                 $thread_new[$k] .= $thread_temp[$i];
@@ -447,7 +458,7 @@ function get_thread_sort ($imap_stream) {
             }
         }
     }
-    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);
@@ -457,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);
 }
 
 
@@ -470,7 +478,15 @@ 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 = '';
@@ -479,29 +495,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 = '';
@@ -513,7 +529,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);
@@ -527,17 +550,25 @@ 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
+ * @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', 'Content-Type'),
     $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
 
-    $messages = array();
-    $read_list = array();
+    $aMessageList = 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
@@ -546,15 +577,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
      */
@@ -569,21 +598,35 @@ 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) {
+/**
+ * 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') {
             $msg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
@@ -705,15 +748,20 @@ 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;
 }
 
+
+/**
+ * Work in process
+ * @private
+ * @author Marc Groot Koerkamp
+ */
 function sqimap_parse_envelope($read, &$i, &$msg) {
     $arg_no = 0;
     $arg_a = array();
@@ -775,7 +823,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        */
@@ -789,6 +837,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) {
@@ -821,15 +875,21 @@ 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
+ * @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])) {
@@ -848,11 +908,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];
+}
+
+?>
\ No newline at end of file