Replacing tabs with spaces, trimming white space at EOL and newline at EOF
[squirrelmail.git] / functions / mailbox_display.php
index fd0e495507216082a4bb7a027133e21c8238600e..eef07effad46f20f1e2c8dfb0dda56782df4aea6 100644 (file)
@@ -1,17 +1,17 @@
 <?php
 
 /**
-* mailbox_display.php
-*
-* Copyright (c) 1999-2004 The SquirrelMail Project Team
-* Licensed under the GNU GPL. For full terms see the file COPYING.
-*
-* This contains functions that display mailbox information, such as the
-* table row that has sender, date, subject, etc...
-*
-* @version $Id$
-* @package squirrelmail
-*/
+ * mailbox_display.php
+ *
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * This contains functions that display mailbox information, such as the
+ * table row that has sender, date, subject, etc...
+ *
+ * @version $Id$
+ * @package squirrelmail
+ */
 
 /** The standard includes.. */
 require_once(SM_PATH . 'functions/strings.php');
@@ -19,14 +19,23 @@ require_once(SM_PATH . 'functions/html.php');
 require_once(SM_PATH . 'class/html.class.php');
 require_once(SM_PATH . 'functions/imap_mailbox.php');
 require_once(SM_PATH . 'functions/imap_messages.php');
+require_once(SM_PATH . 'functions/imap_asearch.php');
 require_once(SM_PATH . 'functions/mime.php');
 require_once(SM_PATH . 'functions/forms.php');
 
 /**
-* default value for page_selector_max
-*/
+ * default value for page_selector_max
+ */
 define('PG_SEL_MAX', 10);
 
+/**
+ * The number of pages to cache msg headers
+ */
+define('SQM_MAX_PAGES_IN_CACHE',5);
+
+/**
+ * Sort constants used for sorting of messages
+ */
 define('SQSORT_NONE',0);
 define('SQSORT_DATE_ASC',1);
 define('SQSORT_DATE_DEC',2);
@@ -42,9 +51,20 @@ define('SQSORT_CC_ASC',11);
 define('SQSORT_CC_DEC',12);
 define('SQSORT_INT_DATE_ASC',13);
 define('SQSORT_INT_DATE_DEC',14);
+
+define('SQSORT_THREAD',32);
+
+
+define('MBX_PREF_SORT',0);
+define('MBX_PREF_LIMIT',1);
+define('MBX_PREF_AUTO_EXPUNGE',2);
+define('MBX_PREF_INTERNALDATE',3);
+define('SQM_MAX_MBX_IN_CACHE',3);
+// define('MBX_PREF_FUTURE',unique integer key);
+
 /**
-* @param mixed $start UNDOCUMENTED
-*/
+ * @param mixed $start UNDOCUMENTED
+ */
 function elapsed($start) {
 
     $end = microtime();
@@ -60,60 +80,67 @@ function elapsed($start) {
 }
 
 /**
-* Displays message listing
-*
-* @param mixed $t UNDOCUMENTED
-* @param bool $not_last UNDOCUMENTED
-* @param mixed $key UNDOCUMENTED
-* @param string $mailbox mail folder
-* @param mixed $start_msg UNDOCUMENTED
-* @param mixed $where UNDOCUMENTED
-* @param mixed $what UNDOCUMENTED
-*/
-
-function printMessageInfo($t, $last=false, $msg, $mailbox,
-                        $start_msg, $where, $what) {
+ * Displays message header row in messages list
+ *
+ * @param  array $aMsg contains all message related parameters
+ * @return void
+ */
+
+function printMessageInfo($aMsg) {
+    // FIX ME, remove these globals as well by adding an array as argument for the user settings
+    // specificly meant for header display
     global $checkall,
-        $color, $td_str,
+        $color,
         $default_use_priority,
         $message_highlight_list,
         $index_order,
-        $indent_array,         /* indent subject by */
-        $pos,                  /* Search postion (if any)  */
-        $thread_sort_messages, /* thread sorting on/off */
-        $row_count,
-        $truncate_sender,      /* number of characters for From/To field (<= 0 for unchanged) */
+        $truncate_sender,           /* number of characters for From/To field (<= 0 for unchanged) */
         $email_address,
-        $show_recipient_instead,       /* show recipient name instead of default identity */
-        $use_icons,            /* indicates to use icons or text markers */
-        $icon_theme;           /* icons theming */
+        $show_recipient_instead,    /* show recipient name instead of default identity */
+        $use_icons,                 /* indicates to use icons or text markers */
+        $icon_theme;                /* icons theming */
 
     $color_string = $color[4];
 
     // initialisation:
-   $sSubject = (isset($msg['SUBJECT']) && $msg['SUBJECT'] != '') ? $msg['SUBJECT'] : _("(no subject)");
-   $sFrom    = (isset($msg['FROM'])) ? $msg['FROM'] : _("Unknown sender");
-   $sTo      = (isset($msg['TO'])) ? $msg['TO'] : _("Unknown recipient");
-   $sCc      = (isset($msg['CC'])) ? $msg['CC'] : '';
-   $aFlags   = (isset($msg['FLAGS'])) ? $msg['FLAGS'] : array();
-   $iPrio    = (isset($msg['PRIORITY'])) ? $msg['PRIORITY'] : 3;
-   $iSize    = (isset($msg['SIZE'])) ? $msg['SIZE'] : 0;
-   $sType0   = (isset($msg['TYPE0'])) ? $msg['TYPE0'] : 'text';
-   $sType1   = (isset($msg['TYPE1'])) ? $msg['TYPE1'] : 'plain';
-   $sDate    = (isset($msg['DATE'])) ? getDateString(getTimeStamp(explode(' ',$msg['DATE']))) : '';
-   $iId      = (isset($msg['ID'])) ? $msg['ID'] : false;
-
-   sqgetGlobalVar('indent_array',$indent_array,SQ_SESSION);
-   if (!$iId) {
-       return;
-   }
+    $mailbox     = $aMsg['MAILBOX'];
+    $msg         = $aMsg['HEADER'];
+    $t           =  $aMsg['INDX'];
+    $start_msg   = $aMsg['PAGEOFFSET'];
+    $last        = $aMsg['LAST'];
+    if (isset($aMsg['SEARCH']) && count($aMsg['SEARCH']) >1 ) {
+        $where   = $aMsg['SEARCH'][0];
+        $what    = $aMsg['SEARCH'][1];
+    } else {
+        $where = false;
+        $what = false;
+    }
+    $iIndent  = $aMsg['INDENT'];
+
+    $sSubject = (isset($msg['SUBJECT']) && $msg['SUBJECT'] != '') ? $msg['SUBJECT'] : _("(no subject)");
+    $sFrom    = (isset($msg['FROM'])) ? $msg['FROM'] : _("Unknown sender");
+    $sTo      = (isset($msg['TO'])) ? $msg['TO'] : _("Unknown recipient");
+    $sCc      = (isset($msg['CC'])) ? $msg['CC'] : '';
+    $aFlags   = (isset($msg['FLAGS'])) ? $msg['FLAGS'] : array();
+    $iPrio    = (isset($msg['PRIORITY'])) ? $msg['PRIORITY'] : 3;
+    $iSize    = (isset($msg['SIZE'])) ? $msg['SIZE'] : 0;
+
+    // These don't appear to be used... are they safe to remove
+    $sType0   = (isset($msg['TYPE0'])) ? $msg['TYPE0'] : 'text';
+    $sType1   = (isset($msg['TYPE1'])) ? $msg['TYPE1'] : 'plain';
+    if (isset($msg['INTERNALDATE'])) {
+       $sDate = getDateString(getTimeStamp(explode(' ',$msg['INTERNALDATE'])));
+    } else {
+       $sDate = (isset($msg['DATE'])) ? getDateString(getTimeStamp(explode(' ',$msg['DATE']))) : '';
+    }
+    $iId      = (isset($msg['UID'])) ? $msg['UID'] : false;
+
+    if (!$iId) {
+        return;
+    }
 
     if ($GLOBALS['alt_index_colors']) {
-        if (!isset($row_count)) {
-            $row_count = 0;
-        }
-        $row_count++;
-        if ($row_count % 2) {
+        if (!($t % 2)) {
             if (!isset($color[12])) {
                 $color[12] = '#EAEAEA';
             }
@@ -123,18 +150,22 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
 
     $urlMailbox = urlencode($mailbox);
 
+    // FIXME, foldertype should be set in right_main.php
+    // in other words, handle as sent is obsoleted from now.
+    // We replace that by providing an array to aMailbox with the to shown headers
+    // that way we are free to show the user different layouts for different folders
     $bSentFolder = handleAsSent($mailbox);
     if ((!$bSentFolder) && ($show_recipient_instead)) {
         // If the From address is the same as $email_address, then handle as Sent
         $from_array = parseAddress($sFrom, 1);
         if (!isset($email_address)) {
-            global $datadir, $username;
-            $email_address = getPref($datadir, $username, 'email_address');
+            global $data_dir, $username;
+            $email_address = getPref($data_dir, $username, 'email_address');
         }
         $bHandleAsSent = ((isset($from_array[0][0])) && ($from_array[0][0] == $email_address));
-    }
-    else
+    } else {
         $bHandleAsSent = $bSentFolder;
+    }
     // If this is a Sent message, display To address instead of From
     if ($bHandleAsSent) {
         $sFrom = $sTo;
@@ -168,42 +199,51 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
     }
     // If Sent, prefix with To: but only if not Sent folder
     if ($bHandleAsSent ^ $bSentFolder) {
-        $senderName = _("To:") . ' ' . $senderName;
-        $senderAddress = _("To:") . ' ' . $senderAddress;
+        $senderName = _("To") . ': ' . $senderName;
+        $senderAddress = _("To") . ': ' . $senderAddress;
     }
 
-    if ($truncate_sender > 0)
-    $senderName = truncateWithEntities($senderName, $truncate_sender);
-
-    echo html_tag( 'tr','','','','VALIGN="top"') . "\n";
-
-    if (isset($aFlags['\\flagged']) && ($aFlags['\\flagged'] == true)) {
-        $flag = "<font color=\"$color[2]\">";
-        $flag_end = '</font>';
-    } else {
-        $flag = '';
-        $flag_end = '';
+    // this is a column property which can apply to multiple columns. Do not use vars for one column
+    // only. instead we should use something like this:
+    // 1ed column $aMailbox['columns']['SUBJECT'] value: aray with properties ...
+    // 2ed column $aMailbox['columns']['FROM'] value: aray with properties ...
+    //            NB in case of the sentfolder this could be the TO field
+    // properties array example:
+    //      'truncate' => length (0 is no truncate)
+    //      'prefix    => if (x in b then do that )
+    if ($truncate_sender > 0) {
+        $senderName = truncateWithEntities($senderName, $truncate_sender);
     }
-    if (!isset($aFlags['\\seen']) || ($aFlags['\\seen'] == false)) {
-        $bold = '<b>';
-        $bold_end = '</b>';
-    } else {
-        $bold = '';
-        $bold_end = '';
+
+    $flag = $flag_end = $fontstr = $fontstr_end = $italic = $italic_end = '';
+    $bold = '<b>';
+    $bold_end = '</b>';
+
+    foreach ($aFlags as $sFlag => $value) {
+        switch ($sFlag) {
+          case '\\flagged':
+              if ($value) {
+                  $flag = "<font color=\"$color[2]\">";
+                  $flag_end = '</font>';
+              }
+              break;
+          case '\\seen':
+              if ($value) {
+                  $bold = '';
+                  $bold_end = '';
+              }
+              break;
+          case '\\deleted':
+              if ($value) {
+                  $fontstr = "<font color=\"$color[9]\">";
+                  $fontstr_end = '</font>';
+              }
+              break;
+        }
     }
     if ($bHandleAsSent) {
         $italic = '<i>';
         $italic_end = '</i>';
-    } else {
-        $italic = '';
-        $italic_end = '';
-    }
-    if (isset($aFlags['\\deleted']) && $aFlags['\\deleted']) {
-        $fontstr = "<font color=\"$color[9]\">";
-        $fontstr_end = '</font>';
-    } else {
-        $fontstr = '';
-        $fontstr_end = '';
     }
 
     if ($where && $what) {
@@ -211,7 +251,9 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
     } else {
         $searchstr = '';
     }
-
+    /*
+     *  Message highlight code
+     */
     $matches = array('TO' => 'sTo', 'CC' => 'sCc', 'FROM' => 'sFrom', 'SUBJECT' => 'sSubject');
     if (is_array($message_highlight_list) && count($message_highlight_list)) {
         $sTo = parseAddress($sTo);
@@ -251,18 +293,17 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
                 }
             }
         }
-    }
+    } /* end Message highlight code */
 
     if (!isset($hlt_color)) {
         $hlt_color = $color_string;
     }
     $col = 0;
     $sSubject = str_replace('&nbsp;', ' ', decodeHeader($sSubject));
-    if (isset($indent_array[$iId])) {
-        $subject = processSubject($sSubject, $indent_array[$iId]);
-    } else {
-        $subject = processSubject($sSubject, 0);
-    }
+    $subject = processSubject($sSubject, $iIndent);
+
+    echo html_tag( 'tr','','','','valign="top"') . "\n";
+
     if (sizeof($index_order)) {
         foreach ($index_order as $index_order_part) {
             switch ($index_order_part) {
@@ -276,9 +317,9 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
                 if ($senderAddress != $senderName) {
                     $senderAddress = strtr($senderAddress, array_flip(get_html_translation_table(HTML_SPECIALCHARS)));
                     $title = ' title="' . str_replace('"', "''", $senderAddress) . '"';
-                }
-                else
+                } else {
                     $title = '';
+                }
                 echo html_tag( 'td',
                             $italic . $bold . $flag . $fontstr . $senderName .
                             $fontstr_end . $flag_end . $bold_end . $italic_end,
@@ -298,13 +339,11 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
                 break;
             case 4: /* subject */
                 $td_str = $bold;
-                if ($thread_sort_messages == 1) {
-                    if (isset($indent_array[$iId])) {
-                        $td_str .= str_repeat("&nbsp;&nbsp;&nbsp;&nbsp;",$indent_array[$iId]);
-                    }
+                if ($iIndent) {
+                    $td_str .= str_repeat("&nbsp;&nbsp;&nbsp;&nbsp;",$iIndent);
                 }
                 $td_str .= '<a href="read_body.php?mailbox='.$urlMailbox
-                        .  '&amp;passed_id='. $msg["ID"]
+                        .  '&amp;passed_id='. $iId
                         .  '&amp;startMessage='.$start_msg.$searchstr.'"';
                 $td_str .= ' ' .concat_hook_function('subject_link', array($start_msg, $searchstr));
                 if ($subject != $sSubject) {
@@ -370,7 +409,6 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
                                 'nowrap' );
                 }
 
-
                 // plain text message markers
                 //
                 else {
@@ -420,6 +458,7 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
             ++$col;
         }
     }
+    /* html for separationlines between rows */
     if ($last) {
         echo '</tr>'."\n";
     } else {
@@ -428,14 +467,257 @@ function printMessageInfo($t, $last=false, $msg, $mailbox,
     }
 }
 
+
+function setUserPref($username, $pref, $value) {
+    global $data_dir;
+    setPref($data_dir,$username,$pref,$value);
+}
+
+/**
+ * Selects a mailbox for header retrieval.
+ * Cache control for message headers is embedded.
+ *
+ * @param resource $imapConnection imap socket handle
+ * @param string   $mailbox mailbox to select and retrieve message headers from
+ * @param array    $aConfig array with system config settings and incoming vars
+ * @param array    $aProps mailbox specific properties
+ * @return array   $aMailbox mailbox array with all relevant information
+ * @author Marc Groot Koerkamp
+ */
+function sqm_api_mailbox_select($imapConnection,$mailbox,$aConfig,$aProps) {
+    /**
+     * NB: retrieve this from the session before accessing this function
+     * and make sure you write it back at the end of the script after
+     * the aMailbox var is added so that the headers are added to the cache
+     */
+    global $mailbox_cache;
+    /**
+     * In case the properties arrays are empty set the defaults.
+     */
+    // Doesn't appear to be used... safe to remove?
+    $aDefaultMbxPref = array ();
+//                          MBX_PREF_SORT => 0,
+//                          MBX_PREF_LIMIT => 15,
+//                          MBX_PREF_AUTO_EXPUNGE => 0,
+//                          MBX_PREF_INTERNALDATE => 0
+//                           );
+    /* array_merge doesn't work with integers as keys */
+//    foreach ($aDefaultMbxPref as $key => $value) {
+//        if (!isset($aProps[$key])) {
+//            $aProps[$key] = $value;
+//        }
+//    }
+    $aDefaultConfigProps = array(
+//                'allow_thread_sort' => 0,
+                'allow_server_sort' => sqimap_capability($imapConnection,'SORT'),
+//                'charset'           => 'US-ASCII',
+                'user'              => false, /* no pref storage if false */
+                'setindex'          => 0,
+//                'search'            => 'ALL',
+                'max_cache_size'    => SQM_MAX_MBX_IN_CACHE
+                );
+
+    $aConfig = array_merge($aDefaultConfigProps,$aConfig);
+    $iSetIndx = $aConfig['setindex'];
+
+    $aMbxResponse = sqimap_mailbox_select($imapConnection, $mailbox);
+
+    if ($mailbox_cache) {
+        if (isset($mailbox_cache[$mailbox])) {
+            $aCachedMailbox = $mailbox_cache[$mailbox];
+        } else {
+            $aCachedMailbox = false;
+        }
+            /* cleanup cache */
+        if (count($mailbox_cache) > $aConfig['max_cache_size'] -1) {
+            $aTime = array();
+            foreach($mailbox_cache as $cachedmailbox => $aVal) {
+                $aTime[$aVal['TIMESTAMP']] = $cachedmailbox;
+            }
+            if (ksort($aTime,SORT_NUMERIC)) {
+                for ($i=0,$iCnt=count($mailbox_cache);$i<($iCnt-$aConfig['max_cache_size']);++$i) {
+                    $sOldestMbx = array_shift($aTime);
+                    /**
+                     * Remove only the UIDSET and MSG_HEADERS from cache because those can
+                     * contain large amounts of data.
+                     */
+                    if (isset($mailbox_cache[$sOldestMbx]['UIDSET'])) {
+                        $mailbox_cache[$sOldestMbx]['UIDSET']= false;
+                    }
+                    if (isset($mailbox_cache[$sOldestMbx]['MSG_HEADERS'])) {
+                        $mailbox_cache[$sOldestMbx]['MSG_HEADERS'] = false;
+                    }
+                }
+            }
+        }
+
+    } else {
+        $aCachedMailbox = false;
+    }
+
+    /**
+     * Deal with imap servers that do not return the required UIDNEXT or
+     * UIDVALIDITY response
+     * from a SELECT call (since rfc 3501 it's required).
+     */
+    if (!isset($aMbxResponse['UIDNEXT']) || !isset($aMbxResponse['UIDVALIDITY'])) {
+        $aStatus = sqimap_status_messages($imapConnection,$mailbox,
+                                        array('UIDNEXT','UIDVALIDITY'));
+        $aMbxResponse['UIDNEXT'] = $aStatus['UIDNEXT'];
+        $aMbxResponse['UIDVALIDTY'] = $aStatus['UIDVALIDITY'];
+    }
+
+    $aMailbox['UIDSET'][$iSetIndx] = false;
+    $aMailbox['ID'] = false;
+    $aMailbox['SETINDEX'] = $iSetIndx;
+
+    if ($aCachedMailbox) {
+        /**
+         * Validate integrity of cached data
+         */
+        if ($aCachedMailbox['EXISTS'] == $aMbxResponse['EXISTS'] &&
+            $aMbxResponse['EXISTS'] &&
+            $aCachedMailbox['UIDVALIDITY'] == $aMbxResponse['UIDVALIDITY'] &&
+            $aCachedMailbox['UIDNEXT']  == $aMbxResponse['UIDNEXT'] &&
+            isset($aCachedMailbox['SEARCH'][$iSetIndx]) &&
+            (!isset($aConfig['search']) || /* always set search from the searchpage */
+             $aCachedMailbox['SEARCH'][$iSetIndx] == $aConfig['search'])) {
+            if (isset($aCachedMailbox['MSG_HEADERS'])) {
+                $aMailbox['MSG_HEADERS'] = $aCachedMailbox['MSG_HEADERS'];
+            }
+            $aMailbox['ID'] =  $aCachedMailbox['ID'];
+            if (isset($aCachedMailbox['UIDSET'][$iSetIndx]) && $aCachedMailbox['UIDSET'][$iSetIndx]) {
+                if (isset($aProps[MBX_PREF_SORT]) &&  $aProps[MBX_PREF_SORT] != $aCachedMailbox['SORT'] ) {
+                    $newsort = $aProps[MBX_PREF_SORT];
+                    $oldsort = $aCachedMailbox['SORT'];
+                    /**
+                     * If it concerns a reverse sort we do not need to invalidate
+                     * the cached sorted UIDSET, a reverse is sufficient.
+                     */
+                    if ((($newsort % 2) && ($newsort + 1 == $oldsort)) ||
+                        (!($newsort % 2) && ($newsort - 1 == $oldsort))) {
+                        $aMailbox['UIDSET'][$iSetIndx] = array_reverse($aCachedMailbox['UIDSET'][$iSetIndx]);
+                    } else {
+                        $aMailbox['MSG_HEADERS'] = false;
+                        $aMailbox['ID'] = false;
+                    }
+                    // store the new sort value in the mailbox pref
+                    if ($aConfig['user']) {
+                        // FIXME, in ideal situation, we write back the
+                        // prefs at the end of the script
+                        setUserPref($aConfig['user'],"pref_$mailbox",serialize($aProps));
+                    }
+                } else {
+                    $aMailbox['UIDSET'][$iSetIndx] = $aCachedMailbox['UIDSET'][$iSetIndx];
+                }
+            }
+        }
+    }
+    /**
+     * Restore the offset in the paginator if no new offset is provided.
+     */
+    if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['offset']) && $aCachedMailbox['OFFSET']) {
+        $aMailbox['OFFSET'] =  $aCachedMailbox['OFFSET'];
+        $aMailbox['PAGEOFFSET'] =  $aCachedMailbox['PAGEOFFSET'];
+    } else {
+        $aMailbox['OFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] -1 : 0;
+        $aMailbox['PAGEOFFSET'] = (isset($aConfig['offset']) && $aConfig['offset']) ? $aConfig['offset'] : 1;
+    }
+
+    /**
+     * Restore the showall value no new showall value is provided.
+     */
+    if (isset($aMailbox['UIDSET'][$iSetIndx]) && !isset($aConfig['showall']) &&
+        isset($aCachedMailbox['SHOWALL'][$iSetIndx]) && $aCachedMailbox['SHOWALL'][$iSetIndx]) {
+        $aMailbox['SHOWALL'][$iSetIndx] =  $aCachedMailbox['SHOWALL'][$iSetIndx];
+    } else {
+        $aMailbox['SHOWALL'][$iSetIndx] = (isset($aConfig['showall']) && $aConfig['showall']) ? 1 : 0;
+    }
+
+    if (!isset($aProps[MBX_PREF_SORT]) && isset($aCachedMailbox['SORT'])) {
+        $aMailbox['SORT'] = $aCachedMailbox['SORT'];
+    } else {
+        $aMailbox['SORT'] =  (isset($aProps[MBX_PREF_SORT])) ? $aProps[MBX_PREF_SORT] : 0;
+    }
+
+    if (!isset($aProps[MBX_PREF_LIMIT]) && isset($aCachedMailbox['LIMIT'])) {
+        $aMailbox['LIMIT'] = $aCachedMailbox['LIMIT'];
+    } else {
+        $aMailbox['LIMIT'] =  (isset($aProps[MBX_PREF_LIMIT])) ? $aProps[MBX_PREF_LIMIT] : 15;
+    }
+
+    if (!isset($aProps[MBX_PREF_INTERNALDATE]) && isset($aCachedMailbox['INTERNALDATE'])) {
+        $aMailbox['INTERNALDATE'] = $aCachedMailbox['INTERNALDATE'];
+    } else {
+        $aMailbox['INTERNALDATE'] =  (isset($aProps[MBX_PREF_INTERNALDATE])) ? $aProps[MBX_PREF_INTERNALDATE] : false;
+    }
+
+    if (!isset($aProps[MBX_PREF_AUTO_EXPUNGE]) && isset($aCachedMailbox['AUTO_EXPUNGE'])) {
+        $aMailbox['AUTO_EXPUNGE'] = $aCachedMailbox['AUTO_EXPUNGE'];
+    } else {
+        $aMailbox['AUTO_EXPUNGE'] =  (isset($aProps[MBX_PREF_AUTO_EXPUNGE])) ? $aProps[MBX_PREF_AUTO_EXPUNGE] : false;
+    }
+
+    if (!isset($aConfig['allow_thread_sort']) && isset($aCachedMailbox['ALLOW_THREAD'])) {
+        $aMailbox['ALLOW_THREAD'] = $aCachedMailbox['ALLOW_THREAD'];
+    } else {
+        $aMailbox['ALLOW_THREAD'] =  (isset($aConfig['allow_thread_sort'])) ? $aConfig['allow_thread_sort'] : false;
+    }
+
+    if (!isset($aConfig['search']) && isset($aCachedMailbox['SEARCH'][$iSetIndx])) {
+        $aMailbox['SEARCH'][$iSetIndx] = $aCachedMailbox['SEARCH'][$iSetIndx];
+    } else {
+        $aMailbox['SEARCH'][$iSetIndx] =  (isset($aConfig['search'])) ? $aConfig['search'] : 'ALL';
+    }
+
+    if (!isset($aConfig['charset']) && isset($aCachedMailbox['CHARSET'][$iSetIndx])) {
+        $aMailbox['CHARSET'][$iSetIndx] = $aCachedMailbox['CHARSET'][$iSetIndx];
+    } else {
+        $aMailbox['CHARSET'][$iSetIndx] =  (isset($aConfig['charset'])) ? $aConfig['charset'] : 'US-ASCII';
+    }
+
+    $aMailbox['NAME'] = $mailbox;
+    $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
+    $aMailbox['SEEN'] = (isset($aMbxResponse['SEEN'])) ? $aMbxResponse['SEEN'] : $aMbxResponse['EXISTS'];
+    $aMailbox['RECENT'] = (isset($aMbxResponse['RECENT'])) ? $aMbxResponse['RECENT'] : 0;
+    $aMailbox['UIDVALIDITY'] = $aMbxResponse['UIDVALIDITY'];
+    $aMailbox['UIDNEXT'] = $aMbxResponse['UIDNEXT'];
+    $aMailbox['PERMANENTFLAGS'] = $aMbxResponse['PERMANENTFLAGS'];
+    $aMailbox['RIGHTS'] = $aMbxResponse['RIGHTS'];
+
+
+
+    /* decide if we are thread sorting or not */
+    if (!$aMailbox['ALLOW_THREAD']) {
+        if ($aMailbox['SORT'] & SQSORT_THREAD) {
+            $aMailbox['SORT'] -= SQSORT_THREAD;
+        }
+    }
+    if ($aMailbox['SORT'] & SQSORT_THREAD) {
+        $aMailbox['SORT_METHOD'] = 'THREAD';
+        $aMailbox['THREAD_INDENT'] = $aCachedMailbox['THREAD_INDENT'];
+    } else if (isset($aConfig['allow_server_sort']) && $aConfig['allow_server_sort']) {
+        $aMailbox['SORT_METHOD'] = 'SERVER';
+        $aMailbox['THREAD_INDENT'] = false;
+    } else {
+        $aMailbox['SORT_METHOD'] = 'SQUIRREL';
+        $aMailbox['THREAD_INDENT'] = false;
+    }
+
+    /* set a timestamp for cachecontrol */
+    $aMailbox['TIMESTAMP'] = time();
+    return $aMailbox;
+}
+
+
+
 /**
-* Does the $sort $_GET var to field mapping
-*
-* @param int $sort Field to sort on
-* @param bool $bServerSort Server sorting is true
-* @param mixed $key UNDOCUMENTED
-* @return string $sSortField Field tosort on
-*/
+ * Does the $srt $_GET var to field mapping
+ *
+ * @param int $srt Field to sort on
+ * @param bool $bServerSort Server sorting is true
+ * @return string $sSortField Field to sort on
+ */
 function getSortField($sort,$bServerSort) {
     switch($sort) {
         case SQSORT_NONE:
@@ -469,155 +751,301 @@ function getSortField($sort,$bServerSort) {
         case SQSORT_INT_DATE_DEC:
             $sSortField = ($bServerSort) ? 'ARRIVAL' : 'INTERNALDATE';
             break;
-        default: $sSortField = 'DATE';
+        case SQSORT_THREAD:
+            break;
+        default: $sSortField = 'UID';
             break;
+
     }
     return $sSortField;
 }
 
-function get_sorted_msgs_list($imapConnection,$sort,$mode,&$error) {
-    $bDirection = ($sort % 2);
+function get_sorted_msgs_list($imapConnection,&$aMailbox,&$error) {
+    $iSetIndx = (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
+    $bDirection = ($aMailbox['SORT'] % 2);
     $error = false;
-    switch ($mode) {
-      case 'thread':
-        $id = get_thread_sort($imapConnection);
-        if ($id === false) {
+    if (!$aMailbox['SEARCH'][$iSetIndx]) {
+        $aMailbox['SEARCH'][$iSetIndx] = 'ALL';
+    }
+    switch ($aMailbox['SORT_METHOD']) {
+      case 'THREAD':
+        $aRes = get_thread_sort($imapConnection,$aMailbox['SEARCH'][$iSetIndx]);
+        if ($aRes === false) {
             $error = '<b><small><center><font color=red>' .
-                    _("Thread sorting is not supported by your IMAP server.") . '<br />' .
-                    _("Please report this to the system administrator.").
-                    '</center></small></b>';
+                _("Thread sorting is not supported by your IMAP server.") . '<br />' .
+                _("Please contact your system administrator and report this error.") .
+                '</center></small></b>';
+            $aMailbox['SORT'] -= SQSORT_THREAD;
+        } else {
+            $aMailbox['UIDSET'][$iSetIndx] = $aRes[0];
+            $aMailbox['THREAD_INDENT'][$iSetIndx] = $aRes[1];
         }
         break;
-      case 'server_sort':
-        $sSortField = getSortField($sort,true);
-        $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection);
+      case 'SERVER':
+        $sSortField = getSortField($aMailbox['SORT'],true);
+        $id = sqimap_get_sort_order($imapConnection, $sSortField, $bDirection, $aMailbox['SEARCH'][$iSetIndx]);
         if ($id === false) {
             $error =  '<b><small><center><font color=red>' .
-                _( "Server-side sorting is not supported by your IMAP server.") . '<br />' .
-                _("Please report this to the system administrator.").
+                _("Server-side sorting is not supported by your IMAP server.") . '<br />' .
+                _("Please contact your system administrator and report this error.") .
                 '</center></small></b>';
+        } else {
+            $aMailbox['UIDSET'][$iSetIndx] = $id;
         }
         break;
       default:
-        $sSortField = getSortField($sort,false);
-        $id = get_squirrel_sort($imapConnection, $sSortField, $bDirection);
+        $id = NULL;
+        if ($aMailbox['SEARCH'][$iSetIndx] != 'ALL') {
+            $id = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
+        }
+        $sSortField = getSortField($aMailbox['SORT'],false);
+        $aMailbox['UIDSET'][$iSetIndx] = get_squirrel_sort($imapConnection, $sSortField, $bDirection, $id);
         break;
     }
-    return $id;
+    return $error;
 }
 
-/**
-* This function loops through a group of messages in the mailbox
-* and shows them to the user.
-*
-* @param mixed $imapConnection
-* @param string $mailbox mail folder
-* @param mixed $num_msgs
-* @param mixed $start_msg
-* @param mixed $sort
-* @param mixed $color
-* @param mixed $show_num
-* @param mixed $use_cache
-* @param mixed $mode
-*/
-function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs,
-                                $start_msg, $sort, $color, $show_num,
-                                $use_cache, $mode='',$mbxresponse) {
-    global $msgs, $msort, $auto_expunge, $thread_sort_messages,$server_sort_array,
-        $allow_server_sort, $server_sort_order;
-    /* if there's no messages in this folder */
-    if ($mbxresponse['EXISTS'] == 0) {
-        $string = '<b>' . _("THIS FOLDER IS EMPTY") . '</b>';
-        echo '    <table width="100%" cellpadding="1" cellspacing="0" align="center"'.' border="0" bgcolor="'.$color[9].'">';
-        echo '     <tr><td>';
-        echo '       <table width="100%" cellpadding="0" cellspacing="0" align="center" border="0" bgcolor="'.$color[4].'">';
-        echo '        <tr><td><br />';
-        echo '            <table cellpadding="1" cellspacing="5" align="center" border="0">';
-        echo '              <tr>' . html_tag( 'td', $string."\n", 'left')
-                            . '</tr>';
-        echo '            </table>';
-        echo '        <br /></td></tr>';
-        echo '       </table></td></tr>';
-        echo '    </table>';
-        return;
+
+
+
+function fetchMessageHeaders($imapConnection, &$aMailbox) {
+
+    /**
+     * Retrieve the UIDSET.
+     * Setindex is used to be able to store multiple uid sets. That will make it
+     * possible to display the mailbox multiple times in different sort order
+     * or to store serach results separate from normal mailbox view.
+     */
+    $iSetIndx =  (isset($aMailbox['SETINDEX'])) ? $aMailbox['SETINDEX'] : 0;
+
+    $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
+    /**
+     * Adjust the start_msg
+     */
+    $start_msg = $aMailbox['PAGEOFFSET'];
+    if($aMailbox['PAGEOFFSET'] > $aMailbox['EXISTS']) {
+        $start_msg -= $aMailbox['LIMIT'];
+        if($start_msg < 1) {
+            $start_msg = 1;
+        }
     }
 
-    if ($mbxresponse['EXISTS'] > 0) {
-        /* if $start_msg is lower than $num_msgs, we probably deleted all messages
-        * in the last page. We need to re-adjust the start_msg
-        */
 
-        if($start_msg > $num_msgs) {
-            $start_msg -= $show_num;
-            if($start_msg < 1) {
-                $start_msg = 1;
+    if (is_array($aMailbox['UIDSET'])) {
+        $aUid =& $aMailbox['UIDSET'][$iSetIndx];
+    } else {
+        $aUid = false;
+    }
+
+    // initialize the fields we want to retrieve:
+    $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type');
+    $aFetchItems = array('FLAGS', 'RFC822.SIZE');
+
+    // Are we sorting on internaldate then retrieve the internaldate value as well
+    if ($aMailbox['INTERNALDATE']) {
+        $aFetchItems[] = 'INTERNALDATE';
+    }
+
+
+    /**
+     * A uidset with sorted uid's is available. We can use the cache
+     */
+    if (($aMailbox['SORT'] != SQSORT_NONE || $aMailbox['SEARCH'][$iSetIndx] != 'ALL') &&
+         isset($aUid) && $aUid ) {
+
+        // limit the cache to SQM_MAX_PAGES_IN_CACHE
+        if (!$aMailbox['SHOWALL'][$iSetIndx]) {
+            $iMaxMsgs = $iLimit * SQM_MAX_PAGES_IN_CACHE;
+            $iCacheSize = count($aMailbox['MSG_HEADERS']);
+            if ($iCacheSize > $iMaxMsgs) {
+                $iReduce = $iCacheSize - $iMaxMsgs;
+                foreach ($aMailbox['MSG_HEADERS'] as $iUid => $value) {
+                    if ($iReduce) {
+                        unset($aMailbox['MSG_HEADERS'][$iUid]);
+                    } else {
+                        break;
+                    }
+                    --$iReduce;
+                }
             }
         }
 
-        /* This code and the next if() block check for
-        * server-side sorting methods. The $id array is
-        * formatted and $sort is set to 6 to disable
-        * SM internal sorting
-        */
-
-        if ($thread_sort_messages == 1) {
-            $mode = 'thread';
-        } else if ($allow_server_sort == 1) {
-            $mode = 'server_sort';
-        } else {
-            $mode = '';
+        $id_slice = array_slice($aUid,$start_msg-1,$iLimit);
+        /* do some funky cache checks */
+        $aUidCached = array_keys($aMailbox['MSG_HEADERS']);
+        $aUidNotCached = array_values(array_diff($id_slice,$aUidCached));
+        /**
+         * $aUidNotCached contains an array with UID's which need to be fetched to
+         * complete the needed message headers.
+         */
+        if (count($aUidNotCached)) {
+            $aMsgs = sqimap_get_small_header_list($imapConnection,$aUidNotCached,
+                                                    $aHeaderFields,$aFetchItems);
+            // append the msgs to the existend headers
+            $aMailbox['MSG_HEADERS'] += $aMsgs;
         }
 
-        if (isset($mbxresponse['SORT_ARRAY']) && is_array($mbxresponse['SORT_ARRAY'])) {
-            $id = $mbxresponse['SORT_ARRAY'];
-            if (sqsession_is_registered('msgs')) {
-                sqsession_unregister('msgs');
-            }
-            $id_slice = array_slice($id,$start_msg-1, $show_num);
-            if (count($id_slice)) {
-                $msgs = sqimap_get_small_header_list($imapConnection,$id_slice,$show_num);
+    } else {
+        /**
+         * Initialize the sorted UID list and fetch the visible message headers
+         */
+        if ($aMailbox['SORT'] != SQSORT_NONE || $aMailbox['SEARCH'][$iSetIndx] != 'ALL') {//  || $aMailbox['SORT_METHOD'] & SQSORT_THREAD 'THREAD') {
+
+            $error = false;
+            if ($aMailbox['SEARCH'][$iSetIndx] && $aMailbox['SORT'] == 0) {
+                $aUid = sqimap_run_search($imapConnection, $aMailbox['SEARCH'][$iSetIndx], $aMailbox['CHARSET'][$iSetIndx]);
             } else {
-                return false;
+                $error = get_sorted_msgs_list($imapConnection,$aMailbox,$error);
+                $aUid = $aMailbox['UIDSET'][$iSetIndx];
             }
-            sqsession_register($msgs, 'msgs');
-        } else {
-            if (sqsession_is_registered('server_sort_array')) {
-                sqsession_unregister('server_sort_array');
-            }
-            $id = get_sorted_msgs_list($imapConnection,$sort,$mode,$error);
-            if ($id !== false) {
-                sqsession_register($id, 'server_sort_array');
-                $id_slice = array_slice($id,$start_msg-1, $show_num);
+            if ($error === false) {
+                $id_slice = array_slice($aUid,$aMailbox['OFFSET'], $iLimit);
                 if (count($id_slice)) {
-                    $msgs = sqimap_get_small_header_list($imapConnection,$id_slice,$show_num);
+                    $aMailbox['MSG_HEADERS'] = sqimap_get_small_header_list($imapConnection,$id_slice,
+                        $aHeaderFields,$aFetchItems);
                 } else {
                     return false;
                 }
-                sqsession_register($msgs, 'msgs');
+
             } else {
-                echo $error;
-                return false;
+                // FIX ME, format message and fallback to squirrel sort
+                if ($error) {
+                    echo $error;
+                }
+            }
+        } else {
+            // limit the cache to SQM_MAX_PAGES_IN_CACHE
+            if (!$aMailbox['SHOWALL'][$iSetIndx] && isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
+                $iMaxMsgs = $iLimit * SQM_MAX_PAGES_IN_CACHE;
+                $iCacheSize = count($aMailbox['MSG_HEADERS']);
+                if ($iCacheSize > $iMaxMsgs) {
+                    $iReduce = $iCacheSize - $iMaxMsgs;
+                    foreach ($aMailbox['MSG_HEADERS'] as $iUid => $value) {
+                        if ($iReduce) {
+                            $iId = $aMailbox['MSG_HEADERS'][$iUid]['ID'];
+                            unset($aMailbox['MSG_HEADERS'][$iUid]);
+                            unset($aMailbox['ID'][$iId]);
+                        } else {
+                            break;
+                        }
+                        --$iReduce;
+                    }
+                }
             }
 
+            /**
+             * retrieve messages by sequence id's and fetch the UID to retrieve
+             * the UID. for sorted lists this is not needed because a UID FETCH
+             * automaticly add the UID value in fetch results
+             **/
+            $aFetchItems[] = 'UID';
+
+            //create id range
+            $iRangeStart = $aMailbox['EXISTS'] - $aMailbox['OFFSET'];
+            $iRangeEnd   = ($iRangeStart > $iLimit) ?
+                            ($iRangeStart - $iLimit+1):1;
+
+            $id_slice = range($iRangeStart, $iRangeEnd);
+            /**
+             * Non sorted mailbox with cached message headers
+             */
+            if (isset($aMailbox['ID']) && is_array($aMailbox['ID'])) {
+                // the fetched id => uid relation
+                $aId = $aMailbox['ID'];
+                $aIdCached = array();
+                foreach ($aId as $iId => $iUid) {
+                    if (isset($aMailbox['MSG_HEADERS'][$iUid])) {
+                        if ($iId <= $iRangeStart && $iId >= $iRangeEnd) {
+                            $aIdCached[] = $iId;
+                        }
+                    }
+                }
+                $aIdNotCached = array_diff($id_slice,$aIdCached);
+            } else {
+                $aIdNotCached = $id_slice;
+            }
+
+            if (count($aIdNotCached)) {
+                $aMsgs = sqimap_get_small_header_list($imapConnection,$aIdNotCached,
+                    $aHeaderFields,$aFetchItems);
+                // append the msgs to the existend headers
+                if (isset($aMailbox['MSG_HEADERS']) && is_array($aMailbox['MSG_HEADERS'])) {
+                    $aMailbox['MSG_HEADERS'] += $aMsgs;
+                } else {
+                    $aMailbox['MSG_HEADERS'] = $aMsgs;
+                }
+                // update the ID array
+                foreach ($aMsgs as $iUid => $aMsg) {
+                    if (isset($aMsg['ID'])) {
+                        $aMailbox['ID'][$aMsg['ID']] = $iUid;
+                    }
+                }
+            }
+
+            /**
+             * In unsorted state we show newest messages first which means
+             * that the UIDSET which represents the order of the messages
+             * should contain a high to low ordered UID list
+             */
+            $aSortedUidList = array();
+            foreach ($id_slice as $iId) {
+                if (isset($aMailbox['ID'][$iId])) {
+                    $aSortedUidList[] = $aMailbox['ID'][$iId];
+                }
+            }
+            $aMailbox['UIDSET'][$iSetIndx] = $aSortedUidList;
+            $aMailbox['OFFSET'] = 0;
         }
-    } /* if exists > 0 */
+    }
+    return true;
+}
 
-    $res = getEndMessage($start_msg, $show_num, $num_msgs);
-    $start_msg = $res[0];
-    $end_msg   = $res[1];
+/**
+ * This function loops through a group of messages in the mailbox
+ * and shows them to the user.
+ *
+ * @param mixed $imapConnection
+ * @param array $aMailbox associative array with mailbox related vars
+ */
+function showMessagesForMailbox($imapConnection, &$aMailbox) {
+    global $color, $javascript_on, $compact_paginator;
+
+    // to retrieve the internaldate pref: (I know this is not the right place to do that, move up in front
+    // and use a properties array as function argument to provide user preferences
+    global $data_dir, $username;
+
+    if (!fetchMessageHeaders($imapConnection, $aMailbox)) {
+        return false;
+    }
+    $iSetIndx = $aMailbox['SETINDEX'];
+    $iLimit = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $aMailbox['LIMIT'];
+    $iEnd = ($aMailbox['PAGEOFFSET'] + ($iLimit - 1) < $aMailbox['EXISTS']) ?
+             $aMailbox['PAGEOFFSET'] + $iLimit - 1 : $aMailbox['EXISTS'];
 
-    $paginator_str = get_paginator_str($mailbox, $start_msg, $end_msg,
-                                    $num_msgs, $show_num, $sort);
+    $paginator_str = get_paginator_str($aMailbox['NAME'], $aMailbox['PAGEOFFSET'],
+      $aMailbox['EXISTS'], $aMailbox['LIMIT'], $aMailbox['SHOWALL'][$iSetIndx]);
 
-    $msg_cnt_str = get_msgcnt_str($start_msg, $end_msg, $num_msgs);
+    $msg_cnt_str = get_msgcnt_str($aMailbox['PAGEOFFSET'], $iEnd,$aMailbox['EXISTS']);
 
     do_hook('mailbox_index_before');
-?>
+
+    if ($javascript_on && $compact_paginator) {
+        // Insert compact paginator javascript
+        echo "\n<!-- start of compact paginator javascript -->\n"
+            . "<script language=\"JavaScript\">\n"
+            . "function SubmitOnSelect(select, URL)\n"
+            . "{\n"
+            . "   URL += select.options[select.selectedIndex].value;\n"
+            . "   window.location.href = URL;\n"
+            . "}\n"
+            . "</script>\n"
+            . "<!-- end of compact paginator javascript -->\n";
+    } ?>
+
 <table border="0" width="100%" cellpadding="0" cellspacing="0">
 <tr>
     <td>
-    <?php mail_message_listing_beginning($imapConnection, $mbxresponse, $mailbox, $sort,
-                                        $msg_cnt_str, $paginator_str, $start_msg); ?>
+    <?php mail_message_listing_beginning($imapConnection, $aMailbox, $msg_cnt_str, $paginator_str); ?>
     </td>
 </tr>
 <tr><td height="5" bgcolor="<?php echo $color[4]; ?>"></td></tr>
@@ -630,9 +1058,8 @@ function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs,
             <tr>
                 <td>
                 <?php
-                    printHeader($mailbox, $sort, $color, !$thread_sort_messages, $start_msg);
-                    displayMessageArray($imapConnection, $num_msgs, $start_msg,
-                                        $id, $msgs, $mailbox, $sort, $show_num,0,0);
+                    printHeader($aMailbox);
+                    displayMessageArray($imapConnection, $aMailbox);
                 ?>
                 </td>
             </tr>
@@ -640,57 +1067,73 @@ function showMessagesForMailbox($imapConnection, $mailbox, $num_msgs,
         </td>
         </tr>
     </table>
-    <?php
-        mail_message_listing_end($num_msgs, $paginator_str, $msg_cnt_str, $color);
-    ?>
+    </td>
+</tr>
+<tr>
+    <td>
+<?php
+    mail_message_listing_end($aMailbox, $paginator_str, $msg_cnt_str);
+?>
     </td>
 </tr>
 </table>
 <?php
-    //$t = elapsed($start);
-    //echo("elapsed time = $t seconds\n");
-}
 
+}
 
 /**
-* Generic function to convert the msgs array into an HTML table.
-*
-* @param resource $imapConnection
-* @param int $num_msgs total number of messages in the mailbox
-* @param int $start_msg offset in messages to sisplay
-* @param array $msort sorted array which is used to map the index to the unsorted $msgs index
-* @param string $mailbox mail folder name
-* @param int $sort     sort order. 6 means no sorting or server side / thread sort
-* @param array $color
-* @param int $show_num number of messages to show
-* @param mixed $where
-* @param mixed $what
-*/
-
-// fix me:
-// $color not used
-// remove thread stuff
-// remove $msgs global and add it as argument (i hate globals)
-function displayMessageArray($imapConnection, $num_msgs, $start_msg,
-                            $id, $msgs, $mailbox, $sort,
-                            $show_num, $where=0, $what=0) {
-
-    // if client side sorting and no sort we only fetch num_msgs so the start_msg in the $msgs
-    // array must be corrected
-    $i = $start_msg -1;
-
+ * Function to map an uid list with a msg header array by uid
+ * The mapped headers are printed with printMessage
+ * aMailbox parameters contains info about the page we are on, the
+ * used search criteria, the number of messages to show
+ *
+ * @param resource $imapConnection socket handle to imap
+ * @param array    $aMailbox array with required elements MSG_HEADERS, UIDSET, OFFSET, LIMIT
+ * @return void
+ **/
+function displayMessageArray($imapConnection, $aMailbox) {
+    $iSetIndx    = $aMailbox['SETINDEX'];
+    $aId         = $aMailbox['UIDSET'][$iSetIndx];
+    $aHeaders    = $aMailbox['MSG_HEADERS'];
+    $iOffset     = $aMailbox['OFFSET'];
+    $sort        = $aMailbox['SORT'];
+    $iPageOffset = $aMailbox['PAGEOFFSET'];
+    $sMailbox    = $aMailbox['NAME'];
+    $sSearch     = (isset($aMailbox['SEARCH'][$aMailbox['SETINDEX']])) ? $aMailbox['SEARCH'][$aMailbox['SETINDEX']] : false;
+    $aSearch     = ($sSearch) ? array('search.php',$aMailbox['SETINDEX']) : null;
+
+    if ($aMailbox['SORT'] & SQSORT_THREAD) {
+        $aIndentArray =& $aMailbox['THREAD_INDENT'][$aMailbox['SETINDEX']];
+        $bThread = true;
+    } else {
+        $bThread = false;
+    }
     /*
     * Loop through and display the info for each message.
     * ($t is used for the checkbox number)
     */
-
-    $iEnd = $i + $show_num;
-    for ($j=$i,$t=0;$j<$iEnd;++$j) {
-        if (isset($id[$j])) {
-            $last = (isset($id[$j+1]) || $j == $iEnd) ? false : true;
-            $msg = $msgs[$id[$j]];
-            printMessageInfo($t, $last, $msg, $mailbox,
-                                $start_msg, $where, $what);
+    $iEnd = ($aMailbox['SHOWALL'][$iSetIndx]) ? $aMailbox['EXISTS'] : $iOffset + $aMailbox['LIMIT'];
+    for ($i=$iOffset,$t=0;$i<$iEnd;++$i) {
+        if (isset($aId[$i])) {
+            $bLast = ((isset($aId[$i+1]) && isset($aHeaders[$aId[$i+1]]))
+                                 || ($i == $iEnd )) ? false : true;
+            if ($bThread) {
+               $indent = (isset($aIndentArray[$aId[$i]])) ? $aIndentArray[$aId[$i]] : 0;
+            } else {
+               $indent = 0;
+            }
+            $aMsg = array(
+                      'HEADER'     => $aHeaders[$aId[$i]],
+                      'INDX'       => $t,
+                      'OFFSET'     => $iOffset,
+                      'PAGEOFFSET' => $iPageOffset,
+                      'SORT'       => $sort,
+                      'SEARCH'     => $aSearch,
+                      'MAILBOX'    => $sMailbox,
+                      'INDENT'     => $indent,
+                      'LAST'       => $bLast
+                    );
+             printMessageInfo($aMsg);
             ++$t;
         } else {
             break;
@@ -699,34 +1142,24 @@ function displayMessageArray($imapConnection, $num_msgs, $start_msg,
 }
 
 /**
-* Displays the standard message list header.
-*
-* To finish the table, you need to do a "</table></table>";
-*
-* @param mixed $imapConnection
-* @param array $mbxresponse the array with the results of SELECT against the current mailbox
-* @param string $mailbox the current mailbox
-* @param mixed $sort the current sorting method (-1 for no sorting available [searches])
-* @param mixed $msg_cnt_str
-* @param mixed $paginator
-* @param mixed $start_msg
-*/
+ * Displays the standard message list header.
+ *
+ * To finish the table, you need to do a "</table></table>";
+ *
+ * @param resource $imapConnection
+ * @param array    $aMailbox associative array with mailbox related information
+ * @param string   $msg_cnt_str
+ * @param string   $paginator Paginator string
+ */
 function mail_message_listing_beginning ($imapConnection,
-                                        $mbxresponse,
-                                        $mailbox = '', $sort = -1,
-                                        $msg_cnt_str = '',
-                                        $paginator = '&nbsp;',
-                                        $start_msg = 1) {
-    global $color, $auto_expunge, $base_uri, $show_flag_buttons,
-        $allow_server_sort, $server_sort_order,
-        $PHP_SELF, $allow_thread_sort, $thread_sort_messages;
+                                         $aMailbox,
+                                         $msg_cnt_str = '',
+                                         $paginator = '&nbsp;'
+                                        ) {
+    global $color, $show_flag_buttons, $PHP_SELF;
+    global $lastTargetMailbox, $boxes;
 
     $php_self = $PHP_SELF;
-    /* fix for incorrect $PHP_SELF */
-    if (strpos($php_self, 'move_messages.php')) {
-        $php_self = str_replace('move_messages.php', 'right_main.php', $php_self);
-    }
-    $urlMailbox = urlencode($mailbox);
 
     if (preg_match('/^(.+)\?.+$/',$php_self,$regs)) {
         $source_url = $regs[1];
@@ -738,52 +1171,70 @@ function mail_message_listing_beginning ($imapConnection,
         $msg = '';
     }
 
-    if (!strpos($php_self,'?')) {
-        $location = $php_self.'?mailbox=INBOX&amp;startMessage=1';
-    } else {
-        $location = $php_self;
-    }
-
     $moveFields = addHidden('msg', $msg).
-                addHidden('mailbox', $mailbox).
-        addHidden('startMessage', $start_msg).
-        addHidden('location', $location);
+                  addHidden('mailbox', $aMailbox['NAME']).
+                  addHidden('startMessage', $aMailbox['PAGEOFFSET']);
 
     /* build thread sorting links */
-    if ($allow_thread_sort == TRUE) {
-    if ($thread_sort_messages == 1 ) {
-        $set_thread = 2;
-        $thread_name = _("Unthread View");
-    } elseif ($thread_sort_messages == 0) {
-        $set_thread = 1;
-        $thread_name = _("Thread View");
-    }
-    $thread_link_str = '<small>[<a href="' . $source_url . '?sort='
-        . $sort . '&start_messages=1&set_thread=' . $set_thread
-        . '&mailbox=' . urlencode($mailbox) . '">' . $thread_name
-        . '</a>]</small>';
-    }
-    else
+    $sort = $aMailbox['SORT'];
+    if ($aMailbox['ALLOW_THREAD']) {
+        if ($aMailbox['SORT'] & SQSORT_THREAD) {
+            $sort -= SQSORT_THREAD;
+            $thread_name = _("Unthread View");
+        } else {
+            $thread_name = _("Thread View");
+            $sort = $aMailbox['SORT'] + SQSORT_THREAD;
+        }
+        $thread_link_str = '<small>[<a href="' . $source_url . '?srt='
+            . $sort . '&start_messages=1'
+            . '&mailbox=' . urlencode($aMailbox['NAME']) . '">' . $thread_name
+            . '</a>]</small>';
+    } else {
         $thread_link_str ='';
-
+    }
     /*
     * This is the beginning of the message list table.
     * It wraps around all messages
     */
-    $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $mailbox);
+    $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
     $form_name = "FormMsgs" . $safe_name;
 
-    echo '<form name="' . $form_name . '" method="post" action="move_messages.php">' ."\n"
+    echo '<form name="' . $form_name . '" method="post" action="'.$php_self.'">' ."\n"
         . $moveFields;
+
+    $button_str = '';
+    // display flag buttons only if supported
+    if ($show_flag_buttons  &&
+        in_array('\\flagged',$aMailbox['PERMANENTFLAGS'], true) ) {
+        $button_str .= getButton('submit', 'markUnflagged', _("Unflag"));
+        $button_str .= getButton('submit', 'markFlagged',   _("Flag"));
+        $button_str .= "&nbsp;\n";
+    }
+    if (in_array('\\seen',$aMailbox['PERMANENTFLAGS'], true)) {
+        $button_str .= getButton('submit', 'markUnread', _("Unread"));
+        $button_str .= getButton('submit', 'markRead',   _("Read"));
+        $button_str .= "&nbsp;\n";
+    }
+    $button_str .= getButton('submit', 'attache',_("Forward")) .
+                   "&nbsp;\n";
+    if (in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) {
+        $button_str .= getButton('submit', 'delete',_("Delete"));
+        $button_str .= '<input type="checkbox" name="bypass_trash" />' . _("Bypass Trash");
+        $button_str .= "&nbsp;\n";
+    }
+    if (!$aMailbox['AUTO_EXPUNGE'] && $aMailbox['RIGHTS'] != 'READ-ONLY') {
+        $button_str .= getButton('submit', 'expungeButton',_("Expunge"))  .'&nbsp;' . _("mailbox") . "\n";
+        $button_str .= '&nbsp;';
+    }
 ?>
     <table width="100%" cellpadding="1"  cellspacing="0" style="border: 1px solid <?php echo $color[0]; ?>">
         <tr>
         <td>
             <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1"  cellspacing="0">
             <tr>
-                <td align="left"><small><?php echo $paginator . $thread_link_str; ?></small></td>
-                <td align="center"></td>
-                <td align="right"><small><?php echo $msg_cnt_str; ?></small></td>
+                <?php echo html_tag('td', '<small>' . $paginator . $thread_link_str . '</small>', 'left') . "\n"; ?>
+                <?php echo html_tag('td', '', 'center') . "\n"; ?>
+                <?php echo html_tag('td', '<small>' . $msg_cnt_str . '</small>', 'right') . "\n"; ?>
             </tr>
             </table>
         </td>
@@ -792,44 +1243,23 @@ function mail_message_listing_beginning ($imapConnection,
         <td>
             <table border="0" width="100%" cellpadding="1"  cellspacing="0">
             <tr>
-                <td align="left">
-                <small><?php
-
-                    // display flag buttons only if supported
-                    if ($show_flag_buttons && $mbxresponse != NULL &&
-                    array_search('\\flagged',$mbxresponse['PERMANENTFLAGS'], true) !== FALSE) {
-                        echo getButton('SUBMIT', 'markUnflagged',_("Unflag"));
-                        echo getButton('SUBMIT', 'markFlagged',_("Flag"));
-                        echo '&nbsp;';
-                    }
-                    if (array_search('\\seen',$mbxresponse['PERMANENTFLAGS'], true) !== FALSE) {
-                        echo getButton('SUBMIT', 'markUnread',_("Unread"));
-                        echo getButton('SUBMIT', 'markRead',_("Read"));
-                        echo '&nbsp;';
-                    }
-
-                    echo getButton('SUBMIT', 'attache',_("Forward"));
-                    echo '&nbsp;';
-                    if (array_search('\\deleted',$mbxresponse['PERMANENTFLAGS'], true) !== FALSE) {
-                        echo getButton('SUBMIT', 'delete',_("Delete"));
-                        echo '<input type="checkbox" name="bypass_trash" />' . _("Bypass Trash");
-                        echo '&nbsp;';
-                    }
-                    if (!$auto_expunge && $mbxresponse['RIGHTS'] != 'READ-ONLY') {
-                    echo getButton('SUBMIT', 'expungeButton',_("Expunge"))  .'&nbsp;' . _("mailbox") . "\n";
-                    echo '&nbsp;';
-                    }
-                    do_hook('mailbox_display_buttons');
-                ?></small>
+                <?php echo html_tag('td', '', 'left') . "\n"; ?>
+                <small>
+                    <?php echo $button_str; ?>
+                    <?php do_hook('mailbox_display_buttons'); ?>
+                </small>
                 </td>
                 <?php
-                if (array_search('\\deleted',$mbxresponse['PERMANENTFLAGS'], true) !== FALSE) {
-                    echo '<td align="right">
-                <small>';
-                    //echo $thread_link_str;   //previous behaviour
-                    getMbxList($imapConnection);
-                    echo getButton('SUBMIT', 'moveButton',_("Move")) . "\n
-                </small>";
+                if (in_array('\\deleted',$aMailbox['PERMANENTFLAGS'], true)) {
+                ?>
+                <?php echo html_tag('td', '', 'right'); ?>
+                    <small>&nbsp;<tt>
+                        <select name="targetMailbox">
+                            <?php echo sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes); ?>
+                        </select></tt>&nbsp;
+                        <?php echo getButton('submit', 'moveButton',_("Move")); ?>
+                    </small>
+                <?php
                 }
                 ?>
                 </td>
@@ -838,31 +1268,24 @@ function mail_message_listing_beginning ($imapConnection,
         </td>
         </tr>
     </table>
-
 <?php
     do_hook('mailbox_form_before');
-
-    /* if using server sort we highjack the
-    * the $sort var and use $server_sort_order
-    * instead. but here we reset sort for a bit
-    * since its easy
-    */
-    if ($allow_server_sort == TRUE) {
-        $sort = $server_sort_order;
-    }
 }
 
 /**
-* FIXME: Undocumented function
-*
-* @param mixed $num_msgs
-* @param mixed $paginator_str
-* @param mixed $msg_cnt_str
-* @param mixed $color
-*/
-function mail_message_listing_end($num_msgs, $paginator_str, $msg_cnt_str, $color) {
-if ($num_msgs) {
-    /* space between list and footer */
+ * Function to add the last row in a message list, it contains the paginator and info about
+ * the number of messages.
+ *
+ * @param array   $aMailbox associative array with mailbox related information
+ * @param string  $paginator_str Paginator string  [Prev | Next]  [ 1 2 3 ... 91 92 94 ]  [Show all]
+ * @param string  $msg_cnt_str   Message count string Viewing Messages: 21 to 1861 (20 total)
+ */
+function mail_message_listing_end($aMailbox, $paginator_str, $msg_cnt_str) {
+    global $color;
+
+    if ($aMailbox['EXISTS']) {
+        /* space between list and footer */
+
 ?>
 <tr><td height="5" bgcolor="<?php echo $color[4]; ?>" colspan="1"></td></tr>
 <tr>
@@ -872,8 +1295,8 @@ if ($num_msgs) {
         <td>
             <table bgcolor="<?php echo $color[4]; ?>" border="0" width="100%" cellpadding="1"  cellspacing="0">
             <tr>
-                <td align="left"><small><?php echo $paginator_str; ?></small></td>
-                <td align="right"><small><?php echo $msg_cnt_str; ?></small></td>
+                    <?php echo html_tag('td', '<small>' . $paginator_str . '</small>', 'left');  ?>
+                    <?php echo html_tag('td', '<small>' . $msg_cnt_str   . '</small>', 'right'); ?>
             </tr>
             </table>
         </td>
@@ -890,20 +1313,23 @@ if ($num_msgs) {
 }
 
 /**
-* FIXME: Undocumented function
-*
-* @param string $mailbox
-* @param mixed $sort
-* @param mixed $color
-* @param bool $showsort
-* @param mixed $start_msg
-*/
-function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) {
-    global $index_order, $internal_date_sort;
+ * Prints the table header for the messages list view
+ *
+ * @param array $aMailbox
+ */
+function printHeader($aMailbox) {
+    global $index_order, $internal_date_sort, $color;
+
+    if ($aMailbox['SORT_METHOD'] != 'THREAD') {
+        $showsort = true;
+    } else {
+        $showsort = false;
+    }
+
     echo html_tag( 'tr' ,'' , 'center', $color[5] );
 
     /* calculate the width of the subject column based on the
-    * widths of the other columns */
+     * widths of the other columns */
     $widths = array(1=>1,2=>25,3=>5,4=>0,5=>1,6=>5);
     $subjectwidth = 100;
     foreach($index_order as $item) {
@@ -913,23 +1339,23 @@ function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) {
     foreach ($index_order as $item) {
         switch ($item) {
         case 1: /* checkbox */
-            echo html_tag( 'td',get_selectall_link($start_msg, $sort, $mailbox) , '', '', 'width="1%"' );
+            echo html_tag( 'td',get_selectall_link($aMailbox) , '', '', 'width="1%"' );
             break;
         case 5: /* flags */
             echo html_tag( 'td','' , '', '', 'width="1%"' );
             break;
         case 2: /* from */
-            if (handleAsSent($mailbox)) {
+            if (handleAsSent($aMailbox['NAME'])) {
                 echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
                     . '<b>' . _("To") . '</b>';
                 if ($showsort) {
-                    ShowSortButton($sort, $mailbox, SQSORT_TO_ASC, SQSORT_TO_DEC);
+                    ShowSortButton($aMailbox, SQSORT_TO_ASC, SQSORT_TO_DEC);
                 }
             } else {
                 echo html_tag( 'td' ,'' , 'left', '', 'width="25%"' )
                     . '<b>' . _("From") . '</b>';
                 if ($showsort) {
-                    ShowSortButton($sort, $mailbox, SQSORT_FROM_ASC, SQSORT_FROM_DEC);
+                    ShowSortButton($aMailbox, SQSORT_FROM_ASC, SQSORT_FROM_DEC);
                 }
             }
             echo "</td>\n";
@@ -939,9 +1365,9 @@ function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) {
                 . '<b>' . _("Date") . '</b>';
             if ($showsort) {
                 if ($internal_date_sort) {
-                    ShowSortButton($sort, $mailbox, SQSORT_INT_DATE_ASC, SQSORT_INT_DATE_DEC);
+                    ShowSortButton($aMailbox, SQSORT_INT_DATE_ASC, SQSORT_INT_DATE_DEC);
                 } else {
-                    ShowSortButton($sort, $mailbox, SQSORT_DATE_ASC, SQSORT_DATE_DEC);
+                    ShowSortButton($aMailbox, SQSORT_DATE_ASC, SQSORT_DATE_DEC);
                 }
             }
             echo "</td>\n";
@@ -950,7 +1376,7 @@ function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) {
             echo html_tag( 'td' ,'' , 'left', '', 'width="'.$subjectwidth.'%"' )
                 . '<b>' . _("Subject") . '</b>';
             if ($showsort) {
-                ShowSortButton($sort, $mailbox, SQSORT_SUBJ_ASC, SQSORT_SUBJ_DEC);
+                ShowSortButton($aMailbox, SQSORT_SUBJ_ASC, SQSORT_SUBJ_DEC);
             }
             echo "</td>\n";
             break;
@@ -958,7 +1384,7 @@ function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) {
             echo html_tag( 'td', '', 'center','','width="5%" nowrap')
                 . '<b>' . _("Size") . '</b>';
             if ($showsort) {
-                ShowSortButton($sort, $mailbox, SQSORT_SIZE_ASC, SQSORT_SIZE_DEC);
+                ShowSortButton($aMailbox, SQSORT_SIZE_ASC, SQSORT_SIZE_DEC);
             }
             echo "</td>\n";
             break;
@@ -969,21 +1395,20 @@ function printHeader($mailbox, $sort, $color, $showsort=true, $start_msg=1) {
 
 
 /**
-* This function shows the sort button. Isn't this a good comment?
-*
-* @param mixed $sort
-* @param string $mailbox
-* @param mixed $Down
-* @param mixed $Up
-*/
-function ShowSortButton($sort, $mailbox, $Down, $Up ) {
+ * This function shows the sort button. Isn't this a good comment?
+ *
+ * @param array $aMailbox
+ * @param integer $Down
+ * @param integer $Up
+ */
+function ShowSortButton($aMailbox, $Down, $Up ) {
     global $PHP_SELF;
 
     /* Figure out which image we want to use. */
-    if ($sort != $Up && $sort != $Down) {
+    if ($aMailbox['SORT'] != $Up && $aMailbox['SORT'] != $Down) {
         $img = 'sort_none.png';
         $which = $Up;
-    } elseif ($sort == $Up) {
+    } elseif ($aMailbox['SORT'] == $Up) {
         $img = 'up_pointer.png';
         $which = $Down;
     } else {
@@ -998,27 +1423,25 @@ function ShowSortButton($sort, $mailbox, $Down, $Up ) {
     }
 
     /* Now that we have everything figured out, show the actual button. */
-    echo ' <a href="' . $source_url .'?newsort=' . $which
-        . '&amp;startMessage=1&amp;mailbox=' . urlencode($mailbox)
+    echo ' <a href="' . $source_url .'?srt=' . $which
+        . '&amp;startMessage=1&amp;mailbox=' . urlencode($aMailbox['NAME'])
         . '"><img src="../images/' . $img
         . '" border="0" width="12" height="10" alt="sort" title="'
-        . _("Click here to change the sorting of the message list") .' /"></a>';
+        . _("Click here to change the sorting of the message list") .'" /></a>';
 }
 
 /**
-* FIXME: Undocumented function
-*
-* @param mixed $start_msg
-* @param mixed $sort
-* @param string $mailbox
-*/
-function get_selectall_link($start_msg, $sort, $mailbox) {
-    global $checkall, $what, $where, $javascript_on;
-    global $PHP_SELF, $PG_SHOWNUM;
+ * FIXME: Undocumented function
+ *
+ * @param array $aMailbox
+ */
+function get_selectall_link($aMailbox) {
+    global $checkall, $javascript_on;
+    global $PHP_SELF;
 
     $result = '';
     if ($javascript_on) {
-        $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $mailbox);
+        $safe_name = preg_replace("/[^0-9A-Za-z_]/", '_', $aMailbox['NAME']);
         $func_name = "CheckAll" . $safe_name;
         $form_name = "FormMsgs" . $safe_name;
         $result = '<script language="JavaScript" type="text/javascript">'
@@ -1038,22 +1461,50 @@ function get_selectall_link($start_msg, $sort, $mailbox) {
 //                . <a href="javascript:void(0)" onClick="' . $func_name . '();">' . _("Toggle All")
 //                . "</a>\n";
     } else {
+        $result .= "<a href=\"$PHP_SELF";
+        // FIXME: why strpos() is used to detect presense of the symbol in the string.
+        // Function returns boolean value only when symbol is not found
         if (strpos($PHP_SELF, "?")) {
-            $result .= "<a href=\"$PHP_SELF&amp;mailbox=" . urlencode($mailbox)
-                    .  "&amp;startMessage=$start_msg&amp;sort=$sort&amp;checkall=";
+            $prefix = '&amp;';
         } else {
-            $result .= "<a href=\"$PHP_SELF?mailbox=" . urlencode($mailbox)
-                    .  "&amp;startMessage=$start_msg&amp;sort=$sort&amp;checkall=";
+            $prefix = '?';
         }
+
+        // If variables are part of GET request, they are present in $PHP_SELF
+        // maybe other functions can be used instead of sqgetGlobalVar (like preg_match)
+        if (! sqgetGlobalVar('mailbox',$tmp,SQ_GET)) {
+            $result .= $prefix . 'mailbox=' . urlencode($aMailbox['NAME']);
+            $prefix = '&amp;';
+        }
+        if (! sqgetGlobalVar('startMessage',$tmp,SQ_GET)) {
+            $result .= $prefix . 'startMessage=' . $aMailbox['PAGEOFFSET'];
+            $prefix = '&amp;';
+        }
+        if (! sqgetGlobalVar('str',$tmp,SQ_GET)) {
+            $result .= $prefix . 'str=' . $aMailbox['SORT'];
+            $prefix = '&amp;';
+        }
+
         if (isset($checkall) && $checkall == '1') {
-            $result .= '0';
+            $checkall_val = '0';
         } else {
-            $result .= '1';
+            $checkall_val = '1';
+        }
+        if (! sqgetGlobalVar('checkall',$tmp,SQ_GET) ) {
+            $result .= $prefix . 'checkall=' . $checkall_val;
+            $prefix = '&amp;';
+        } else {
+            // checkall is already present in php_self. replace it
+            $result = preg_replace("/checkall=(\d)/","checkall=$checkall_val",$result);
         }
 
-        if (isset($where) && isset($what)) {
-            $result .= '&amp;where=' . urlencode($where)
-                    .  '&amp;what=' . urlencode($what);
+        // FIXME: I suspect that search pages use different variables in 1.5.1cvs
+        // and these variables are present in $PHP_SELF.
+        if (isset($aMailbox['SEARCH']) && isset($aMailbox['SEARCH'][0]) && ! sqgetGlobalVar('where',$tmp,SQ_GET)) {
+            $result .= '&amp;where=' . urlencode($aMailbox['SEARCH'][0]);
+            if (isset($aMailbox['SEARCH'][1]) && ! sqgetGlobalVar('what',$tmp,SQ_GET)) {
+                $result .= '&amp;what=' .  urlencode($aMailbox['SEARCH'][1]);
+            }
         }
         $result .= "\">";
         $result .= _("All");
@@ -1065,13 +1516,13 @@ function get_selectall_link($start_msg, $sort, $mailbox) {
 }
 
 /**
-* This function computes the "Viewing Messages..." string.
-*
-* @param integer $start_msg first message number
-* @param integer $end_msg last message number
-* @param integer $num_msgs total number of message in folder
-* @return string
-*/
+ * This function computes the "Viewing Messages..." string.
+ *
+ * @param integer $start_msg first message number
+ * @param integer $end_msg last message number
+ * @param integer $num_msgs total number of message in folder
+ * @return string
+ */
 function get_msgcnt_str($start_msg, $end_msg, $num_msgs) {
     /* Compute the $msg_cnt_str. */
     $result = '';
@@ -1079,7 +1530,7 @@ function get_msgcnt_str($start_msg, $end_msg, $num_msgs) {
         $result = sprintf(_("Viewing Messages: %s to %s (%s total)"),
                         '<b>'.$start_msg.'</b>', '<b>'.$end_msg.'</b>', $num_msgs);
     } else if ($start_msg == $end_msg) {
-        $result = sprintf(_("Viewing Message: %s (1 total)"), '<b>'.$start_msg.'</b>');
+        $result = sprintf(_("Viewing Message: %s (%s total)"), '<b>'.$start_msg.'</b>', $num_msgs);
     } else {
         $result = '<br />';
     }
@@ -1088,36 +1539,37 @@ function get_msgcnt_str($start_msg, $end_msg, $num_msgs) {
 }
 
 /**
-* Generate a paginator link.
-*
-* @param mixed $box
-* @param mixed $start_msg
-* @param mixed $use
-* @param string $text text used for paginator link
-* @return string
-*/
-function get_paginator_link($box, $start_msg, $use, $text) {
-
-    $result = "<a href=\"right_main.php?use_mailbox_cache=$use"
-            . "&amp;startMessage=$start_msg&amp;mailbox=$box\" "
+ * Generate a paginator link.
+ *
+ * @param mixed $box Mailbox name
+ * @param mixed $start_msg Message Offset
+ * @param mixed $use
+ * @param string $text text used for paginator link
+ * @return string
+ */
+function get_paginator_link($box, $start_msg, $text) {
+    sqgetGlobalVar('PHP_SELF',$php_self,SQ_SERVER);
+    $result = "<a href=\"$php_self?startMessage=$start_msg&amp;mailbox=$box\" "
             . ">$text</a>";
 
     return ($result);
 }
 
 /**
-* This function computes the paginator string.
-*
-* @param mixed $box
-* @param mixed $start_msg
-* @param mixed $end_msg
-* @param integer $num_msgs
-* @param mixed $show_num
-* @param mixed $sort
-*/
-function get_paginator_str($box, $start_msg, $end_msg, $num_msgs,
-                        $show_num, $sort) {
-    global $username, $data_dir, $use_mailbox_cache, $color, $PG_SHOWNUM;
+ * This function computes the paginator string.
+ *
+ * @param string  $box      mailbox name
+ * @param integer $iOffset  offset in total number of messages
+ * @param integer $iTotal   total number of messages
+ * @param integer $iLimit   maximum number of messages to show on a page
+ * @param bool    $bShowAll show all messages at once (non paginate mode)
+ * @return string $result   paginate string with links to pages
+ */
+function get_paginator_str($box, $iOffset, $iTotal, $iLimit, $bShowAll) {
+    global $username, $data_dir, $javascript_on;
+    // page selector globals
+    global $page_selector, $page_selector_max, $compact_paginator;
+    sqgetGlobalVar('PHP_SELF',$php_self,SQ_SERVER);
 
     /* Initialize paginator string chunks. */
     $prv_str = '';
@@ -1131,190 +1583,238 @@ function get_paginator_str($box, $start_msg, $end_msg, $num_msgs,
     $spc = '&nbsp;';     /* This will be used as a space. */
     $sep = '|';          /* This will be used as a seperator. */
 
-    /* Get some paginator preference values. */
-    $pg_sel = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
-    $pg_max = getPref($data_dir, $username, 'page_selector_max', PG_SEL_MAX);
-
     /* Make sure that our start message number is not too big. */
-    $start_msg = min($start_msg, $num_msgs);
-
-    /* Decide whether or not we will use the mailbox cache. */
-    /* Not sure why $use_mailbox_cache is even passed in.   */
-    if ($sort == 6) {
-        $use = 0;
-    } else {
-        $use = 1;
-    }
+    $iOffset = min($iOffset, $iTotal);
 
     /* Compute the starting message of the previous and next page group. */
-    $next_grp = $start_msg + $show_num;
-    $prev_grp = $start_msg - $show_num;
-
-    /* Compute the basic previous and next strings. */
-    if (($next_grp <= $num_msgs) && ($prev_grp >= 0)) {
-        $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
-        $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
-    } else if (($next_grp > $num_msgs) && ($prev_grp >= 0)) {
-        $prv_str = get_paginator_link($box, $prev_grp, $use, _("Previous"));
-        $nxt_str = _("Next");
-    } else if (($next_grp <= $num_msgs) && ($prev_grp < 0)) {
-        $prv_str = _("Previous");
-        $nxt_str = get_paginator_link($box, $next_grp, $use, _("Next"));
-    }
-
-    /* Page selector block. Following code computes page links. */
-    if ($pg_sel && ($num_msgs > $show_num)) {
-        /* Most importantly, what is the current page!!! */
-        $cur_pg = intval($start_msg / $show_num) + 1;
-
-        /* Compute total # of pages and # of paginator page links. */
-        $tot_pgs = ceil($num_msgs / $show_num);  /* Total number of Pages */
-        $vis_pgs = min($pg_max, $tot_pgs - 1);   /* Visible Pages    */
-
-        /* Compute the size of the four quarters of the page links. */
-
-        /* If we can, just show all the pages. */
-        if (($tot_pgs - 1) <= $pg_max) {
-            $q1_pgs = $cur_pg - 1;
-            $q2_pgs = $q3_pgs = 0;
-            $q4_pgs = $tot_pgs - $cur_pg;
-
-        /* Otherwise, compute some magic to choose the four quarters. */
+    $next_grp = $iOffset + $iLimit;
+    $prev_grp = $iOffset - $iLimit;
+
+    if (!$bShowAll) {
+        /* Compute the basic previous and next strings. */
+        if ($compact_paginator) {
+            if (($next_grp <= $iTotal) && ($prev_grp >= 0)) {
+                $prv_str = get_paginator_link($box, $prev_grp, '<');
+                $nxt_str = get_paginator_link($box, $next_grp, '>');
+            } else if (($next_grp > $iTotal) && ($prev_grp >= 0)) {
+                $prv_str = get_paginator_link($box, $prev_grp, '<');
+                $nxt_str = '>';
+            } else if (($next_grp <= $iTotal) && ($prev_grp < 0)) {
+                $prv_str = '<';
+                $nxt_str = get_paginator_link($box, $next_grp, '>');
+            }
         } else {
-            /*
-            * Compute the magic base values. Added together,
-            * these values will always equal to the $pag_pgs.
-            * NOTE: These are DEFAULT values and do not take
-            * the current page into account. That is below.
-            */
-            $q1_pgs = floor($vis_pgs/4);
-            $q2_pgs = round($vis_pgs/4, 0);
-            $q3_pgs = ceil($vis_pgs/4);
-            $q4_pgs = round(($vis_pgs - $q2_pgs)/3, 0);
-
-            /* Adjust if the first quarter contains the current page. */
-            if (($cur_pg - $q1_pgs) < 1) {
-                $extra_pgs = ($q1_pgs - ($cur_pg - 1)) + $q2_pgs;
-                $q1_pgs = $cur_pg - 1;
-                $q2_pgs = 0;
-                $q3_pgs += ceil($extra_pgs / 2);
-                $q4_pgs += floor($extra_pgs / 2);
-
-            /* Adjust if the first and second quarters intersect. */
-            } else if (($cur_pg - $q2_pgs - ceil($q2_pgs/3)) <= $q1_pgs) {
-                $extra_pgs = $q2_pgs;
-                $extra_pgs -= ceil(($cur_pg - $q1_pgs - 1) * 3/4);
-                $q2_pgs = ceil(($cur_pg - $q1_pgs - 1) * 3/4);
-                $q3_pgs += ceil($extra_pgs / 2);
-                $q4_pgs += floor($extra_pgs / 2);
-
-            /* Adjust if the fourth quarter contains the current page. */
-            } else if (($cur_pg + $q4_pgs) >= $tot_pgs) {
-                $extra_pgs = ($q4_pgs - ($tot_pgs - $cur_pg)) + $q3_pgs;
-                $q3_pgs = 0;
-                $q4_pgs = $tot_pgs - $cur_pg;
-                $q1_pgs += floor($extra_pgs / 2);
-                $q2_pgs += ceil($extra_pgs / 2);
-
-            /* Adjust if the third and fourth quarter intersect. */
-            } else if (($cur_pg + $q3_pgs + 1) >= ($tot_pgs - $q4_pgs + 1)) {
-                $extra_pgs = $q3_pgs;
-                $extra_pgs -= ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
-                $q3_pgs = ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
-                $q1_pgs += floor($extra_pgs / 2);
-                $q2_pgs += ceil($extra_pgs / 2);
+            if (($next_grp <= $iTotal) && ($prev_grp >= 0)) {
+                $prv_str = get_paginator_link($box, $prev_grp, _("Previous"));
+                $nxt_str = get_paginator_link($box, $next_grp, _("Next"));
+            } else if (($next_grp > $iTotal) && ($prev_grp >= 0)) {
+                $prv_str = get_paginator_link($box, $prev_grp, _("Previous"));
+                $nxt_str = _("Next");
+            } else if (($next_grp <= $iTotal) && ($prev_grp < 0)) {
+                $prv_str = _("Previous");
+                $nxt_str = get_paginator_link($box, $next_grp, _("Next"));
             }
         }
 
-        /*
-        * I am leaving this debug code here, commented out, because
-        * it is a really nice way to see what the above code is doing.
-        * echo "qts =  $q1_pgs/$q2_pgs/$q3_pgs/$q4_pgs = "
-        *    . ($q1_pgs + $q2_pgs + $q3_pgs + $q4_pgs) . '<br />';
-        */
+        /* Page selector block. Following code computes page links. */
+        if ($iLimit != 0 && $page_selector && ($iTotal > $iLimit)) {
+            /* Most importantly, what is the current page!!! */
+            $cur_pg = intval($iOffset / $iLimit) + 1;
 
-        /* Print out the page links from the compute page quarters. */
+            /* Compute total # of pages and # of paginator page links. */
+            $tot_pgs = ceil($iTotal / $iLimit);  /* Total number of Pages */
 
-        /* Start with the first quarter. */
-        if (($q1_pgs == 0) && ($cur_pg > 1)) {
-            $pg_str .= "...$spc";
-        } else {
-            for ($pg = 1; $pg <= $q1_pgs; ++$pg) {
-                $start = (($pg-1) * $show_num) + 1;
-                $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
-            }
-            if ($cur_pg - $q2_pgs - $q1_pgs > 1) {
-                $pg_str .= "...$spc";
-            }
-        }
+            if (!$compact_paginator) {
+                $vis_pgs = min($page_selector_max, $tot_pgs - 1);   /* Visible Pages    */
 
-        /* Continue with the second quarter. */
-        for ($pg = $cur_pg - $q2_pgs; $pg < $cur_pg; ++$pg) {
-            $start = (($pg-1) * $show_num) + 1;
-            $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
-        }
+                /* Compute the size of the four quarters of the page links. */
 
-        /* Now print the current page. */
-        $pg_str .= $cur_pg . $spc;
+                /* If we can, just show all the pages. */
+                if (($tot_pgs - 1) <= $page_selector_max) {
+                    $q1_pgs = $cur_pg - 1;
+                    $q2_pgs = $q3_pgs = 0;
+                    $q4_pgs = $tot_pgs - $cur_pg;
 
-        /* Next comes the third quarter. */
-        for ($pg = $cur_pg + 1; $pg <= $cur_pg + $q3_pgs; ++$pg) {
-            $start = (($pg-1) * $show_num) + 1;
-            $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
-        }
+                /* Otherwise, compute some magic to choose the four quarters. */
+                } else {
+                    /*
+                    * Compute the magic base values. Added together,
+                    * these values will always equal to the $pag_pgs.
+                    * NOTE: These are DEFAULT values and do not take
+                    * the current page into account. That is below.
+                    */
+                    $q1_pgs = floor($vis_pgs/4);
+                    $q2_pgs = round($vis_pgs/4, 0);
+                    $q3_pgs = ceil($vis_pgs/4);
+                    $q4_pgs = round(($vis_pgs - $q2_pgs)/3, 0);
+
+                    /* Adjust if the first quarter contains the current page. */
+                    if (($cur_pg - $q1_pgs) < 1) {
+                        $extra_pgs = ($q1_pgs - ($cur_pg - 1)) + $q2_pgs;
+                        $q1_pgs = $cur_pg - 1;
+                        $q2_pgs = 0;
+                        $q3_pgs += ceil($extra_pgs / 2);
+                        $q4_pgs += floor($extra_pgs / 2);
+
+                    /* Adjust if the first and second quarters intersect. */
+                    } else if (($cur_pg - $q2_pgs - ceil($q2_pgs/3)) <= $q1_pgs) {
+                        $extra_pgs = $q2_pgs;
+                        $extra_pgs -= ceil(($cur_pg - $q1_pgs - 1) * 3/4);
+                        $q2_pgs = ceil(($cur_pg - $q1_pgs - 1) * 3/4);
+                        $q3_pgs += ceil($extra_pgs / 2);
+                        $q4_pgs += floor($extra_pgs / 2);
+
+                    /* Adjust if the fourth quarter contains the current page. */
+                    } else if (($cur_pg + $q4_pgs) >= $tot_pgs) {
+                        $extra_pgs = ($q4_pgs - ($tot_pgs - $cur_pg)) + $q3_pgs;
+                        $q3_pgs = 0;
+                        $q4_pgs = $tot_pgs - $cur_pg;
+                        $q1_pgs += floor($extra_pgs / 2);
+                        $q2_pgs += ceil($extra_pgs / 2);
+
+                    /* Adjust if the third and fourth quarter intersect. */
+                    } else if (($cur_pg + $q3_pgs + 1) >= ($tot_pgs - $q4_pgs + 1)) {
+                        $extra_pgs = $q3_pgs;
+                        $extra_pgs -= ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
+                        $q3_pgs = ceil(($tot_pgs - $cur_pg - $q4_pgs) * 3/4);
+                        $q1_pgs += floor($extra_pgs / 2);
+                        $q2_pgs += ceil($extra_pgs / 2);
+                    }
+                }
 
-        /* And last, print the forth quarter page links. */
-        if (($q4_pgs == 0) && ($cur_pg < $tot_pgs)) {
-            $pg_str .= "...$spc";
-        } else {
-            if (($tot_pgs - $q4_pgs) > ($cur_pg + $q3_pgs)) {
-                $pg_str .= "...$spc";
-            }
-            for ($pg = $tot_pgs - $q4_pgs + 1; $pg <= $tot_pgs; ++$pg) {
-                $start = (($pg-1) * $show_num) + 1;
-                $pg_str .= get_paginator_link($box, $start, $use, $pg) . $spc;
+                /*
+                * I am leaving this debug code here, commented out, because
+                * it is a really nice way to see what the above code is doing.
+                * echo "qts =  $q1_pgs/$q2_pgs/$q3_pgs/$q4_pgs = "
+                *    . ($q1_pgs + $q2_pgs + $q3_pgs + $q4_pgs) . '<br />';
+                */
+
+                /* Print out the page links from the compute page quarters. */
+
+                /* Start with the first quarter. */
+                if (($q1_pgs == 0) && ($cur_pg > 1)) {
+                    $pg_str .= "...$spc";
+                } else {
+                    for ($pg = 1; $pg <= $q1_pgs; ++$pg) {
+                        $start = (($pg-1) * $iLimit) + 1;
+                        $pg_str .= get_paginator_link($box, $start, $pg) . $spc;
+                    }
+                    if ($cur_pg - $q2_pgs - $q1_pgs > 1) {
+                        $pg_str .= "...$spc";
+                    }
+                }
+
+                /* Continue with the second quarter. */
+                for ($pg = $cur_pg - $q2_pgs; $pg < $cur_pg; ++$pg) {
+                    $start = (($pg-1) * $iLimit) + 1;
+                    $pg_str .= get_paginator_link($box, $start, $pg) . $spc;
+                }
+
+                /* Now print the current page. */
+                $pg_str .= $cur_pg . $spc;
+
+                /* Next comes the third quarter. */
+                for ($pg = $cur_pg + 1; $pg <= $cur_pg + $q3_pgs; ++$pg) {
+                    $start = (($pg-1) * $iLimit) + 1;
+                    $pg_str .= get_paginator_link($box, $start, $pg) . $spc;
+                }
+
+                /* And last, print the forth quarter page links. */
+                if (($q4_pgs == 0) && ($cur_pg < $tot_pgs)) {
+                    $pg_str .= "...$spc";
+                } else {
+                    if (($tot_pgs - $q4_pgs) > ($cur_pg + $q3_pgs)) {
+                        $pg_str .= "...$spc";
+                    }
+                    for ($pg = $tot_pgs - $q4_pgs + 1; $pg <= $tot_pgs; ++$pg) {
+                        $start = (($pg-1) * $iLimit) + 1;
+                        $pg_str .= get_paginator_link($box, $start,$pg) . $spc;
+                    }
+                }
             }
+        $last_grp = (($tot_pgs - 1) * $iLimit) + 1;
         }
-    } else if ($PG_SHOWNUM == 999999) {
-        $pg_str = "<a href=\"right_main.php?PG_SHOWALL=0"
-                . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
+    } else {
+        $pg_str = "<a href=\"$php_self?showall=0"
+                . "&amp;startMessage=1&amp;mailbox=$box\" "
                 . ">" ._("Paginate") . '</a>';
     }
 
     /* Put all the pieces of the paginator string together. */
     /**
-    * Hairy code... But let's leave it like it is since I am not certain
-    * a different approach would be any easier to read. ;)
-    */
+     * Hairy code... But let's leave it like it is since I am not certain
+     * a different approach would be any easier to read. ;)
+     */
     $result = '';
-    if ( $prv_str != '' || $nxt_str != '' )
-    {
-    $result .= '[';
-    $result .= ($prv_str != '' ? $prv_str . $spc . $sep . $spc : '');
-    $result .= ($nxt_str != '' ? $nxt_str : '');
-    $result .= ']' . $spc ;
-
-    /* Compute the 'show all' string. */
-    $all_str = "<a href=\"right_main.php?PG_SHOWALL=1"
-                . "&amp;use_mailbox_cache=$use&amp;startMessage=1&amp;mailbox=$box\" "
+    if ( $prv_str || $nxt_str ) {
+
+        /* Compute the 'show all' string. */
+        $all_str = "<a href=\"$php_self?showall=1"
+                . "&amp;startMessage=1&amp;mailbox=$box\" "
                 . ">" . _("Show All") . '</a>';
     }
 
-    $result .= ($pg_str  != '' ? $spc . '['.$spc.$pg_str.']' .  $spc : '');
-    $result .= ($all_str != '' ? $spc . '['.$all_str.']' . $spc . $spc : '');
+    if ($compact_paginator) {
+        if ( $prv_str || $nxt_str ) {
+            $result .= '[' . get_paginator_link($box, 1, '<<') . ']';
+            $result .= '[' . $prv_str . ']';
+
+            $pg_url = $php_self . '?mailbox=' . $box;
+
+            $result .= '[' . $nxt_str . ']';
+            $result .= '[' . get_paginator_link($box, $last_grp, '>>') . ']';
+
+            if ($page_selector) {
+                $result .= $spc . '<select name="startMessage"';
+                if ($javascript_on) {
+                    $result .= ' onchange="JavaScript:SubmitOnSelect'
+                        . '(this, \'' . $pg_url . '&startMessage=\')"';
+                }
+                $result .='>';
+
+                for ($p = 0; $p < $tot_pgs; $p++) {
+                    $result .= '<option ';
+                    if (($p+1) == $cur_pg) $result .= 'selected ';
+                        $result .= 'value="' . (($p*$iLimit)+1) . '">'
+                         . ($p+1) . "/$tot_pgs" . '</option>';
+                }
+
+                $result .= '</select>';
+
+                if ($javascript_on) {
+                    $result .= '<noscript language="JavaScript">'
+                    . addSubmit(_("Go"))
+                    . '</noscript>';
+                } else {
+                    $result .= addSubmit(_("Go"));
+                }
+            }
+        }
+
+        $result .= ($pg_str  != '' ? '['.$pg_str.']' .  $spc : '');
+        $result .= ($all_str != '' ? $spc . '['.$all_str.']' . $spc . $spc : '');
+    } else {
+        if ( $prv_str || $nxt_str ) {
+            $result .= '[';
+            $result .= ($prv_str != '' ? $prv_str . $spc . $sep . $spc : '');
+            $result .= ($nxt_str != '' ? $nxt_str : '');
+            $result .= ']' . $spc ;
+        }
 
+        $result .= ($pg_str  != '' ? $spc . '['.$spc.$pg_str.']' .  $spc : '');
+        $result .= ($all_str != '' ? $spc . '['.$all_str.']' . $spc . $spc : '');
+    }
     /* If the resulting string is blank, return a non-breaking space. */
     if ($result == '') {
         $result = '&nbsp;';
     }
-
     /* Return our final magical paginator string. */
     return ($result);
 }
 
 /**
-* FIXME: Undocumented function
-*/
+ * FIXME: Undocumented function
+ */
 function truncateWithEntities($subject, $trim_at)
 {
     $ent_strlen = strlen($subject);
@@ -1324,11 +1824,11 @@ function truncateWithEntities($subject, $trim_at)
     global $languages, $squirrelmail_language;
 
     /*
-    * see if this is entities-encoded string
-    * If so, Iterate through the whole string, find out
-    * the real number of characters, and if more
-    * than $trim_at, substr with an updated trim value.
-    */
+     * see if this is entities-encoded string
+     * If so, Iterate through the whole string, find out
+     * the real number of characters, and if more
+     * than $trim_at, substr with an updated trim value.
+     */
     $trim_val = $trim_at;
     $ent_offset = 0;
     $ent_loc = 0;
@@ -1348,16 +1848,16 @@ function truncateWithEntities($subject, $trim_at)
         return $subject;
 
     if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
-        function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
-        return $languages[$squirrelmail_language]['XTRA_CODE']('strimwidth', $subject, $trim_val);
+        function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth')) {
+        return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_strimwidth', $subject, $trim_val);
     }
 
     return substr_replace($subject, '...', $trim_val);
 }
 
 /**
-* FIXME: Undocumented function
-*/
+ * FIXME: Undocumented function
+ */
 function processSubject($subject, $threadlevel = 0) {
     /* Shouldn't ever happen -- caught too many times in the IMAP functions */
     if ($subject == '') {
@@ -1374,29 +1874,17 @@ function processSubject($subject, $threadlevel = 0) {
     return truncateWithEntities($subject, $trim_at);
 }
 
-/**
-* FIXME: Undocumented function
-*
-* @param mixed $imapConnection
-* @param mixed $boxes
-*/
-function getMbxList($imapConnection, $boxes = 0) {
-    global $lastTargetMailbox;
-    echo  '         <small>&nbsp;<tt><select name="targetMailbox">';
-    echo sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)), 0, $boxes);
-    echo '         </select></tt>&nbsp;';
-}
 
 /**
-* Creates button
-*
-* @deprecated see form functions available in 1.5.1 and 1.4.3.
-* @param string $type
-* @param string $name
-* @param string $value
-* @param string $js
-* @param bool $enabled
-*/
+ * Creates button
+ *
+ * @deprecated see form functions available in 1.5.1 and 1.4.3.
+ * @param string $type
+ * @param string $name
+ * @param string $value
+ * @param string $js
+ * @param bool $enabled
+ */
 function getButton($type, $name, $value, $js = '', $enabled = TRUE) {
     $disabled = ( $enabled ? '' : 'disabled ' );
     $js = ( $js ? $js.' ' : '' );
@@ -1408,11 +1896,11 @@ function getButton($type, $name, $value, $js = '', $enabled = TRUE) {
 }
 
 /**
-* Puts string into cell, aligns it and adds <small> tag
-*
-* @param string $string string
-* @param string $align alignment
-*/
+ * Puts string into cell, aligns it and adds <small> tag
+ *
+ * @param string $string string
+ * @param string $align alignment
+ */
 function getSmallStringCell($string, $align) {
     return html_tag('td',
                     '<small>' . $string . ':&nbsp; </small>',
@@ -1422,32 +1910,9 @@ function getSmallStringCell($string, $align) {
 }
 
 /**
-* FIXME: Undocumented function
-*
-* @param integer $start_msg
-* @param integer $show_num
-* @param integer $num_msgs
-*/
-function getEndMessage($start_msg, $show_num, $num_msgs) {
-    if ($start_msg + ($show_num - 1) < $num_msgs){
-        $end_msg = $start_msg + ($show_num - 1);
-    } else {
-        $end_msg = $num_msgs;
-    }
-
-    if ($end_msg < $start_msg) {
-        $start_msg = $start_msg - $show_num;
-        if ($start_msg < 1) {
-            $start_msg = 1;
-        }
-    }
-    return (array($start_msg,$end_msg));
-}
-
-/**
-* This should go in imap_mailbox.php
-* @param string $mailbox
-*/
+ * This should go in imap_mailbox.php
+ * @param string $mailbox
+ */
 function handleAsSent($mailbox) {
     global $handleAsSent_result;
 
@@ -1461,4 +1926,230 @@ function handleAsSent($mailbox) {
     return $handleAsSent_result;
 }
 
-?>
+/**
+ * Process messages list form and handle the cache gracefully. If $sButton and
+ * $aUid are provided as argument then you can fake a message list submit and
+ * use it i.e. in read_body.php for del move next and update the cache
+ *
+ * @param  resource $imapConnection imap connection
+ * @param  array $aMailbox (reference) cached mailbox
+ * @param  string $sButton fake a submit button
+ * @param  array  $aUid    fake the $msg array
+ * @return string $sError error string in case of an error
+ * @author Marc Groot Koerkamp
+ */
+function handleMessageListForm($imapConnection,&$aMailbox,$sButton='',$aUid = array()) {
+
+    /* incoming formdata */
+    $sButton = (sqgetGlobalVar('moveButton',      $sTmp, SQ_POST)) ? 'move'         : $sButton;
+    $sButton = (sqgetGlobalVar('expungeButton',   $sTmp, SQ_POST)) ? 'expunge'      : $sButton;
+    $sButton = (sqgetGlobalVar('attache',         $sTmp, SQ_POST)) ? 'attache'      : $sButton;
+    $sButton = (sqgetGlobalVar('delete',          $sTmp, SQ_POST)) ? 'setDeleted'   : $sButton;
+    $sButton = (sqgetGlobalVar('undeleteButton',  $sTmp, SQ_POST)) ? 'setDeleted'   : $sButton;
+    $sButton = (sqgetGlobalVar('markRead',        $sTmp, SQ_POST)) ? 'setSeen'      : $sButton;
+    $sButton = (sqgetGlobalVar('markUnread',      $sTmp, SQ_POST)) ? 'unsetSeen'    : $sButton;
+    $sButton = (sqgetGlobalVar('markFlagged',     $sTmp, SQ_POST)) ? 'setFlagged'   : $sButton;
+    $sButton = (sqgetGlobalVar('markUnflagged',   $sTmp, SQ_POST)) ? 'unsetFlagged' : $sButton;
+    sqgetGlobalVar('targetMailbox', $targetMailbox,   SQ_POST);
+    sqgetGlobalVar('bypass_trash',  $bypass_trash,    SQ_POST);
+    sqgetGlobalVar('msg',           $msg,             SQ_POST);
+
+    $sError = '';
+    $mailbox = $aMailbox['NAME'];
+
+    /* retrieve the check boxes */
+    $aUid = (isset($msg) && is_array($msg)) ? array_values($msg) : $aUid;
+
+    if (count($aUid) && $sButton != 'expunge') {
+        $aUpdatedMsgs = false;
+        $bExpunge = false;
+        switch ($sButton) {
+          case 'setDeleted':
+            // check if id exists in case we come from read_body
+            if (count($aUid) == 1 && is_array($aMailbox['UIDSET'][$aMailbox['SETINDEX']]) &&
+                !in_array($aUid[0],$aMailbox['UIDSET'][$aMailbox['SETINDEX']])) {
+                break;
+            }
+            $aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
+            $bExpunge = true;
+            break;
+          case 'unsetDeleted':
+          case 'setSeen':
+          case 'unsetSeen':
+          case 'setFlagged':
+          case 'unsetFlagged':
+            // get flag
+            $sFlag = (substr($sButton,0,3) == 'set') ? '\\'.substr($sButton,3) : '\\'.substr($sButton,5);
+            $bSet  = (substr($sButton,0,3) == 'set') ? true : false;
+            $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
+            break;
+          case 'move':
+            $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aUid,$targetMailbox);
+            sqsession_register($targetMailbox,'lastTargetMailbox');
+            $bExpunge = true;
+            break;
+          case 'attache':
+            $aMsgHeaders = array();
+            foreach ($aUid as $iUid) {
+                $aMsgHeaders[$iUid] = $aMailbox['MSG_HEADERS'][$iUid];
+            }
+            if (count($aMsgHeaders)) {
+                $composesession = attachSelectedMessages($imapConnection,$aMsgHeaders);
+                // dirty hack, add info to $aMailbox
+                $aMailbox['FORWARD_SESSION'] = $composesession;
+            }
+            break;
+          default:
+            // Hook for plugin buttons
+            do_hook_function('mailbox_display_button_action', $aUid);
+            break;
+        }
+        /**
+         * Updates messages is an array containing the result of the untagged
+         * fetch responses send by the imap server due to a flag change. That
+         * response is parsed in a array with msg arrays by the parseFetch function
+         */
+        if ($aUpdatedMsgs) {
+            // Update the message headers cache
+            $aDeleted = array();
+            foreach ($aUpdatedMsgs as $iUid => $aMsg) {
+                if (isset($aMsg['FLAGS'])) {
+                    /**
+                     * Only update the cached headers if the header is
+                     * cached.
+                     */
+                    if (isset($aMailbox['MSG_HEADERS'][$iUid])) {
+                        $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS'];
+                    }
+                    /**
+                     * Count the messages with the \Delete flag set so we can determine
+                     * if the number of expunged messages equals the number of flagged
+                     * messages for deletion.
+                     */
+                    if (isset($aMsg['FLAGS']['\\deleted']) && $aMsg['FLAGS']['\\deleted']) {
+                        $aDeleted[] = $iUid;
+                    }
+                }
+            }
+            if ($bExpunge && $aMailbox['AUTO_EXPUNGE'] &&
+                $iExpungedMessages = sqimap_mailbox_expunge($imapConnection, $aMailbox['NAME'], true))
+                {
+                if (count($aDeleted) != $iExpungedMessages) {
+                    // there are more messages deleted permanently then we expected
+                    // invalidate the cache
+                    $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = false;
+                    $aMailbox['MSG_HEADERS'] = false;
+                } else {
+                    // remove expunged messages from cache
+                    $aUidSet = $aMailbox['UIDSET'][$aMailbox['SETINDEX']];
+                    if (is_array($aUidSet)) {
+                        // create a UID => array index temp array
+                        $aUidSetDummy = array_flip($aUidSet);
+                        foreach ($aDeleted as $iUid) {
+                            // get the id as well in case of SQM_SORT_NONE
+                            if ($aMailbox['SORT'] == SQSORT_NONE) {
+                                $aMailbox['ID'] = false;
+                                //$iId = $aMailbox['MSG_HEADERS'][$iUid]['ID'];
+                                //unset($aMailbox['ID'][$iId]);
+                            }
+                            // unset the UID and message header
+                            unset($aUidSetDummy[$iUid]);
+                            unset($aMailbox['MSG_HEADERS'][$iUid]);
+                        }
+                        $aMailbox['UIDSET'][$aMailbox['SETINDEX']] = array_keys($aUidSetDummy);
+                    }
+                }
+                // update EXISTS info
+                if ($iExpungedMessages) {
+                    $aMailbox['EXISTS'] -= (int) $iExpungedMessages;
+                }
+                // Change the startMessage number if the mailbox was changed
+                if (($aMailbox['PAGEOFFSET']-1) >= $aMailbox['EXISTS']) {
+                    $aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
+                        $aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
+                    $aMailbox['OFFSET'] = $aMailbox['PAGEOFFSET'] - 1 ;
+                }
+            }
+        }
+    } else {
+        if ($sButton == 'expunge') {
+            /**
+             * on expunge we do not know which messages will be deleted
+             * so it's useless to try to sync the cache
+
+             * Close the mailbox so we do not need to parse the untagged expunge
+             * responses which do not contain uid info.
+             * NB: Closing a mailbox is faster then expunge because the imap
+             * server does not need to generate the untagged expunge responses
+             */
+            sqimap_run_command($imapConnection,'CLOSE',false,$result,$message);
+            $aMbxResponse = sqimap_mailbox_select($imapConnection,$aMailbox['NAME']);
+            // update the $aMailbox array
+            $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
+            $aMailbox['UIDSET'] = false;
+        } else {
+            if ($sButton) {
+                $sError = _("No messages were selected.");
+            }
+        }
+    }
+    return $sError;
+}
+
+function attachSelectedMessages($imapConnection,$aMsgHeaders) {
+    global $username, $attachment_dir,
+           $data_dir, $composesession,
+           $compose_messages;
+
+    if (!isset($compose_messages)) {
+        $compose_messages = array();
+        sqsession_register($compose_messages,'compose_messages');
+    }
+
+    if (!$composesession) {
+        $composesession = 1;
+        sqsession_register($composesession,'composesession');
+    } else {
+        $composesession++;
+        sqsession_register($composesession,'composesession');
+    }
+
+    $hashed_attachment_dir = getHashedDir($username, $attachment_dir);
+
+    $composeMessage = new Message();
+    $rfc822_header = new Rfc822Header();
+    $composeMessage->rfc822_header = $rfc822_header;
+    $composeMessage->reply_rfc822_header = '';
+
+    foreach($aMsgHeaders as $iUid => $aMsgHeader) {
+        /**
+         * Retrieve the full message
+         */
+        $body_a = sqimap_run_command($imapConnection, "FETCH $iUid RFC822", true, $response, $readmessage, TRUE);
+
+        if ($response == 'OK') {
+            $subject = (isset($aMsgHeader['SUBJECT'])) ? $aMsgHeader['SUBJECT'] : $iUid;
+
+            array_shift($body_a);
+            array_pop($body_a);
+            $body = implode('', $body_a);
+            $body .= "\r\n";
+
+            $localfilename = GenerateRandomString(32, 'FILE', 7);
+            $full_localfilename = "$hashed_attachment_dir/$localfilename";
+
+            $fp = fopen( $full_localfilename, 'wb');
+            fwrite ($fp, $body);
+            fclose($fp);
+            $composeMessage->initAttachment('message/rfc822',$subject.'.msg',
+                 $full_localfilename);
+        }
+    }
+
+    $compose_messages[$composesession] = $composeMessage;
+    sqsession_register($compose_messages,'compose_messages');
+    return $composesession;
+}
+
+// vim: et ts=4
+?>
\ No newline at end of file