alecpl
2010-11-12 5d238918a7876561d8b1c112aa4267bbed3d8587
program/include/rcube_imap.php
@@ -33,10 +33,8 @@
{
    public $debug_level = 1;
    public $skip_deleted = false;
    public $root_dir = '';
    public $page_size = 10;
    public $list_page = 1;
    public $delimiter = NULL;
    public $threading = false;
    public $fetch_add_headers = '';
    public $get_all_headers = false;
@@ -54,8 +52,9 @@
     * @var rcube_mdb2
     */
    private $db;
    private $root_ns = '';
    private $mailbox = 'INBOX';
    private $delimiter = NULL;
    private $namespace = NULL;
    private $sort_field = '';
    private $sort_order = 'DESC';
    private $caching_enabled = false;
@@ -113,7 +112,7 @@
        $this->conn = new rcube_imap_generic();
    }
    /**
     * Connect to an IMAP server
     *
@@ -156,17 +155,13 @@
        $this->port = $port;
        $this->ssl  = $use_ssl;
        // print trace messages
        if ($this->conn->connected()) {
            // print trace messages
            if ($this->conn->message && ($this->debug_level & 8)) {
                console($this->conn->message);
            }
            // get server properties
            if (!empty($this->conn->rootdir))
                $this->set_rootdir($this->conn->rootdir);
            if (empty($this->delimiter))
               $this->get_hierarchy_delimiter();
            // get namespace and delimiter
            $this->set_env();
            return true;
        }
@@ -181,7 +176,7 @@
        return false;
    }
    /**
     * Close IMAP connection
     * Usually done on script shutdown
@@ -194,7 +189,7 @@
        $this->write_cache();
    }
    /**
     * Close IMAP connection and re-connect
     * This is used to avoid some strange socket errors when talking to Courier IMAP
@@ -232,7 +227,7 @@
    {
        return ($this->conn) ? $this->conn->error : '';
    }
    /**
     * Set options to be used in rcube_imap_generic::connect()
@@ -244,29 +239,7 @@
        $this->options = array_merge($this->options, (array)$opt);
    }
    /**
     * Set a root folder for the IMAP connection.
     *
     * Only folders within this root folder will be displayed
     * and all folder paths will be translated using this folder name
     *
     * @param  string   $root Root folder
     * @access public
     */
    function set_rootdir($root)
    {
        if (preg_match('/[.\/]$/', $root)) //(substr($root, -1, 1)==='/')
            $root = substr($root, 0, -1);
        $this->root_dir = $root;
        $this->options['rootdir'] = $root;
        if (empty($this->delimiter))
            $this->get_hierarchy_delimiter();
    }
    /**
     * Set default message charset
     *
@@ -280,7 +253,7 @@
        $this->default_charset = $cs;
    }
    /**
     * This list of folders will be listed above all other folders
     *
@@ -298,7 +271,7 @@
        }
    }
    /**
     * Set internal mailbox reference.
     *
@@ -320,7 +293,27 @@
        $this->_clear_messagecount($mailbox);
    }
    /**
     * Forces selection of a mailbox
     *
     * @param  string $mailbox Mailbox/Folder name
     * @access public
     */
    function select_mailbox($mailbox)
    {
        $mailbox = $this->mod_mailbox($mailbox);
        $selected = $this->conn->select($mailbox);
        if ($selected && $this->mailbox != $mailbox) {
            // clear messagecount cache for this mailbox
            $this->_clear_messagecount($mailbox);
            $this->mailbox = $mailbox;
        }
    }
    /**
     * Set internal list page
     *
@@ -332,7 +325,7 @@
        $this->list_page = (int)$page;
    }
    /**
     * Set internal page size
     *
@@ -344,7 +337,7 @@
        $this->page_size = (int)$size;
    }
    /**
     * Save a set of message ids for future message listing methods
     *
@@ -371,7 +364,7 @@
        $this->search_sorted     = $sorted;
    }
    /**
     * Return the saved search set as hash array
     * @return array Search set
@@ -387,7 +380,7 @@
       );
    }
    /**
     * Returns the currently used mailbox name
     *
@@ -399,7 +392,7 @@
        return $this->conn->connected() ? $this->mod_mailbox($this->mailbox, 'out') : '';
    }
    /**
     * Returns the IMAP server's capability
     *
@@ -412,7 +405,7 @@
        return $this->conn->getCapability(strtoupper($cap));
    }
    /**
     * Sets threading flag to the best supported THREAD algorithm
     *
@@ -436,7 +429,7 @@
        return $this->threading;
    }
    /**
     * Checks the PERMANENTFLAGS capability of the current mailbox
     * and returns true if the given flag is supported by the IMAP server
@@ -449,10 +442,10 @@
    {
        $flag = strtoupper($flag);
        $imap_flag = $this->conn->flags[$flag];
        return (in_array_nocase($imap_flag, $this->conn->permanentflags));
        return (in_array_nocase($imap_flag, $this->conn->data['PERMANENTFLAGS']));
    }
    /**
     * Returns the delimiter that is used by the IMAP server for folder separation
     *
@@ -461,16 +454,104 @@
     */
    function get_hierarchy_delimiter()
    {
        if ($this->conn && empty($this->delimiter))
            $this->delimiter = $this->conn->getHierarchyDelimiter();
        if (empty($this->delimiter))
            $this->delimiter = '/';
        return $this->delimiter;
    }
    /**
     * Get namespace
     *
     * @return  array  Namespace data
     * @access  public
     */
    function get_namespace()
    {
        return $this->namespace;
    }
    /**
     * Sets delimiter and namespaces
     *
     * @access private
     */
    private function set_env()
    {
        if ($this->delimiter !== null && $this->namespace !== null) {
            return;
        }
        if (isset($_SESSION['imap_namespace']) && isset($_SESSION['imap_delimiter'])) {
            $this->namespace = $_SESSION['imap_namespace'];
            $this->delimiter = $_SESSION['imap_delimiter'];
            return;
        }
        $config = rcmail::get_instance()->config;
        $imap_personal  = $config->get('imap_ns_personal');
        $imap_other     = $config->get('imap_ns_other');
        $imap_shared    = $config->get('imap_ns_shared');
        $imap_delimiter = $config->get('imap_delimiter');
        if ($imap_delimiter) {
            $this->delimiter = $imap_delimiter;
        }
        if (!$this->conn)
            return;
        $ns = $this->conn->getNamespace();
        // NAMESPACE supported
        if (is_array($ns)) {
            $this->namespace = $ns;
            if (empty($this->delimiter))
                $this->delimiter = $ns['personal'][0][1];
            if (empty($this->delimiter))
                $this->delimiter = $this->conn->getHierarchyDelimiter();
            if (empty($this->delimiter))
                $this->delimiter = '/';
        }
        // not supported, get namespace from config
        else if ($imap_personal !== null || $imap_shared !== null || $imap_other !== null) {
            if (empty($this->delimiter))
                $this->delimiter = $this->conn->getHierarchyDelimiter();
            if (empty($this->delimiter))
                $this->delimiter = '/';
            $this->namespace = array(
                'personal' => NULL,
                'other'    => NULL,
                'shared'   => NULL,
            );
            if ($imap_personal !== null) {
                foreach ((array)$imap_personal as $dir) {
                    $this->namespace['personal'][] = array($dir, $this->delimiter);
                }
            }
            if ($imap_other !== null) {
                foreach ((array)$imap_other as $dir) {
                    if ($dir) {
                        $this->namespace['other'][] = array($dir, $this->delimiter);
                    }
                }
            }
            if ($imap_shared !== null) {
                foreach ((array)$imap_shared as $dir) {
                    if ($dir) {
                        $this->namespace['shared'][] = array($dir, $this->delimiter);
                    }
                }
            }
        }
        $_SESSION['imap_namespace'] = $this->namespace;
        $_SESSION['imap_delimiter'] = $this->delimiter;
    }
    /**
     * Get message count for a specific mailbox
     *
@@ -484,11 +565,11 @@
     */
    function messagecount($mbox_name='', $mode='ALL', $force=false, $status=true)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        return $this->_messagecount($mailbox, $mode, $force, $status);
    }
    /**
     * Private method for getting nr of messages
     *
@@ -505,7 +586,7 @@
    {
        $mode = strtoupper($mode);
        if (empty($mailbox))
        if (!strlen($mailbox))
            $mailbox = $this->mailbox;
        // count search set
@@ -526,10 +607,12 @@
            $a_mailbox_cache[$mailbox] = array();
        if ($mode == 'THREADS') {
            $count = $this->_threadcount($mailbox, $msg_count);
            $res   = $this->_threadcount($mailbox, $msg_count);
            $count = $res['count'];
            if ($status) {
                $this->set_folder_stats($mailbox, 'cnt', $msg_count);
                $this->set_folder_stats($mailbox, 'maxuid', $msg_count ? $this->_id2uid($msg_count, $mailbox) : 0);
                $this->set_folder_stats($mailbox, 'cnt', $res['msgcount']);
                $this->set_folder_stats($mailbox, 'maxuid', $res['maxuid'] ? $this->_id2uid($res['maxuid'], $mailbox) : 0);
            }
        }
        // RECENT count is fetched a bit different
@@ -539,19 +622,37 @@
        // use SEARCH for message counting
        else if ($this->skip_deleted) {
            $search_str = "ALL UNDELETED";
            $keys       = array('COUNT');
            $need_uid   = false;
            // get message count and store in cache
            if ($mode == 'UNSEEN')
            if ($mode == 'UNSEEN') {
                $search_str .= " UNSEEN";
            // get message count using SEARCH
            }
            else {
                if ($this->caching_enabled) {
                    $keys[] = 'ALL';
                }
                if ($status) {
                    $keys[]   = 'MAX';
                    $need_uid = true;
                }
            }
            // get message count using (E)SEARCH
            // not very performant but more precise (using UNDELETED)
            $index = $this->conn->search($mailbox, $search_str);
            $index = $this->conn->search($mailbox, $search_str, $need_uid, $keys);
            $count = is_array($index) ? count($index) : 0;
            $count = is_array($index) ? $index['COUNT'] : 0;
            if ($mode == 'ALL' && $status) {
                $this->set_folder_stats($mailbox, 'cnt', $count);
                $this->set_folder_stats($mailbox, 'maxuid', $index ? $this->_id2uid(max($index), $mailbox) : 0);
            if ($mode == 'ALL') {
                if ($need_uid && $this->caching_enabled) {
                    // Save messages index for check_cache_status()
                    $this->icache['all_undeleted_idx'] = $index['ALL'];
                }
                if ($status) {
                    $this->set_folder_stats($mailbox, 'cnt', $count);
                    $this->set_folder_stats($mailbox, 'maxuid', is_array($index) ? $index['MAX'] : 0);
                }
            }
        }
        else {
@@ -579,24 +680,36 @@
     * Private method for getting nr of threads
     *
     * @param string $mailbox   Folder name
     * @param int    $msg_count Number of messages in the folder
     *
     * @returns array Array containing items: 'count' - threads count,
     *                'msgcount' = messages count, 'maxuid' = max. UID in the set
     * @access  private
     * @see     rcube_imap::messagecount()
     */
    private function _threadcount($mailbox, &$msg_count)
    private function _threadcount($mailbox)
    {
        if (!empty($this->icache['threads']))
            return count($this->icache['threads']['tree']);
        $result = array();
        if (is_array($result = $this->_fetch_threads($mailbox)))
            $thread_tree = array_shift($result);
        if (!empty($this->icache['threads'])) {
            $result = array(
                'count'    => count($this->icache['threads']['tree']),
                'msgcount' => count($this->icache['threads']['depth']),
                'maxuid'   => max(array_keys($this->icache['threads']['depth'])),
            );
        }
        else if (is_array($result = $this->_fetch_threads($mailbox))) {
//        list ($thread_tree, $msg_depth, $has_children) = $result;
//        $this->update_thread_cache($mailbox, $thread_tree, $msg_depth, $has_children);
        return count($thread_tree);
            $result = array(
                'count'    => count($result[0]),
                'msgcount' => count($result[1]),
                'maxuid'   => max(array_keys($result[1])),
            );
        }
        return $result;
    }
    /**
     * Public method for listing headers
     * convert mailbox name with root dir first
@@ -611,11 +724,11 @@
     */
    function list_headers($mbox_name='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        return $this->_list_headers($mailbox, $page, $sort_field, $sort_order, false, $slice);
    }
    /**
     * Private method for listing message headers
     *
@@ -745,7 +858,7 @@
        return array_values($a_msg_headers);
    }
    /**
     * Private method for listing message headers using threads
     *
@@ -838,7 +951,7 @@
        // flatten threads array
        // @TODO: fetch children only in expanded mode (?)
        $all_ids = array();
        foreach($msg_index as $root) {
        foreach ($msg_index as $root) {
            $all_ids[] = $root;
            if (!empty($thread_tree[$root]))
                $all_ids = array_merge($all_ids, array_keys_recursive($thread_tree[$root]));
@@ -1150,7 +1263,7 @@
                $for_create[] = $headers->uid;
            }
            if ($for_remove)
                $this->remove_message_cache($cache_key, $for_remove);
@@ -1176,7 +1289,7 @@
     */
    function mailbox_status($mbox_name = null)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $old = $this->get_folder_stats($mailbox);
        // refresh message count -> will update
@@ -1243,11 +1356,11 @@
        $this->_set_sort_order($sort_field, $sort_order);
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.msgi";
        // we have a saved search result, get index from there
        if (!isset($this->cache[$key]) && $this->search_string
        if (!isset($this->icache[$key]) && $this->search_string
            && !$this->search_threads && $mailbox == $this->mailbox) {
            // use message index sort as default sorting
            if (!$this->sort_field) {
@@ -1257,9 +1370,9 @@
                    sort($msgs);
                if ($this->sort_order == 'DESC')
                    $this->cache[$key] = array_reverse($msgs);
                    $this->icache[$key] = array_reverse($msgs);
                else
                    $this->cache[$key] = $msgs;
                    $this->icache[$key] = $msgs;
            }
            // sort with SORT command
            else if ($this->search_sorted) {
@@ -1267,9 +1380,9 @@
                    $this->search('', $this->search_string, $this->search_charset, $this->sort_field);
                if ($this->sort_order == 'DESC')
                    $this->cache[$key] = array_reverse($this->search_set);
                    $this->icache[$key] = array_reverse($this->search_set);
                else
                    $this->cache[$key] = $this->search_set;
                    $this->icache[$key] = $this->search_set;
            }
            else {
                $a_index = $this->conn->fetchHeaderIndex($mailbox,
@@ -1281,17 +1394,17 @@
                    else if ($this->sort_order=="DESC")
                        arsort($a_index);
                    $this->cache[$key] = array_keys($a_index);
                    $this->icache[$key] = array_keys($a_index);
                }
                else {
                    $this->cache[$key] = array();
                    $this->icache[$key] = array();
                }
            }
        }
        // have stored it in RAM
        if (isset($this->cache[$key]))
            return $this->cache[$key];
        if (isset($this->icache[$key]))
            return $this->icache[$key];
        // check local cache
        $cache_key = $mailbox.'.msg';
@@ -1315,7 +1428,7 @@
            if ($a_index !== false && $this->sort_order == 'DESC')
                $a_index = array_reverse($a_index);
            $this->cache[$key] = $a_index;
            $this->icache[$key] = $a_index;
        }
        // fetch complete message index
        else if ($this->get_capability('SORT') &&
@@ -1325,7 +1438,7 @@
            if ($this->sort_order == 'DESC')
                $a_index = array_reverse($a_index);
            $this->cache[$key] = $a_index;
            $this->icache[$key] = $a_index;
        }
        else if ($a_index = $this->conn->fetchHeaderIndex(
            $mailbox, "1:*", $this->sort_field, $this->skip_deleted)) {
@@ -1334,10 +1447,10 @@
            else if ($this->sort_order=="DESC")
                arsort($a_index);
            $this->cache[$key] = array_keys($a_index);
            $this->icache[$key] = array_keys($a_index);
        }
        return $this->cache[$key] !== false ? $this->cache[$key] : array();
        return $this->icache[$key] !== false ? $this->icache[$key] : array();
    }
@@ -1353,20 +1466,20 @@
    {
        $this->_set_sort_order($sort_field, $sort_order);
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.thi";
        // we have a saved search result, get index from there
        if (!isset($this->cache[$key]) && $this->search_string
        if (!isset($this->icache[$key]) && $this->search_string
            && $this->search_threads && $mailbox == $this->mailbox) {
            // use message IDs for better performance
            $ids = array_keys_recursive($this->search_set['tree']);
            $this->cache[$key] = $this->_flatten_threads($mailbox, $this->search_set['tree'], $ids);
            $this->icache[$key] = $this->_flatten_threads($mailbox, $this->search_set['tree'], $ids);
        }
        // have stored it in RAM
        if (isset($this->cache[$key]))
            return $this->cache[$key];
        if (isset($this->icache[$key]))
            return $this->icache[$key];
/*
        // check local cache
        $cache_key = $mailbox.'.msg';
@@ -1381,9 +1494,9 @@
        // get all threads (default sort order)
        list ($thread_tree) = $this->_fetch_threads($mailbox);
        $this->cache[$key] = $this->_flatten_threads($mailbox, $thread_tree);
        $this->icache[$key] = $this->_flatten_threads($mailbox, $thread_tree);
        return $this->cache[$key];
        return $this->icache[$key];
    }
@@ -1410,7 +1523,7 @@
        // flatten threads array
        $all_ids = array();
        foreach($msg_index as $root) {
        foreach ($msg_index as $root) {
            $all_ids[] = $root;
            if (!empty($thread_tree[$root])) {
                foreach (array_keys_recursive($thread_tree[$root]) as $val)
@@ -1530,7 +1643,7 @@
        if (!$str)
            return false;
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $results = $this->_search_index($mailbox, $str, $charset, $sort_field);
@@ -1635,7 +1748,7 @@
        if (!$str)
            return false;
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        return $this->conn->search($mailbox, $str, $ret_uid);
    }
@@ -1812,7 +1925,7 @@
     */
    function get_headers($id, $mbox_name=NULL, $is_uid=true, $bodystr=false)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $uid = $is_uid ? $id : $this->_id2uid($id, $mailbox);
        // get cached headers
@@ -2341,11 +2454,11 @@
     * @param string  $flag       Flag to set: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT
     * @param string  $mbox_name  Folder name
     * @param boolean $skip_cache True to skip message cache clean up
     * @return int    Number of flagged messages, -1 on failure
     * @return boolean  Operation status
     */
    function set_flag($uids, $flag, $mbox_name=NULL, $skip_cache=false)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $flag = strtoupper($flag);
        list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
@@ -2355,7 +2468,7 @@
        else
            $result = $this->conn->flag($mailbox, $uids, $flag);
        if ($result >= 0) {
        if ($result) {
            // reload message headers if cached
            if ($this->caching_enabled && !$skip_cache) {
                $cache_key = $mailbox.'.msg';
@@ -2364,13 +2477,15 @@
                else
                    $this->remove_message_cache($cache_key, explode(',', $uids));
            }
            // update counters
            if ($flag=='SEEN')
                $this->_set_messagecount($mailbox, 'UNSEEN', $result*(-1));
            else if ($flag=='UNSEEN')
                $this->_set_messagecount($mailbox, 'UNSEEN', $result);
            else if ($flag=='DELETED')
                $this->_set_messagecount($mailbox, 'ALL', $result*(-1));
            // clear cached counters
            if ($flag == 'SEEN' || $flag == 'UNSEEN') {
                $this->_clear_messagecount($mailbox, 'SEEN');
                $this->_clear_messagecount($mailbox, 'UNSEEN');
            }
            else if ($flag == 'DELETED') {
                $this->_clear_messagecount($mailbox, 'DELETED');
            }
        }
        return $result;
@@ -2407,7 +2522,7 @@
        $mailbox = $this->mod_mailbox($mbox_name);
        // make sure mailbox exists
        if ($this->mailbox_exists($mbox_name, true)) {
        if ($this->mailbox_exists($mbox_name)) {
            if ($is_file)
                $saved = $this->conn->appendFromFile($mailbox, $message, $headers);
            else
@@ -2436,7 +2551,7 @@
        $fbox = $from_mbox;
        $tbox = $to_mbox;
        $to_mbox = $this->mod_mailbox($to_mbox);
        $from_mbox = $from_mbox ? $this->mod_mailbox($from_mbox) : $this->mailbox;
        $from_mbox = strlen($from_mbox) ? $this->mod_mailbox($from_mbox) : $this->mailbox;
        list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
@@ -2445,7 +2560,7 @@
            return false;
        // make sure mailbox exists
        if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox, true)) {
        if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox)) {
            if (in_array($tbox, $this->default_folders))
                $this->create_mailbox($tbox, true);
            else
@@ -2460,8 +2575,7 @@
        }
        // move messages
        $move = $this->conn->move($uids, $from_mbox, $to_mbox);
        $moved = !($move === false || $move < 0);
        $moved = $this->conn->move($uids, $from_mbox, $to_mbox);
        // send expunge command in order to have the moved message
        // really deleted from the source mailbox
@@ -2522,11 +2636,12 @@
        list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
        // exit if no message uids are specified
        if (empty($uids))
        if (empty($uids)) {
            return false;
        }
        // make sure mailbox exists
        if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox, true)) {
        if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox)) {
            if (in_array($tbox, $this->default_folders))
                $this->create_mailbox($tbox, true);
            else
@@ -2534,8 +2649,7 @@
        }
        // copy messages
        $copy = $this->conn->copy($uids, $from_mbox, $to_mbox);
        $copied = !($copy === false || $copy < 0);
        $copied = $this->conn->copy($uids, $from_mbox, $to_mbox);
        if ($copied) {
            $this->_clear_messagecount($to_mbox);
@@ -2554,7 +2668,7 @@
     */
    function delete_message($uids, $mbox_name='')
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
@@ -2607,14 +2721,12 @@
     */
    function clear_mailbox($mbox_name=NULL)
    {
        $mailbox = !empty($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $msg_count = $this->_messagecount($mailbox, 'ALL');
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        if (!$msg_count) {
            return 0;
        // SELECT will set messages count for clearFolder()
        if ($this->conn->select($mailbox)) {
            $cleared = $this->conn->clearFolder($mailbox);
        }
        $cleared = $this->conn->clearFolder($mailbox);
        // make sure the message count cache is cleared as well
        if ($cleared) {
@@ -2637,7 +2749,7 @@
     */
    function expunge($mbox_name='', $clear_cache=true)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        return $this->_expunge($mailbox, $clear_cache);
    }
@@ -2661,7 +2773,7 @@
        $result = $this->conn->expunge($mailbox, $a_uids);
        if ($result>=0 && $clear_cache) {
        if ($result && $clear_cache) {
            $this->clear_message_cache($mailbox.'.msg');
            $this->_clear_messagecount($mailbox);
        }
@@ -2722,7 +2834,7 @@
     */
    function get_id($uid, $mbox_name=NULL)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        return $this->_uid2id($uid, $mailbox);
    }
@@ -2734,9 +2846,9 @@
     * @param string $mbox_name Mailbox name
     * @return int   Message UID
     */
    function get_uid($id,$mbox_name=NULL)
    function get_uid($id, $mbox_name=NULL)
    {
        $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
        return $this->_id2uid($id, $mailbox);
    }
@@ -2762,7 +2874,7 @@
        $a_mboxes = $this->_list_mailboxes($root, $filter);
        foreach ($a_mboxes as $idx => $mbox_row) {
            if ($name = $this->mod_mailbox($mbox_row, 'out'))
            if (strlen($name = $this->mod_mailbox($mbox_row, 'out')))
                $a_out[] = $name;
            unset($a_mboxes[$idx]);
        }
@@ -2804,8 +2916,29 @@
            $a_folders = $data['folders'];
        }
        else {
            // retrieve list of folders from IMAP server
            $a_folders = $this->conn->listSubscribed($this->mod_mailbox($root), $filter);
            // Server supports LIST-EXTENDED, we can use selection options
            $config = rcmail::get_instance()->config;
            // #1486225: Some dovecot versions returns wrong result using LIST-EXTENDED
            if (!$config->get('imap_force_lsub') && $this->get_capability('LIST-EXTENDED')) {
                // This will also set mailbox options, LSUB doesn't do that
                $a_folders = $this->conn->listMailboxes($this->mod_mailbox($root), $filter,
                    NULL, array('SUBSCRIBED'));
                // remove non-existent folders
                if (is_array($a_folders)) {
                    foreach ($a_folders as $idx => $folder) {
                        if ($this->conn->data['LIST'] && ($opts = $this->conn->data['LIST'][$folder])
                            && in_array('\\NonExistent', $opts)
                        ) {
                            unset($a_folders[$idx]);
                        }
                    }
                }
            }
            // retrieve list of folders from IMAP server using LSUB
            else {
                $a_folders = $this->conn->listSubscribed($this->mod_mailbox($root), $filter);
            }
        }
        if (!is_array($a_folders) || !sizeof($a_folders))
@@ -2845,7 +2978,7 @@
        // modify names with root dir
        foreach ($a_mboxes as $idx => $mbox_name) {
            if ($name = $this->mod_mailbox($mbox_name, 'out'))
            if (strlen($name = $this->mod_mailbox($mbox_name, 'out')))
                $a_folders[] = $name;
            unset($a_mboxes[$idx]);
        }
@@ -3000,10 +3133,11 @@
            $a_mboxes = explode(',', $mbox_name);
        if (is_array($a_mboxes)) {
            $delimiter = $this->get_hierarchy_delimiter();
            foreach ($a_mboxes as $mbox_name) {
                $mailbox = $this->mod_mailbox($mbox_name);
                $sub_mboxes = $this->conn->listMailboxes($this->mod_mailbox(''),
                   $mbox_name . $this->delimiter . '*');
                $sub_mboxes = $this->conn->listMailboxes('', $mbox_name . $delimiter . '*');
                // unsubscribe mailbox before deleting
                $this->conn->unsubscribe($mailbox);
@@ -3060,25 +3194,25 @@
     */
    function mailbox_exists($mbox_name, $subscription=false)
    {
        if ($mbox_name) {
            if ($mbox_name == 'INBOX')
                return true;
        if ($mbox_name == 'INBOX')
            return true;
            $key = $subscription ? 'subscribed' : 'existing';
            if (is_array($this->icache[$key]) && in_array($mbox_name, $this->icache[$key]))
                return true;
        $key  = $subscription ? 'subscribed' : 'existing';
        $mbox = $this->mod_mailbox($mbox_name);
            if ($subscription) {
                $a_folders = $this->conn->listSubscribed($this->mod_mailbox(''), $mbox_name);
            }
            else {
                $a_folders = $this->conn->listMailboxes($this->mod_mailbox(''), $mbox_name);
           }
        if (is_array($this->icache[$key]) && in_array($mbox, $this->icache[$key]))
            return true;
            if (is_array($a_folders) && in_array($this->mod_mailbox($mbox_name), $a_folders)) {
                $this->icache[$key][] = $mbox_name;
                return true;
            }
        if ($subscription) {
            $a_folders = $this->conn->listSubscribed('', $mbox);
        }
        else {
            $a_folders = $this->conn->listMailboxes('', $mbox);
       }
        if (is_array($a_folders) && in_array($mbox, $a_folders)) {
            $this->icache[$key][] = $mbox;
            return true;
        }
        return false;
@@ -3094,17 +3228,87 @@
     */
    function mod_mailbox($mbox_name, $mode='in')
    {
        if ($mbox_name == 'INBOX')
            return $mbox_name;
        if (!strlen($mbox_name))
            return '';
        if (!empty($this->root_dir)) {
            if ($mode=='in')
                $mbox_name = $this->root_dir.$this->delimiter.$mbox_name;
            else if (!empty($mbox_name)) // $mode=='out'
                $mbox_name = substr($mbox_name, strlen($this->root_dir)+1);
        if ($mode == 'in') {
            // If folder contains namespace prefix, don't modify it
            if (is_array($this->namespace['shared'])) {
                foreach ($this->namespace['shared'] as $ns) {
                    foreach ((array)$ns as $root) {
                        if (strpos($mbox_name, $root[0]) === 0) {
                            return $mbox_name;
                        }
                    }
                }
            }
            if (is_array($this->namespace['other'])) {
                foreach ($this->namespace['other'] as $ns) {
                    foreach ((array)$ns as $root) {
                        if (strpos($mbox_name, $root[0]) === 0) {
                            return $mbox_name;
                        }
                    }
                }
            }
            if (is_array($this->namespace['personal'])) {
                foreach ($this->namespace['personal'] as $ns) {
                    foreach ((array)$ns as $root) {
                        if ($root[0] && strpos($mbox_name, $root[0]) === 0) {
                            return $mbox_name;
                        }
                    }
                }
                // Add prefix if first personal namespace is non-empty
                if ($this->namespace['personal'][0][0]) {
                    return $this->namespace['personal'][0][0].$mbox_name;
                }
            }
        }
        else {
            // Remove prefix if folder is from first ("non-empty") personal namespace
            if (is_array($this->namespace['personal'])) {
                if ($prefix = $this->namespace['personal'][0][0]) {
                    if (strpos($mbox_name, $prefix) === 0) {
                        return substr($mbox_name, strlen($prefix));
                    }
                }
            }
        }
        return $mbox_name;
    }
    /**
     * Gets folder options from LIST response, e.g. \Noselect, \Noinferiors
     *
     * @param string $mbox_name Folder name
     * @param bool   $force     Set to True if options should be refreshed
     *                          Options are available after LIST command only
     *
     * @return array Options list
     */
    function mailbox_options($mbox_name, $force=false)
    {
        $mbox = $this->mod_mailbox($mbox_name);
        if ($mbox == 'INBOX') {
            return array();
        }
        if (!is_array($this->conn->data['LIST']) || !is_array($this->conn->data['LIST'][$mbox])) {
            if ($force) {
                $this->conn->listMailboxes('', $mbox_name);
            }
            else {
                return array();
            }
        }
        $opts = $this->conn->data['LIST'][$mbox];
        return is_array($opts) ? $opts : array();
    }
@@ -3122,6 +3326,251 @@
            $headers = array_merge($headers, $this->all_headers);
        return implode(' ', array_unique($headers));
    }
    /* -----------------------------------------
     *   ACL and METADATA/ANNOTATEMORE methods
     * ----------------------------------------*/
    /**
     * Changes the ACL on the specified mailbox (SETACL)
     *
     * @param string $mailbox Mailbox name
     * @param string $user    User name
     * @param string $acl     ACL string
     *
     * @return boolean True on success, False on failure
     *
     * @access public
     * @since 0.5-beta
     */
    function set_acl($mailbox, $user, $acl)
    {
        $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('ACL'))
            return $this->conn->setACL($mailbox, $user, $acl);
        return false;
    }
    /**
     * Removes any <identifier,rights> pair for the
     * specified user from the ACL for the specified
     * mailbox (DELETEACL)
     *
     * @param string $mailbox Mailbox name
     * @param string $user    User name
     *
     * @return boolean True on success, False on failure
     *
     * @access public
     * @since 0.5-beta
     */
    function delete_acl($mailbox, $user)
    {
        $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('ACL'))
            return $this->conn->deleteACL($mailbox, $user);
        return false;
    }
    /**
     * Returns the access control list for mailbox (GETACL)
     *
     * @param string $mailbox Mailbox name
     *
     * @return array User-rights array on success, NULL on error
     * @access public
     * @since 0.5-beta
     */
    function get_acl($mailbox)
    {
        $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('ACL'))
            return $this->conn->getACL($mailbox);
        return NULL;
    }
    /**
     * Returns information about what rights can be granted to the
     * user (identifier) in the ACL for the mailbox (LISTRIGHTS)
     *
     * @param string $mailbox Mailbox name
     * @param string $user    User name
     *
     * @return array List of user rights
     * @access public
     * @since 0.5-beta
     */
    function list_rights($mailbox, $user)
    {
        $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('ACL'))
            return $this->conn->listRights($mailbox, $user);
        return NULL;
    }
    /**
     * Returns the set of rights that the current user has to
     * mailbox (MYRIGHTS)
     *
     * @param string $mailbox Mailbox name
     *
     * @return array MYRIGHTS response on success, NULL on error
     * @access public
     * @since 0.5-beta
     */
    function my_rights($mailbox)
    {
        $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('ACL'))
            return $this->conn->myRights($mailbox);
        return NULL;
    }
    /**
     * Sets IMAP metadata/annotations (SETMETADATA/SETANNOTATION)
     *
     * @param string $mailbox Mailbox name (empty for server metadata)
     * @param array  $entries Entry-value array (use NULL value as NIL)
     *
     * @return boolean True on success, False on failure
     * @access public
     * @since 0.5-beta
     */
    function set_metadata($mailbox, $entries)
    {
        if ($mailbox)
            $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('METADATA') ||
            (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
        ) {
            return $this->conn->setMetadata($mailbox, $entries);
        }
        else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
            foreach ($entries as $entry => $value) {
                list($ent, $attr) = $this->md2annotate($entry);
                $entries[$entry] = array($ent, $attr, $value);
            }
            return $this->conn->setAnnotation($mailbox, $entries);
        }
        return false;
    }
    /**
     * Unsets IMAP metadata/annotations (SETMETADATA/SETANNOTATION)
     *
     * @param string $mailbox Mailbox name (empty for server metadata)
     * @param array  $entries Entry names array
     *
     * @return boolean True on success, False on failure
     *
     * @access public
     * @since 0.5-beta
     */
    function delete_metadata($mailbox, $entries)
    {
        if ($mailbox)
            $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('METADATA') ||
            (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
        ) {
            return $this->conn->deleteMetadata($mailbox, $entries);
        }
        else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
            foreach ($entries as $idx => $entry) {
                list($ent, $attr) = $this->md2annotate($entry);
                $entries[$idx] = array($ent, $attr, NULL);
            }
            return $this->conn->setAnnotation($mailbox, $entries);
        }
        return false;
    }
    /**
     * Returns IMAP metadata/annotations (GETMETADATA/GETANNOTATION)
     *
     * @param string $mailbox Mailbox name (empty for server metadata)
     * @param array  $entries Entries
     * @param array  $options Command options (with MAXSIZE and DEPTH keys)
     *
     * @return array Metadata entry-value hash array on success, NULL on error
     *
     * @access public
     * @since 0.5-beta
     */
    function get_metadata($mailbox, $entries, $options=array())
    {
        if ($mailbox)
            $mailbox = $this->mod_mailbox($mailbox);
        if ($this->get_capability('METADATA') ||
            !strlen(($mailbox) && $this->get_capability('METADATA-SERVER'))
        ) {
            return $this->conn->getMetadata($mailbox, $entries, $options);
        }
        else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
            $queries = array();
            $res     = array();
            // Convert entry names
            foreach ($entries as $entry) {
                list($ent, $attr) = $this->md2annotate($entry);
                $queries[$attr][] = $ent;
            }
            // @TODO: Honor MAXSIZE and DEPTH options
            foreach ($queries as $attrib => $entry)
                if ($result = $this->conn->getAnnotation($mailbox, $entry, $attrib))
                    $res = array_merge($res, $result);
            return $res;
        }
        return NULL;
    }
    /**
     * Converts the METADATA extension entry name into the correct
     * entry-attrib names for older ANNOTATEMORE version.
     *
     * @param string Entry name
     *
     * @return array Entry-attribute list, NULL if not supported (?)
     */
    private function md2annotate($name)
    {
        if (substr($entry, 0, 7) == '/shared') {
            return array(substr($entry, 7), 'value.shared');
        }
        else if (substr($entry, 0, 8) == '/private') {
            return array(substr($entry, 8), 'value.priv');
        }
        // @TODO: log error
        return NULL;
    }
@@ -3339,45 +3788,43 @@
        $cache_count = count($cache_index);
        // empty mailbox
        if (!$msg_count)
        if (!$msg_count) {
            return $cache_count ? -2 : 1;
        }
        if ($cache_count==$msg_count) {
        if ($cache_count == $msg_count) {
            if ($this->skip_deleted) {
               $h_index = $this->conn->fetchHeaderIndex($mailbox, "1:*", 'UID', $this->skip_deleted);
                // Save index in internal cache, will be used when syncing the cache
                $this->icache['folder_index'] = $h_index;
                if (empty($h_index))
                    return -2;
               if (sizeof($h_index) == $cache_count) {
                   $cache_index = array_flip($cache_index);
                   foreach ($h_index as $idx => $uid)
                        unset($cache_index[$uid]);
                   if (empty($cache_index))
                       return 1;
               }
               return -2;
                if (!empty($this->icache['all_undeleted_idx'])) {
                    $uids = rcube_imap_generic::uncompressMessageSet($this->icache['all_undeleted_idx']);
                    $uids = array_flip($uids);
                    foreach ($cache_index as $uid) {
                        unset($uids[$uid]);
                    }
                }
                else {
                    // get all undeleted messages excluding cached UIDs
                    $uids = $this->search_once($mailbox, 'ALL UNDELETED NOT UID '.
                        rcube_imap_generic::compressMessageSet($cache_index));
                }
                if (empty($uids)) {
                    return 1;
                }
            } else {
                // get UID of the message with highest index
                $uid = $this->_id2uid($msg_count, $mailbox);
                $cache_uid = array_pop($cache_index);
                // uids of highest message matches -> cache seems OK
                if ($cache_uid == $uid)
                if ($cache_uid == $uid) {
                    return 1;
                }
            }
            // cache is dirty
            return -1;
        }
        // if cache count differs less than 10% report as dirty
        else if (abs($msg_count - $cache_count) < $msg_count/10)
            return -1;
        else
            return -2;
        return (abs($msg_count - $cache_count) < $msg_count/10) ? -1 : -2;
    }
@@ -3751,10 +4198,7 @@
        foreach ($a as $val) {
            $j++;
            $address = trim($val['address']);
            $name = trim($val['name']);
            if ($name && preg_match('/^[\'"]/', $name) && preg_match('/[\'"]$/', $name))
                $name = trim($name, '\'"');
            $name    = trim($val['name']);
            if ($name && $address && $name != $address)
                $string = sprintf('%s <%s>', preg_match("/$special_chars/", $name) ? '"'.addcslashes($name, '"').'"' : $name, $address);
@@ -4013,7 +4457,7 @@
     */
    private function _uid2id($uid, $mbox_name=NULL)
    {
        if (!$mbox_name)
        if (!strlen($mbox_name))
            $mbox_name = $this->mailbox;
        if (!isset($this->uid_id_map[$mbox_name][$uid])) {
@@ -4035,7 +4479,7 @@
     */
    private function _id2uid($id, $mbox_name=NULL)
    {
        if (!$mbox_name)
        if (!strlen($mbox_name))
            $mbox_name = $this->mailbox;
        if ($uid = array_search($id, (array)$this->uid_id_map[$mbox_name]))
@@ -4096,7 +4540,7 @@
    private function _set_messagecount($mbox_name, $mode, $increment)
    {
        $a_mailbox_cache = false;
        $mailbox = $mbox_name ? $mbox_name : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $mbox_name : $this->mailbox;
        $mode = strtoupper($mode);
        $a_mailbox_cache = $this->get_cache('messagecount');
@@ -4122,15 +4566,19 @@
     * Remove messagecount of a specific mailbox from cache
     * @access private
     */
    private function _clear_messagecount($mbox_name='')
    private function _clear_messagecount($mbox_name='', $mode=null)
    {
        $a_mailbox_cache = false;
        $mailbox = $mbox_name ? $mbox_name : $this->mailbox;
        $mailbox = strlen($mbox_name) ? $mbox_name : $this->mailbox;
        $a_mailbox_cache = $this->get_cache('messagecount');
        if (is_array($a_mailbox_cache[$mailbox])) {
            unset($a_mailbox_cache[$mailbox]);
            if ($mode) {
                unset($a_mailbox_cache[$mailbox][$mode]);
            }
            else {
                unset($a_mailbox_cache[$mailbox]);
            }
            $this->update_cache('messagecount', $a_mailbox_cache);
        }
    }
@@ -4170,22 +4618,40 @@
        $result = array();
        foreach ($a as $key => $val) {
            $val = preg_replace("/([\"\w])</", "$1 <", $val);
            $sub_a = rcube_explode_quoted_string(' ', $decode ? $this->decode_header($val) : $val);
            $result[$key]['name'] = '';
            $name    = '';
            $address = '';
            $val     = trim($val);
            foreach ($sub_a as $k => $v) {
               // use angle brackets in regexp to not handle names with @ sign
                if (preg_match('/^<\S+@\S+>$/', $v))
                    $result[$key]['address'] = trim($v, '<>');
                else
                    $result[$key]['name'] .= (empty($result[$key]['name'])?'':' ').str_replace("\"",'',stripslashes($v));
            if (preg_match('/(.*)<(\S+@\S+)>$/', $val, $m)) {
                $address = $m[2];
                $name    = trim($m[1]);
            }
            else if (preg_match('/^(\S+@\S+)$/', $val, $m)) {
                $address = $m[1];
                $name    = '';
            }
            else {
                $name = $val;
            }
//          if (empty($result[$key]['name']))
//              $result[$key]['name'] = $result[$key]['address'];
            if (empty($result[$key]['address']))
                $result[$key]['address'] = $result[$key]['name'];
            // dequote and/or decode name
            if ($name) {
                if ($name[0] == '"') {
                    $name = substr($name, 1, -1);
                    $name = stripslashes($name);
                }
                if ($decode) {
                    $name = $this->decode_header($name);
                }
            }
            if (!$address && $name) {
                $address = $name;
            }
            if ($address) {
                $result[$key] = array('name' => $name, 'address' => $address);
            }
        }
        return $result;