| | |
| | | { |
| | | 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; |
| | |
| | | * @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; |
| | |
| | | $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 |
| | | $rootdir = $this->conn->getRootDir(); |
| | | if (!empty($rootdir)) |
| | | $this->set_rootdir($rootdir); |
| | | if (empty($this->delimiter)) |
| | | $this->get_hierarchy_delimiter(); |
| | | // get namespace and delimiter |
| | | $this->set_env(); |
| | | |
| | | return true; |
| | | } |
| | |
| | | function set_options($opt) |
| | | { |
| | | $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(); |
| | | } |
| | | |
| | | |
| | |
| | | */ |
| | | 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; |
| | | } |
| | | |
| | | |
| | |
| | | */ |
| | | 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); |
| | | } |
| | | |
| | |
| | | { |
| | | $mode = strtoupper($mode); |
| | | |
| | | if (empty($mailbox)) |
| | | if (!strlen($mailbox)) |
| | | $mailbox = $this->mailbox; |
| | | |
| | | // count search set |
| | |
| | | */ |
| | | 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); |
| | | } |
| | | |
| | |
| | | // 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])); |
| | |
| | | */ |
| | | 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 |
| | |
| | | |
| | | $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 |
| | |
| | | { |
| | | $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 |
| | |
| | | |
| | | // 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) |
| | |
| | | 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); |
| | | |
| | |
| | | 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); |
| | | } |
| | |
| | | */ |
| | | 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 |
| | |
| | | */ |
| | | 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); |
| | |
| | | $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); |
| | | |
| | |
| | | */ |
| | | 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); |
| | | |
| | |
| | | */ |
| | | function clear_mailbox($mbox_name=NULL) |
| | | { |
| | | $mailbox = !empty($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | |
| | | // SELECT will set messages count for clearFolder() |
| | | if ($this->conn->select($mailbox)) { |
| | |
| | | */ |
| | | 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); |
| | | } |
| | | |
| | |
| | | */ |
| | | 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); |
| | | } |
| | | |
| | |
| | | * @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); |
| | | } |
| | | |
| | |
| | | $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]); |
| | | } |
| | |
| | | |
| | | // 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]); |
| | | } |
| | |
| | | $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); |
| | |
| | | */ |
| | | 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; |
| | |
| | | */ |
| | | 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; |
| | |
| | | |
| | | if (!is_array($this->conn->data['LIST']) || !is_array($this->conn->data['LIST'][$mbox])) { |
| | | if ($force) { |
| | | $this->conn->listMailboxes($this->mod_mailbox(''), $mbox_name); |
| | | $this->conn->listMailboxes('', $mbox_name); |
| | | } |
| | | else { |
| | | return array(); |
| | |
| | | if ($mailbox) |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('METADATA') || |
| | | empty($mailbox) && $this->get_capability('METADATA-SERVER') |
| | | if ($this->get_capability('METADATA') || |
| | | (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) |
| | | ) { |
| | | return $this->conn->setMetadata($mailbox, $entries); |
| | | } |
| | |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('METADATA') || |
| | | empty($mailbox) && $this->get_capability('METADATA-SERVER') |
| | | (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) |
| | | ) { |
| | | return $this->conn->deleteMetadata($mailbox, $entries); |
| | | } |
| | |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('METADATA') || |
| | | empty($mailbox) && $this->get_capability('METADATA-SERVER') |
| | | !strlen(($mailbox) && $this->get_capability('METADATA-SERVER')) |
| | | ) { |
| | | return $this->conn->getMetadata($mailbox, $entries, $options); |
| | | } |
| | |
| | | */ |
| | | 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])) { |
| | |
| | | */ |
| | | 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])) |
| | |
| | | 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'); |
| | |
| | | */ |
| | | private function _clear_messagecount($mbox_name='', $mode=null) |
| | | { |
| | | $mailbox = $mbox_name ? $mbox_name : $this->mailbox; |
| | | $mailbox = strlen($mbox_name) ? $mbox_name : $this->mailbox; |
| | | |
| | | $a_mailbox_cache = $this->get_cache('messagecount'); |
| | | |