| | |
| | | | program/include/rcube_imap.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2005-2010, Roundcube Dev. - Switzerland | |
| | | | Copyright (C) 2005-2010, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | |
| | | $this->options['port'] = $port; |
| | | |
| | | if ($this->options['debug']) |
| | | if ($this->options['debug']) { |
| | | $this->conn->setDebug(true, array($this, 'debug_handler')); |
| | | |
| | | $this->options['ident'] = array( |
| | | 'name' => 'Roundcube Webmail', |
| | | 'version' => RCMAIL_VERSION, |
| | | 'php' => PHP_VERSION, |
| | | 'os' => PHP_OS, |
| | | 'command' => $_SERVER['REQUEST_URI'], |
| | | ); |
| | | } |
| | | |
| | | $attempt = 0; |
| | | do { |
| | |
| | | * |
| | | * All operations will be perfomed on this mailbox/folder |
| | | * |
| | | * @param string $new_mbox Mailbox/Folder name |
| | | * @param string $mailbox Mailbox/Folder name |
| | | * @access public |
| | | */ |
| | | function set_mailbox($new_mbox) |
| | | function set_mailbox($mailbox) |
| | | { |
| | | $mailbox = $this->mod_mailbox($new_mbox); |
| | | |
| | | if ($this->mailbox == $mailbox) |
| | | return; |
| | | |
| | |
| | | */ |
| | | function select_mailbox($mailbox=null) |
| | | { |
| | | $mailbox = strlen($mailbox) ? $this->mod_mailbox($mailbox) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | $selected = $this->conn->select($mailbox); |
| | | |
| | |
| | | */ |
| | | function get_mailbox_name() |
| | | { |
| | | return $this->conn->connected() ? $this->mod_mailbox($this->mailbox, 'out') : ''; |
| | | return $this->conn->connected() ? $this->mailbox : ''; |
| | | } |
| | | |
| | | |
| | |
| | | { |
| | | $this->threading = false; |
| | | |
| | | if ($enable) { |
| | | if ($this->get_capability('THREAD=REFS')) |
| | | if ($enable && ($caps = $this->get_capability('THREAD'))) { |
| | | if (in_array('REFS', $caps)) |
| | | $this->threading = 'REFS'; |
| | | else if ($this->get_capability('THREAD=REFERENCES')) |
| | | else if (in_array('REFERENCES', $caps)) |
| | | $this->threading = 'REFERENCES'; |
| | | else if ($this->get_capability('THREAD=ORDEREDSUBJECT')) |
| | | else if (in_array('ORDEREDSUBJECT', $caps)) |
| | | $this->threading = 'ORDEREDSUBJECT'; |
| | | } |
| | | |
| | |
| | | /** |
| | | * Get namespace |
| | | * |
| | | * @param string $name Namespace array index: personal, other, shared, prefix |
| | | * |
| | | * @return array Namespace data |
| | | * @access public |
| | | */ |
| | | function get_namespace() |
| | | function get_namespace($name=null) |
| | | { |
| | | return $this->namespace; |
| | | $ns = $this->namespace; |
| | | |
| | | if ($name) { |
| | | return isset($ns[$name]) ? $ns[$name] : null; |
| | | } |
| | | |
| | | unset($ns['prefix']); |
| | | return $ns; |
| | | } |
| | | |
| | | |
| | |
| | | } |
| | | } |
| | | |
| | | // Find personal namespace prefix for mod_mailbox() |
| | | // Prefix can be removed when there is only one personal namespace |
| | | if (is_array($this->namespace['personal']) && count($this->namespace['personal']) == 1) { |
| | | $this->namespace['prefix'] = $this->namespace['personal'][0][0]; |
| | | } |
| | | |
| | | $_SESSION['imap_namespace'] = $this->namespace; |
| | | $_SESSION['imap_delimiter'] = $this->delimiter; |
| | | } |
| | |
| | | /** |
| | | * Get message count for a specific mailbox |
| | | * |
| | | * @param string $mbox_name Mailbox/folder name |
| | | * @param string $mode Mode for count [ALL|THREADS|UNSEEN|RECENT] |
| | | * @param boolean $force Force reading from server and update cache |
| | | * @param boolean $status Enables storing folder status info (max UID/count), |
| | | * required for mailbox_status() |
| | | * @param string $mailbox Mailbox/folder name |
| | | * @param string $mode Mode for count [ALL|THREADS|UNSEEN|RECENT] |
| | | * @param boolean $force Force reading from server and update cache |
| | | * @param boolean $status Enables storing folder status info (max UID/count), |
| | | * required for mailbox_status() |
| | | * @return int Number of messages |
| | | * @access public |
| | | */ |
| | | function messagecount($mbox_name='', $mode='ALL', $force=false, $status=true) |
| | | function messagecount($mailbox='', $mode='ALL', $force=false, $status=true) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | return $this->_messagecount($mailbox, $mode, $force, $status); |
| | | } |
| | | |
| | |
| | | * @access private |
| | | * @see rcube_imap::messagecount() |
| | | */ |
| | | private function _messagecount($mailbox='', $mode='ALL', $force=false, $status=true) |
| | | private function _messagecount($mailbox, $mode='ALL', $force=false, $status=true) |
| | | { |
| | | $mode = strtoupper($mode); |
| | | |
| | | if (!strlen($mailbox)) |
| | | $mailbox = $this->mailbox; |
| | | |
| | | // count search set |
| | | if ($this->search_string && $mailbox == $this->mailbox && ($mode == 'ALL' || $mode == 'THREADS') && !$force) { |
| | |
| | | * Public method for listing headers |
| | | * convert mailbox name with root dir first |
| | | * |
| | | * @param string $mbox_name Mailbox/folder name |
| | | * @param string $mailbox Mailbox/folder name |
| | | * @param int $page Current page to list |
| | | * @param string $sort_field Header field to sort by |
| | | * @param string $sort_order Sort order [ASC|DESC] |
| | |
| | | * @return array Indexed array with message header objects |
| | | * @access public |
| | | */ |
| | | function list_headers($mbox_name='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) |
| | | function list_headers($mailbox='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | return $this->_list_headers($mailbox, $page, $sort_field, $sort_order, false, $slice); |
| | | } |
| | | |
| | |
| | | * We compare the maximum UID to determine the number of |
| | | * new messages because the RECENT flag is not reliable. |
| | | * |
| | | * @param string $mbox_name Mailbox/folder name |
| | | * @param string $mailbox Mailbox/folder name |
| | | * @return int Folder status |
| | | */ |
| | | function mailbox_status($mbox_name = null) |
| | | function mailbox_status($mailbox = null) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | $old = $this->get_folder_stats($mailbox); |
| | | |
| | | // refresh message count -> will update |
| | |
| | | * Stores folder statistic data in session |
| | | * @TODO: move to separate DB table (cache?) |
| | | * |
| | | * @param string $mbox_name Mailbox name |
| | | * @param string $name Data name |
| | | * @param mixed $data Data value |
| | | * @param string $mailbox Mailbox name |
| | | * @param string $name Data name |
| | | * @param mixed $data Data value |
| | | */ |
| | | private function set_folder_stats($mbox_name, $name, $data) |
| | | private function set_folder_stats($mailbox, $name, $data) |
| | | { |
| | | $_SESSION['folders'][$mbox_name][$name] = $data; |
| | | $_SESSION['folders'][$mailbox][$name] = $data; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Gets folder statistic data |
| | | * |
| | | * @param string $mbox_name Mailbox name |
| | | * @param string $mailbox Mailbox name |
| | | * |
| | | * @return array Stats data |
| | | */ |
| | | private function get_folder_stats($mbox_name) |
| | | private function get_folder_stats($mailbox) |
| | | { |
| | | if ($_SESSION['folders'][$mbox_name]) |
| | | return (array) $_SESSION['folders'][$mbox_name]; |
| | | if ($_SESSION['folders'][$mailbox]) |
| | | return (array) $_SESSION['folders'][$mailbox]; |
| | | else |
| | | return array(); |
| | | } |
| | |
| | | /** |
| | | * Return sorted array of message IDs (not UIDs) |
| | | * |
| | | * @param string $mbox_name Mailbox to get index from |
| | | * @param string $mailbox Mailbox to get index from |
| | | * @param string $sort_field Sort column |
| | | * @param string $sort_order Sort order [ASC, DESC] |
| | | * @return array Indexed array with message IDs |
| | | */ |
| | | function message_index($mbox_name='', $sort_field=NULL, $sort_order=NULL) |
| | | function message_index($mailbox='', $sort_field=NULL, $sort_order=NULL) |
| | | { |
| | | if ($this->threading) |
| | | return $this->thread_index($mbox_name, $sort_field, $sort_order); |
| | | return $this->thread_index($mailbox, $sort_field, $sort_order); |
| | | |
| | | $this->_set_sort_order($sort_field, $sort_order); |
| | | |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | $key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.msgi"; |
| | | |
| | | // we have a saved search result, get index from there |
| | |
| | | /** |
| | | * Return sorted array of threaded message IDs (not UIDs) |
| | | * |
| | | * @param string $mbox_name Mailbox to get index from |
| | | * @param string $mailbox Mailbox to get index from |
| | | * @param string $sort_field Sort column |
| | | * @param string $sort_order Sort order [ASC, DESC] |
| | | * @return array Indexed array with message IDs |
| | | */ |
| | | function thread_index($mbox_name='', $sort_field=NULL, $sort_order=NULL) |
| | | function thread_index($mailbox='', $sort_field=NULL, $sort_order=NULL) |
| | | { |
| | | $this->_set_sort_order($sort_field, $sort_order); |
| | | |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | $key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.thi"; |
| | | |
| | | // we have a saved search result, get index from there |
| | |
| | | /** |
| | | * Invoke search request to IMAP server |
| | | * |
| | | * @param string $mbox_name Mailbox name to search in |
| | | * @param string $mailbox Mailbox name to search in |
| | | * @param string $str Search criteria |
| | | * @param string $charset Search charset |
| | | * @param string $sort_field Header field to sort by |
| | | * @return array search results as list of message IDs |
| | | * @access public |
| | | */ |
| | | function search($mbox_name='', $str=NULL, $charset=NULL, $sort_field=NULL) |
| | | function search($mailbox='', $str=NULL, $charset=NULL, $sort_field=NULL) |
| | | { |
| | | if (!$str) |
| | | return false; |
| | | |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | $results = $this->_search_index($mailbox, $str, $charset, $sort_field); |
| | | |
| | |
| | | * Direct (real and simple) SEARCH request to IMAP server, |
| | | * without result sorting and caching |
| | | * |
| | | * @param string $mbox_name Mailbox name to search in |
| | | * @param string $str Search string |
| | | * @param boolean $ret_uid True if UIDs should be returned |
| | | * @param string $mailbox Mailbox name to search in |
| | | * @param string $str Search string |
| | | * @param boolean $ret_uid True if UIDs should be returned |
| | | * @return array Search results as list of message IDs or UIDs |
| | | * @access public |
| | | */ |
| | | function search_once($mbox_name='', $str=NULL, $ret_uid=false) |
| | | function search_once($mailbox='', $str=NULL, $ret_uid=false) |
| | | { |
| | | if (!$str) |
| | | return false; |
| | | |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | return $this->conn->search($mailbox, $str, $ret_uid); |
| | | } |
| | |
| | | /** |
| | | * Return message headers object of a specific message |
| | | * |
| | | * @param int $id Message ID |
| | | * @param string $mbox_name Mailbox to read from |
| | | * @param boolean $is_uid True if $id is the message UID |
| | | * @param boolean $bodystr True if we need also BODYSTRUCTURE in headers |
| | | * @param int $id Message ID |
| | | * @param string $mailbox Mailbox to read from |
| | | * @param boolean $is_uid True if $id is the message UID |
| | | * @param boolean $bodystr True if we need also BODYSTRUCTURE in headers |
| | | * @return object Message headers representation |
| | | */ |
| | | function get_headers($id, $mbox_name=NULL, $is_uid=true, $bodystr=false) |
| | | function get_headers($id, $mailbox=null, $is_uid=true, $bodystr=false) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | $uid = $is_uid ? $id : $this->_id2uid($id, $mailbox); |
| | | |
| | | // get cached headers |
| | |
| | | return false; |
| | | } |
| | | |
| | | $struct = &$this->_structure_part($structure); |
| | | $struct = &$this->_structure_part($structure, 0, '', $headers); |
| | | $struct->headers = get_object_vars($headers); |
| | | |
| | | // don't trust given content-type |
| | |
| | | $struct->charset = $struct->ctype_parameters['charset']; |
| | | } |
| | | |
| | | // #1487700: workaround for lack of charset in malformed structure |
| | | if (empty($struct->charset) && !empty($mime_headers) && $mime_headers->charset) { |
| | | $struct->charset = $mime_headers->charset; |
| | | } |
| | | |
| | | // read content encoding |
| | | if (!empty($part[5]) && $part[5]!='NIL') { |
| | | $struct->encoding = strtolower($part[5]); |
| | |
| | | $mime_headers = $this->conn->fetchPartHeader( |
| | | $this->mailbox, $this->_msg_id, false, $struct->mime_id); |
| | | } |
| | | $struct->headers = $this->_parse_headers($mime_headers) + $struct->headers; |
| | | |
| | | if (is_string($mime_headers)) |
| | | $struct->headers = $this->_parse_headers($mime_headers) + $struct->headers; |
| | | else if (is_object($mime_headers)) |
| | | $struct->headers = get_object_vars($mime_headers) + $struct->headers; |
| | | |
| | | // get real content-type of message/rfc822 |
| | | if ($struct->mimetype == 'message/rfc822') { |
| | |
| | | * @param rcube_message_part $o_part Part object created by get_structure() |
| | | * @param mixed $print True to print part, ressource to write part contents in |
| | | * @param resource $fp File pointer to save the message part |
| | | * @param boolean $skip_charset_conv Disables charset conversion |
| | | * |
| | | * @return string Message/part body if not printed |
| | | */ |
| | | function &get_message_part($uid, $part=1, $o_part=NULL, $print=NULL, $fp=NULL) |
| | | function &get_message_part($uid, $part=1, $o_part=NULL, $print=NULL, $fp=NULL, $skip_charset_conv=false) |
| | | { |
| | | // get part encoding if not provided |
| | | if (!is_object($o_part)) { |
| | |
| | | return true; |
| | | } |
| | | |
| | | // convert charset (if text or message part) and part's charset is specified |
| | | if ($body && $o_part->charset |
| | | && preg_match('/^(text|message)$/', $o_part->ctype_primary) |
| | | // convert charset (if text or message part) |
| | | if ($body && !$skip_charset_conv && |
| | | preg_match('/^(text|message)$/', $o_part->ctype_primary) |
| | | ) { |
| | | if (!$o_part->charset || strtoupper($o_part->charset) == 'US-ASCII') { |
| | | $o_part->charset = $this->default_charset; |
| | | } |
| | | $body = rcube_charset_convert($body, $o_part->charset); |
| | | } |
| | | |
| | |
| | | * |
| | | * @param mixed $uids Message UIDs as array or comma-separated string, or '*' |
| | | * @param string $flag Flag to set: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT |
| | | * @param string $mbox_name Folder name |
| | | * @param string $mailbox Folder name |
| | | * @param boolean $skip_cache True to skip message cache clean up |
| | | * |
| | | * @return boolean Operation status |
| | | */ |
| | | function set_flag($uids, $flag, $mbox_name=NULL, $skip_cache=false) |
| | | function set_flag($uids, $flag, $mailbox=null, $skip_cache=false) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | $flag = strtoupper($flag); |
| | | list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox); |
| | |
| | | /** |
| | | * Remove message flag for one or several messages |
| | | * |
| | | * @param mixed $uids Message UIDs as array or comma-separated string, or '*' |
| | | * @param string $flag Flag to unset: SEEN, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT |
| | | * @param string $mbox_name Folder name |
| | | * @param mixed $uids Message UIDs as array or comma-separated string, or '*' |
| | | * @param string $flag Flag to unset: SEEN, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT |
| | | * @param string $mailbox Folder name |
| | | * |
| | | * @return int Number of flagged messages, -1 on failure |
| | | * @see set_flag |
| | | */ |
| | | function unset_flag($uids, $flag, $mbox_name=NULL) |
| | | function unset_flag($uids, $flag, $mailbox=null) |
| | | { |
| | | return $this->set_flag($uids, 'UN'.$flag, $mbox_name); |
| | | return $this->set_flag($uids, 'UN'.$flag, $mailbox); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Append a mail message (source) to a specific mailbox |
| | | * |
| | | * @param string $mbox_name Target mailbox |
| | | * @param string $message The message source string or filename |
| | | * @param string $headers Headers string if $message contains only the body |
| | | * @param boolean $is_file True if $message is a filename |
| | | * @param string $mailbox Target mailbox |
| | | * @param string $message The message source string or filename |
| | | * @param string $headers Headers string if $message contains only the body |
| | | * @param boolean $is_file True if $message is a filename |
| | | * |
| | | * @return boolean True on success, False on error |
| | | */ |
| | | function save_message($mbox_name, &$message, $headers='', $is_file=false) |
| | | function save_message($mailbox, &$message, $headers='', $is_file=false) |
| | | { |
| | | $mailbox = $this->mod_mailbox($mbox_name); |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | // make sure mailbox exists |
| | | if ($this->mailbox_exists($mbox_name)) { |
| | | if ($this->mailbox_exists($mailbox)) { |
| | | if ($is_file) |
| | | $saved = $this->conn->appendFromFile($mailbox, $message, $headers); |
| | | else |
| | |
| | | */ |
| | | function move_message($uids, $to_mbox, $from_mbox='') |
| | | { |
| | | $fbox = $from_mbox; |
| | | $tbox = $to_mbox; |
| | | $to_mbox = $this->mod_mailbox($to_mbox); |
| | | $from_mbox = strlen($from_mbox) ? $this->mod_mailbox($from_mbox) : $this->mailbox; |
| | | if (!strlen($from_mbox)) { |
| | | $from_mbox = $this->mailbox; |
| | | } |
| | | |
| | | if ($to_mbox === $from_mbox) |
| | | if ($to_mbox === $from_mbox) { |
| | | return false; |
| | | } |
| | | |
| | | list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox); |
| | | |
| | |
| | | return false; |
| | | |
| | | // make sure mailbox exists |
| | | if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox)) { |
| | | if (in_array($tbox, $this->default_folders)) |
| | | $this->create_mailbox($tbox, true); |
| | | if ($to_mbox != 'INBOX' && !$this->mailbox_exists($to_mbox)) { |
| | | if (in_array($to_mbox, $this->default_folders)) |
| | | $this->create_mailbox($to_mbox, true); |
| | | else |
| | | return false; |
| | | } |
| | | |
| | | // flag messages as read before moving them |
| | | $config = rcmail::get_instance()->config; |
| | | if ($config->get('read_when_deleted') && $tbox == $config->get('trash_mbox')) { |
| | | $to_trash = $to_mbox == $config->get('trash_mbox'); |
| | | |
| | | // flag messages as read before moving them |
| | | if ($to_trash && $config->get('read_when_deleted')) { |
| | | // don't flush cache (4th argument) |
| | | $this->set_flag($uids, 'SEEN', $fbox, true); |
| | | $this->set_flag($uids, 'SEEN', $from_mbox, true); |
| | | } |
| | | |
| | | // move messages |
| | |
| | | $this->_clear_messagecount($to_mbox); |
| | | } |
| | | // moving failed |
| | | else if ($config->get('delete_always', false) && $tbox == $config->get('trash_mbox')) { |
| | | $moved = $this->delete_message($uids, $fbox); |
| | | else if ($to_trash && $config->get('delete_always', false)) { |
| | | $moved = $this->delete_message($uids, $from_mbox); |
| | | } |
| | | |
| | | if ($moved) { |
| | |
| | | */ |
| | | function copy_message($uids, $to_mbox, $from_mbox='') |
| | | { |
| | | $fbox = $from_mbox; |
| | | $tbox = $to_mbox; |
| | | $to_mbox = $this->mod_mailbox($to_mbox); |
| | | $from_mbox = $from_mbox ? $this->mod_mailbox($from_mbox) : $this->mailbox; |
| | | if (!strlen($from_mbox)) { |
| | | $from_mbox = $this->mailbox; |
| | | } |
| | | |
| | | list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox); |
| | | |
| | |
| | | } |
| | | |
| | | // make sure mailbox exists |
| | | if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox)) { |
| | | if (in_array($tbox, $this->default_folders)) |
| | | $this->create_mailbox($tbox, true); |
| | | if ($to_mbox != 'INBOX' && !$this->mailbox_exists($to_mbox)) { |
| | | if (in_array($to_mbox, $this->default_folders)) |
| | | $this->create_mailbox($to_mbox, true); |
| | | else |
| | | return false; |
| | | } |
| | |
| | | /** |
| | | * Mark messages as deleted and expunge mailbox |
| | | * |
| | | * @param mixed $uids Message UIDs as array or comma-separated string, or '*' |
| | | * @param string $mbox_name Source mailbox |
| | | * @param mixed $uids Message UIDs as array or comma-separated string, or '*' |
| | | * @param string $mailbox Source mailbox |
| | | * |
| | | * @return boolean True on success, False on error |
| | | */ |
| | | function delete_message($uids, $mbox_name='') |
| | | function delete_message($uids, $mailbox='') |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox); |
| | | |
| | |
| | | /** |
| | | * Clear all messages in a specific mailbox |
| | | * |
| | | * @param string $mbox_name Mailbox name |
| | | * @param string $mailbox Mailbox name |
| | | * |
| | | * @return int Above 0 on success |
| | | */ |
| | | function clear_mailbox($mbox_name=NULL) |
| | | function clear_mailbox($mailbox=null) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | // SELECT will set messages count for clearFolder() |
| | | if ($this->conn->select($mailbox)) { |
| | |
| | | /** |
| | | * Send IMAP expunge command and clear cache |
| | | * |
| | | * @param string $mbox_name Mailbox name |
| | | * @param string $mailbox Mailbox name |
| | | * @param boolean $clear_cache False if cache should not be cleared |
| | | * |
| | | * @return boolean True on success |
| | | */ |
| | | function expunge($mbox_name='', $clear_cache=true) |
| | | function expunge($mailbox='', $clear_cache=true) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | return $this->_expunge($mailbox, $clear_cache); |
| | | } |
| | | |
| | |
| | | /** |
| | | * Translate UID to message ID |
| | | * |
| | | * @param int $uid Message UID |
| | | * @param string $mbox_name Mailbox name |
| | | * @param int $uid Message UID |
| | | * @param string $mailbox Mailbox name |
| | | * |
| | | * @return int Message ID |
| | | */ |
| | | function get_id($uid, $mbox_name=NULL) |
| | | function get_id($uid, $mailbox=null) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | return $this->_uid2id($uid, $mailbox); |
| | | } |
| | | |
| | |
| | | /** |
| | | * Translate message number to UID |
| | | * |
| | | * @param int $id Message ID |
| | | * @param string $mbox_name Mailbox name |
| | | * @param int $id Message ID |
| | | * @param string $mailbox Mailbox name |
| | | * |
| | | * @return int Message UID |
| | | */ |
| | | function get_uid($id, $mbox_name=NULL) |
| | | function get_uid($id, $mailbox=null) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | return $this->_id2uid($id, $mailbox); |
| | | } |
| | | |
| | |
| | | /** |
| | | * Public method for listing subscribed folders |
| | | * |
| | | * Converts mailbox name with root dir first |
| | | * |
| | | * @param string $root Optional root folder |
| | | * @param string $filter Optional filter for mailbox listing |
| | | * @param string $name Optional name pattern |
| | | * @param string $filter Optional filter |
| | | * |
| | | * @return array List of mailboxes/folders |
| | | * @access public |
| | | */ |
| | | function list_mailboxes($root='', $filter='*') |
| | | function list_mailboxes($root='', $name='*', $filter=null) |
| | | { |
| | | $a_out = array(); |
| | | $a_mboxes = $this->_list_mailboxes($root, $filter); |
| | | |
| | | foreach ($a_mboxes as $idx => $mbox_row) { |
| | | if (strlen($name = $this->mod_mailbox($mbox_row, 'out'))) |
| | | $a_out[] = $name; |
| | | unset($a_mboxes[$idx]); |
| | | } |
| | | $a_mboxes = $this->_list_mailboxes($root, $name, $filter); |
| | | |
| | | // INBOX should always be available |
| | | if (!in_array('INBOX', $a_out)) |
| | | array_unshift($a_out, 'INBOX'); |
| | | if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) { |
| | | array_unshift($a_mboxes, 'INBOX'); |
| | | } |
| | | |
| | | // sort mailboxes |
| | | $a_out = $this->_sort_mailbox_list($a_out); |
| | | $a_mboxes = $this->_sort_mailbox_list($a_mboxes); |
| | | |
| | | return $a_out; |
| | | return $a_mboxes; |
| | | } |
| | | |
| | | |
| | |
| | | * Private method for mailbox listing |
| | | * |
| | | * @param string $root Optional root folder |
| | | * @param string $filter Optional filter for mailbox listing |
| | | * @param string $name Optional name pattern |
| | | * @param mixed $filter Optional filter |
| | | * |
| | | * @return array List of mailboxes/folders |
| | | * @see rcube_imap::list_mailboxes() |
| | | * @access private |
| | | */ |
| | | private function _list_mailboxes($root='', $filter='*') |
| | | private function _list_mailboxes($root='', $name='*', $filter=null) |
| | | { |
| | | $cache_key = 'mailboxes'; |
| | | if (!empty($filter)) { |
| | | $cache_key .= '.'.substr((is_string($filter) ? $filter : serialize($filter)), 0, 90); |
| | | } |
| | | |
| | | // get cached folder list |
| | | $a_mboxes = $this->get_cache('mailboxes'); |
| | | if (is_array($a_mboxes)) |
| | | $a_mboxes = $this->get_cache($cache_key); |
| | | if (is_array($a_mboxes)) { |
| | | return $a_mboxes; |
| | | } |
| | | |
| | | $a_defaults = $a_out = array(); |
| | | |
| | | // Give plugins a chance to provide a list of mailboxes |
| | | $data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list', |
| | | array('root' => $root, 'filter' => $filter, 'mode' => 'LSUB')); |
| | | array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LSUB')); |
| | | |
| | | if (isset($data['folders'])) { |
| | | $a_folders = $data['folders']; |
| | |
| | | // #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, |
| | | $a_folders = $this->conn->listMailboxes($root, $name, |
| | | NULL, array('SUBSCRIBED')); |
| | | |
| | | // remove non-existent folders |
| | |
| | | } |
| | | // retrieve list of folders from IMAP server using LSUB |
| | | else { |
| | | $a_folders = $this->conn->listSubscribed($this->mod_mailbox($root), $filter); |
| | | $a_folders = $this->conn->listSubscribed($root, $name); |
| | | } |
| | | } |
| | | |
| | | if (!is_array($a_folders) || !sizeof($a_folders)) |
| | | if (!is_array($a_folders) || !sizeof($a_folders)) { |
| | | $a_folders = array(); |
| | | } |
| | | |
| | | // write mailboxlist to cache |
| | | $this->update_cache('mailboxes', $a_folders); |
| | | $this->update_cache($cache_key, $a_folders); |
| | | |
| | | return $a_folders; |
| | | } |
| | |
| | | * Get a list of all folders available on the IMAP server |
| | | * |
| | | * @param string $root IMAP root dir |
| | | * @param string $filter Optional filter for mailbox listing |
| | | * @param string $name Optional name pattern |
| | | * @param mixed $filter Optional filter |
| | | * |
| | | * @return array Indexed array with folder names |
| | | */ |
| | | function list_unsubscribed($root='', $filter='*') |
| | | function list_unsubscribed($root='', $name='*', $filter=null) |
| | | { |
| | | // @TODO: caching |
| | | // Give plugins a chance to provide a list of mailboxes |
| | | $data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list', |
| | | array('root' => $root, 'filter' => $filter, 'mode' => 'LIST')); |
| | | array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LIST')); |
| | | |
| | | if (isset($data['folders'])) { |
| | | $a_mboxes = $data['folders']; |
| | | } |
| | | else { |
| | | // retrieve list of folders from IMAP server |
| | | $a_mboxes = $this->conn->listMailboxes($this->mod_mailbox($root), $filter); |
| | | $a_mboxes = $this->conn->listMailboxes($root, $name); |
| | | } |
| | | |
| | | $a_folders = array(); |
| | | if (!is_array($a_mboxes)) |
| | | if (!is_array($a_mboxes)) { |
| | | $a_mboxes = array(); |
| | | |
| | | // modify names with root dir |
| | | foreach ($a_mboxes as $idx => $mbox_name) { |
| | | if (strlen($name = $this->mod_mailbox($mbox_name, 'out'))) |
| | | $a_folders[] = $name; |
| | | unset($a_mboxes[$idx]); |
| | | } |
| | | |
| | | // INBOX should always be available |
| | | if (!in_array('INBOX', $a_folders)) |
| | | array_unshift($a_folders, 'INBOX'); |
| | | if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) { |
| | | array_unshift($a_mboxes, 'INBOX'); |
| | | } |
| | | |
| | | // filter folders and sort them |
| | | $a_folders = $this->_sort_mailbox_list($a_folders); |
| | | return $a_folders; |
| | | $a_mboxes = $this->_sort_mailbox_list($a_mboxes); |
| | | |
| | | return $a_mboxes; |
| | | } |
| | | |
| | | |
| | |
| | | /** |
| | | * Get mailbox size (size of all messages in a mailbox) |
| | | * |
| | | * @param string $name Mailbox name |
| | | * @param string $mailbox Mailbox name |
| | | * |
| | | * @return int Mailbox size in bytes, False on error |
| | | */ |
| | | function get_mailbox_size($name) |
| | | function get_mailbox_size($mailbox) |
| | | { |
| | | $name = $this->mod_mailbox($name); |
| | | |
| | | // @TODO: could we try to use QUOTA here? |
| | | $result = $this->conn->fetchHeaderIndex($name, '1:*', 'SIZE', false); |
| | | $result = $this->conn->fetchHeaderIndex($mailbox, '1:*', 'SIZE', false); |
| | | |
| | | if (is_array($result)) |
| | | $result = array_sum($result); |
| | |
| | | /** |
| | | * Create a new mailbox on the server and register it in local cache |
| | | * |
| | | * @param string $name New mailbox name |
| | | * @param string $mailbox New mailbox name |
| | | * @param boolean $subscribe True if the new mailbox should be subscribed |
| | | * @param boolean True on success |
| | | * |
| | | * @return boolean True on success |
| | | */ |
| | | function create_mailbox($name, $subscribe=false) |
| | | function create_mailbox($mailbox, $subscribe=false) |
| | | { |
| | | $result = false; |
| | | $abs_name = $this->mod_mailbox($name); |
| | | $result = $this->conn->createFolder($abs_name); |
| | | $result = $this->conn->createFolder($mailbox); |
| | | |
| | | // try to subscribe it |
| | | if ($result && $subscribe) |
| | | $this->subscribe($name); |
| | | $this->subscribe($mailbox); |
| | | |
| | | return $result; |
| | | } |
| | |
| | | /** |
| | | * Set a new name to an existing mailbox |
| | | * |
| | | * @param string $mbox_name Mailbox to rename |
| | | * @param string $new_name New mailbox name |
| | | * @param string $mailbox Mailbox to rename |
| | | * @param string $new_name New mailbox name |
| | | * |
| | | * @return boolean True on success |
| | | */ |
| | | function rename_mailbox($mbox_name, $new_name) |
| | | function rename_mailbox($mailbox, $new_name) |
| | | { |
| | | $result = false; |
| | | if (!strlen($new_name)) { |
| | | return false; |
| | | } |
| | | |
| | | // make absolute path |
| | | $mailbox = $this->mod_mailbox($mbox_name); |
| | | $abs_name = $this->mod_mailbox($new_name); |
| | | $delm = $this->get_hierarchy_delimiter(); |
| | | $delm = $this->get_hierarchy_delimiter(); |
| | | |
| | | // get list of subscribed folders |
| | | if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false)) { |
| | | $a_subscribed = $this->_list_mailboxes('', $mbox_name . $delm . '*'); |
| | | $subscribed = $this->mailbox_exists($mbox_name, true); |
| | | $a_subscribed = $this->_list_mailboxes('', $mailbox . $delm . '*'); |
| | | $subscribed = $this->mailbox_exists($mailbox, true); |
| | | } |
| | | else { |
| | | $a_subscribed = $this->_list_mailboxes(); |
| | | $subscribed = in_array($mailbox, $a_subscribed); |
| | | } |
| | | |
| | | if (strlen($abs_name)) |
| | | $result = $this->conn->renameFolder($mailbox, $abs_name); |
| | | $result = $this->conn->renameFolder($mailbox, $new_name); |
| | | |
| | | if ($result) { |
| | | // unsubscribe the old folder, subscribe the new one |
| | | if ($subscribed) { |
| | | $this->conn->unsubscribe($mailbox); |
| | | $this->conn->subscribe($abs_name); |
| | | $this->conn->subscribe($new_name); |
| | | } |
| | | |
| | | // check if mailbox children are subscribed |
| | |
| | | if (preg_match('/^'.preg_quote($mailbox.$delm, '/').'/', $c_subscribed)) { |
| | | $this->conn->unsubscribe($c_subscribed); |
| | | $this->conn->subscribe(preg_replace('/^'.preg_quote($mailbox, '/').'/', |
| | | $abs_name, $c_subscribed)); |
| | | $new_name, $c_subscribed)); |
| | | } |
| | | } |
| | | |
| | | // clear cache |
| | | $this->clear_message_cache($mailbox.'.msg'); |
| | | $this->clear_cache('mailboxes'); |
| | | $this->clear_cache('/^mailboxes.*/', true); |
| | | } |
| | | |
| | | return $result; |
| | |
| | | /** |
| | | * Remove mailbox from server |
| | | * |
| | | * @param string $mbox_name Mailbox name |
| | | * @param string $mailbox Mailbox name |
| | | * |
| | | * @return boolean True on success |
| | | */ |
| | | function delete_mailbox($mbox_name) |
| | | function delete_mailbox($mailbox) |
| | | { |
| | | $result = false; |
| | | $mailbox = $this->mod_mailbox($mbox_name); |
| | | $delm = $this->get_hierarchy_delimiter(); |
| | | $delm = $this->get_hierarchy_delimiter(); |
| | | |
| | | // get list of folders |
| | | if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false)) |
| | |
| | | |
| | | // clear mailbox-related cache |
| | | $this->clear_message_cache($mailbox.'.msg'); |
| | | $this->clear_cache('mailboxes'); |
| | | $this->clear_cache('/^mailboxes.*/', true); |
| | | } |
| | | |
| | | return $result; |
| | |
| | | /** |
| | | * Checks if folder exists and is subscribed |
| | | * |
| | | * @param string $mbox_name Folder name |
| | | * @param string $mailbox Folder name |
| | | * @param boolean $subscription Enable subscription checking |
| | | * |
| | | * @return boolean TRUE or FALSE |
| | | */ |
| | | function mailbox_exists($mbox_name, $subscription=false) |
| | | function mailbox_exists($mailbox, $subscription=false) |
| | | { |
| | | if ($mbox_name == 'INBOX') |
| | | if ($mailbox == 'INBOX') { |
| | | return true; |
| | | } |
| | | |
| | | $key = $subscription ? 'subscribed' : 'existing'; |
| | | $mbox = $this->mod_mailbox($mbox_name); |
| | | |
| | | if (is_array($this->icache[$key]) && in_array($mbox, $this->icache[$key])) |
| | | if (is_array($this->icache[$key]) && in_array($mailbox, $this->icache[$key])) |
| | | return true; |
| | | |
| | | if ($subscription) { |
| | | $a_folders = $this->conn->listSubscribed('', $mbox); |
| | | $a_folders = $this->conn->listSubscribed('', $mailbox); |
| | | } |
| | | else { |
| | | $a_folders = $this->conn->listMailboxes('', $mbox); |
| | | $a_folders = $this->conn->listMailboxes('', $mailbox); |
| | | } |
| | | |
| | | if (is_array($a_folders) && in_array($mbox, $a_folders)) { |
| | | $this->icache[$key][] = $mbox; |
| | | if (is_array($a_folders) && in_array($mailbox, $a_folders)) { |
| | | $this->icache[$key][] = $mailbox; |
| | | return true; |
| | | } |
| | | |
| | |
| | | |
| | | |
| | | /** |
| | | * Modify folder name for input/output according to root dir and namespace |
| | | * Returns the namespace where the folder is in |
| | | * |
| | | * @param string $mbox_name Folder name |
| | | * @param string $mode Mode |
| | | * @param string $mailbox Folder name |
| | | * |
| | | * @return string One of 'personal', 'other' or 'shared' |
| | | * @access public |
| | | */ |
| | | function mailbox_namespace($mailbox) |
| | | { |
| | | if ($mailbox == 'INBOX') { |
| | | return 'personal'; |
| | | } |
| | | |
| | | foreach ($this->namespace as $type => $namespace) { |
| | | if (is_array($namespace)) { |
| | | foreach ($namespace as $ns) { |
| | | if (strlen($ns[0])) { |
| | | if ((strlen($ns[0])>1 && $mailbox == substr($ns[0], 0, -1)) |
| | | || strpos($mailbox, $ns[0]) === 0 |
| | | ) { |
| | | return $type; |
| | | } |
| | | } |
| | | } |
| | | } |
| | | } |
| | | |
| | | return 'personal'; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Modify folder name according to namespace. |
| | | * For output it removes prefix of the personal namespace if it's possible. |
| | | * For input it adds the prefix. Use it before creating a folder in root |
| | | * of the folders tree. |
| | | * |
| | | * @param string $mailbox Folder name |
| | | * @param string $mode Mode name (out/in) |
| | | * |
| | | * @return string Folder name |
| | | */ |
| | | function mod_mailbox($mbox_name, $mode='in') |
| | | function mod_mailbox($mailbox, $mode = 'out') |
| | | { |
| | | if (!strlen($mbox_name)) |
| | | return ''; |
| | | if (!strlen($mailbox)) { |
| | | return $mailbox; |
| | | } |
| | | |
| | | if ($mode == 'in') { |
| | | // If folder contains namespace prefix, don't modify it |
| | | if (is_array($this->namespace['shared'])) { |
| | | foreach ($this->namespace['shared'] as $ns) { |
| | | if ($ns[0] && strpos($mbox_name, $ns[0]) === 0) { |
| | | return $mbox_name; |
| | | } |
| | | } |
| | | } |
| | | if (is_array($this->namespace['other'])) { |
| | | foreach ($this->namespace['other'] as $ns) { |
| | | if ($ns[0] && strpos($mbox_name, $ns[0]) === 0) { |
| | | return $mbox_name; |
| | | } |
| | | } |
| | | } |
| | | if (is_array($this->namespace['personal'])) { |
| | | foreach ($this->namespace['personal'] as $ns) { |
| | | if ($ns[0] && strpos($mbox_name, $ns[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; |
| | | } |
| | | $prefix = $this->namespace['prefix']; // see set_env() |
| | | $prefix_len = strlen($prefix); |
| | | |
| | | if (!$prefix_len) { |
| | | return $mailbox; |
| | | } |
| | | |
| | | // remove prefix for output |
| | | if ($mode == 'out') { |
| | | if (substr($mailbox, 0, $prefix_len) === $prefix) { |
| | | return substr($mailbox, $prefix_len); |
| | | } |
| | | } |
| | | // add prefix for input (e.g. folder creation) |
| | | 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 $prefix . $mailbox; |
| | | } |
| | | |
| | | return $mbox_name; |
| | | return $mailbox; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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 |
| | | * @param string $mailbox 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) |
| | | function mailbox_options($mailbox, $force=false) |
| | | { |
| | | $mbox = $this->mod_mailbox($mbox_name); |
| | | |
| | | if ($mbox == 'INBOX') { |
| | | if ($mailbox == 'INBOX') { |
| | | return array(); |
| | | } |
| | | |
| | | if (!is_array($this->conn->data['LIST']) || !is_array($this->conn->data['LIST'][$mbox])) { |
| | | if (!is_array($this->conn->data['LIST']) || !is_array($this->conn->data['LIST'][$mailbox])) { |
| | | if ($force) { |
| | | $this->conn->listMailboxes('', $mbox_name); |
| | | $this->conn->listMailboxes('', $mailbox); |
| | | } |
| | | else { |
| | | return array(); |
| | | } |
| | | } |
| | | |
| | | $opts = $this->conn->data['LIST'][$mbox]; |
| | | $opts = $this->conn->data['LIST'][$mailbox]; |
| | | |
| | | return is_array($opts) ? $opts : array(); |
| | | } |
| | |
| | | */ |
| | | function set_acl($mailbox, $user, $acl) |
| | | { |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('ACL')) |
| | | return $this->conn->setACL($mailbox, $user, $acl); |
| | | |
| | |
| | | */ |
| | | function delete_acl($mailbox, $user) |
| | | { |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('ACL')) |
| | | return $this->conn->deleteACL($mailbox, $user); |
| | | |
| | |
| | | */ |
| | | function get_acl($mailbox) |
| | | { |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('ACL')) |
| | | return $this->conn->getACL($mailbox); |
| | | |
| | |
| | | */ |
| | | function list_rights($mailbox, $user) |
| | | { |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('ACL')) |
| | | return $this->conn->listRights($mailbox, $user); |
| | | |
| | |
| | | */ |
| | | function my_rights($mailbox) |
| | | { |
| | | $mailbox = $this->mod_mailbox($mailbox); |
| | | |
| | | if ($this->get_capability('ACL')) |
| | | return $this->conn->myRights($mailbox); |
| | | |
| | |
| | | */ |
| | | 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) { |
| | | foreach ((array)$entries as $entry => $value) { |
| | | list($ent, $attr) = $this->md2annotate($entry); |
| | | $entries[$entry] = array($ent, $attr, $value); |
| | | } |
| | |
| | | */ |
| | | 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) { |
| | | foreach ((array)$entries as $idx => $entry) { |
| | | list($ent, $attr) = $this->md2annotate($entry); |
| | | $entries[$idx] = array($ent, $attr, NULL); |
| | | } |
| | |
| | | */ |
| | | 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')) |
| | | (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) |
| | | ) { |
| | | return $this->conn->getMetadata($mailbox, $entries, $options); |
| | | } |
| | |
| | | $res = array(); |
| | | |
| | | // Convert entry names |
| | | foreach ($entries as $entry) { |
| | | foreach ((array)$entries as $entry) { |
| | | list($ent, $attr) = $this->md2annotate($entry); |
| | | $queries[$attr][] = $ent; |
| | | } |
| | |
| | | * Converts the METADATA extension entry name into the correct |
| | | * entry-attrib names for older ANNOTATEMORE version. |
| | | * |
| | | * @param string Entry name |
| | | * @param string $entry Entry name |
| | | * |
| | | * @return array Entry-attribute list, NULL if not supported (?) |
| | | */ |
| | | private function md2annotate($name) |
| | | private function md2annotate($entry) |
| | | { |
| | | if (substr($entry, 0, 7) == '/shared') { |
| | | return array(substr($entry, 7), 'value.shared'); |
| | |
| | | /** |
| | | * Clears the cache. |
| | | * |
| | | * @param string $key Cache key |
| | | * @param string $key Cache key name or pattern |
| | | * @param boolean $pattern_mode Enable it to clear all keys with name |
| | | * matching PREG pattern in $key |
| | | * @access public |
| | | */ |
| | | function clear_cache($key=NULL) |
| | | function clear_cache($key=null, $pattern_mode=false) |
| | | { |
| | | if (!$this->caching_enabled) |
| | | return; |
| | | |
| | | if ($key===NULL) { |
| | | foreach ($this->cache as $key => $data) |
| | | if ($key === null) { |
| | | foreach (array_keys($this->cache) as $key) |
| | | $this->_clear_cache_record($key); |
| | | |
| | | $this->cache = array(); |
| | | $this->cache_changed = false; |
| | | $this->cache_changes = array(); |
| | | } |
| | | else if ($pattern_mode) { |
| | | foreach (array_keys($this->cache) as $k) { |
| | | if (preg_match($key, $k)) { |
| | | $this->_clear_cache_record($k); |
| | | $this->cache_changes[$k] = false; |
| | | unset($this->cache[$key]); |
| | | } |
| | | } |
| | | if (!count($this->cache)) { |
| | | $this->cache_changed = false; |
| | | } |
| | | } |
| | | else { |
| | | $this->_clear_cache_record($key); |
| | |
| | | */ |
| | | public static function decode_mime_string($input, $fallback=null) |
| | | { |
| | | // Initialize variable |
| | | $out = ''; |
| | | if (!empty($fallback)) { |
| | | $default_charset = $fallback; |
| | | } |
| | | else { |
| | | $default_charset = rcmail::get_instance()->config->get('default_charset', 'ISO-8859-1'); |
| | | } |
| | | |
| | | // Iterate instead of recursing, this way if there are too many values we don't have stack overflows |
| | | // rfc: all line breaks or other characters not found |
| | | // in the Base64 Alphabet must be ignored by decoding software |
| | | // delete all blanks between MIME-lines, differently we can |
| | | // receive unnecessary blanks and broken utf-8 symbols |
| | | $input = preg_replace("/\?=\s+=\?/", '?==?', $input); |
| | | |
| | | // Check if there is stuff to decode |
| | | if (strpos($input, '=?') !== false) { |
| | | // Loop through the string to decode all occurences of =? ?= into the variable $out |
| | | while(($pos = strpos($input, '=?')) !== false) { |
| | | // encoded-word regexp |
| | | $re = '/=\?([^?]+)\?([BbQq])\?([^?\n]*)\?=/'; |
| | | |
| | | // Find all RFC2047's encoded words |
| | | if (preg_match_all($re, $input, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER)) { |
| | | // Initialize variables |
| | | $tmp = array(); |
| | | $out = ''; |
| | | $start = 0; |
| | | |
| | | foreach ($matches as $idx => $m) { |
| | | $pos = $m[0][1]; |
| | | $charset = $m[1][0]; |
| | | $encoding = $m[2][0]; |
| | | $text = $m[3][0]; |
| | | $length = strlen($m[0][0]); |
| | | |
| | | // Append everything that is before the text to be decoded |
| | | $out .= substr($input, 0, $pos); |
| | | if ($start != $pos) { |
| | | $substr = substr($input, $start, $pos-$start); |
| | | $out .= rcube_charset_convert($substr, $default_charset); |
| | | $start = $pos; |
| | | } |
| | | $start += $length; |
| | | |
| | | // Get the location of the text to decode |
| | | $end_cs_pos = strpos($input, "?", $pos+2); |
| | | $end_en_pos = strpos($input, "?", $end_cs_pos+1); |
| | | $end_pos = strpos($input, "?=", $end_en_pos+1); |
| | | // Per RFC2047, each string part "MUST represent an integral number |
| | | // of characters . A multi-octet character may not be split across |
| | | // adjacent encoded-words." However, some mailers break this, so we |
| | | // try to handle characters spanned across parts anyway by iterating |
| | | // through and aggregating sequential encoded parts with the same |
| | | // character set and encoding, then perform the decoding on the |
| | | // aggregation as a whole. |
| | | |
| | | // Extract the encoded string |
| | | $encstr = substr($input, $pos+2, ($end_pos-$pos-2)); |
| | | // Extract the remaining string |
| | | $input = substr($input, $end_pos+2); |
| | | $tmp[] = $text; |
| | | if ($next_match = $matches[$idx+1]) { |
| | | if ($next_match[0][1] == $start |
| | | && $next_match[1][0] == $charset |
| | | && $next_match[2][0] == $encoding |
| | | ) { |
| | | continue; |
| | | } |
| | | } |
| | | |
| | | // Decode the string fragement |
| | | $out .= rcube_imap::_decode_mime_string_part($encstr); |
| | | $count = count($tmp); |
| | | $text = ''; |
| | | |
| | | // Decode and join encoded-word's chunks |
| | | if ($encoding == 'B' || $encoding == 'b') { |
| | | // base64 must be decoded a segment at a time |
| | | for ($i=0; $i<$count; $i++) |
| | | $text .= base64_decode($tmp[$i]); |
| | | } |
| | | else { //if ($encoding == 'Q' || $encoding == 'q') { |
| | | // quoted printable can be combined and processed at once |
| | | for ($i=0; $i<$count; $i++) |
| | | $text .= $tmp[$i]; |
| | | |
| | | $text = str_replace('_', ' ', $text); |
| | | $text = quoted_printable_decode($text); |
| | | } |
| | | |
| | | $out .= rcube_charset_convert($text, $charset); |
| | | $tmp = array(); |
| | | } |
| | | |
| | | // Deocde the rest (if any) |
| | | if (strlen($input) != 0) |
| | | $out .= rcube_imap::decode_mime_string($input, $fallback); |
| | | // add the last part of the input string |
| | | if ($start != strlen($input)) { |
| | | $out .= rcube_charset_convert(substr($input, $start), $default_charset); |
| | | } |
| | | |
| | | // return the results |
| | | return $out; |
| | | } |
| | | |
| | | // no encoding information, use fallback |
| | | return rcube_charset_convert($input, |
| | | !empty($fallback) ? $fallback : rcmail::get_instance()->config->get('default_charset', 'ISO-8859-1')); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Decode a part of a mime-encoded string |
| | | * |
| | | * @param string $str String to decode |
| | | * @return string Decoded string |
| | | * @access private |
| | | */ |
| | | private function _decode_mime_string_part($str) |
| | | { |
| | | $a = explode('?', $str); |
| | | $count = count($a); |
| | | |
| | | // should be in format "charset?encoding?base64_string" |
| | | if ($count >= 3) { |
| | | for ($i=2; $i<$count; $i++) |
| | | $rest .= $a[$i]; |
| | | |
| | | if (($a[1]=='B') || ($a[1]=='b')) |
| | | $rest = base64_decode($rest); |
| | | else if (($a[1]=='Q') || ($a[1]=='q')) { |
| | | $rest = str_replace('_', ' ', $rest); |
| | | $rest = quoted_printable_decode($rest); |
| | | } |
| | | |
| | | return rcube_charset_convert($rest, $a[0]); |
| | | } |
| | | |
| | | // we dont' know what to do with this |
| | | return $str; |
| | | return rcube_charset_convert($input, $default_charset); |
| | | } |
| | | |
| | | |
| | |
| | | |
| | | |
| | | /** |
| | | * @param int $uid Message UID |
| | | * @param string $mbox_name Mailbox name |
| | | * @param int $uid Message UID |
| | | * @param string $mailbox Mailbox name |
| | | * @return int Message (sequence) ID |
| | | * @access private |
| | | */ |
| | | private function _uid2id($uid, $mbox_name=NULL) |
| | | private function _uid2id($uid, $mailbox=NULL) |
| | | { |
| | | if (!strlen($mbox_name)) |
| | | $mbox_name = $this->mailbox; |
| | | |
| | | if (!isset($this->uid_id_map[$mbox_name][$uid])) { |
| | | if (!($id = $this->get_cache_uid2id($mbox_name.'.msg', $uid))) |
| | | $id = $this->conn->UID2ID($mbox_name, $uid); |
| | | |
| | | $this->uid_id_map[$mbox_name][$uid] = $id; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | return $this->uid_id_map[$mbox_name][$uid]; |
| | | if (!isset($this->uid_id_map[$mailbox][$uid])) { |
| | | if (!($id = $this->get_cache_uid2id($mailbox.'.msg', $uid))) |
| | | $id = $this->conn->UID2ID($mailbox, $uid); |
| | | |
| | | $this->uid_id_map[$mailbox][$uid] = $id; |
| | | } |
| | | |
| | | return $this->uid_id_map[$mailbox][$uid]; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * @param int $id Message (sequence) ID |
| | | * @param string $mbox_name Mailbox name |
| | | * @param int $id Message (sequence) ID |
| | | * @param string $mailbox Mailbox name |
| | | * |
| | | * @return int Message UID |
| | | * @access private |
| | | */ |
| | | private function _id2uid($id, $mbox_name=NULL) |
| | | private function _id2uid($id, $mailbox=null) |
| | | { |
| | | if (!strlen($mbox_name)) |
| | | $mbox_name = $this->mailbox; |
| | | if (!strlen($mailbox)) { |
| | | $mailbox = $this->mailbox; |
| | | } |
| | | |
| | | if ($uid = array_search($id, (array)$this->uid_id_map[$mbox_name])) |
| | | if ($uid = array_search($id, (array)$this->uid_id_map[$mailbox])) { |
| | | return $uid; |
| | | } |
| | | |
| | | if (!($uid = $this->get_cache_id2uid($mbox_name.'.msg', $id))) |
| | | $uid = $this->conn->ID2UID($mbox_name, $id); |
| | | if (!($uid = $this->get_cache_id2uid($mailbox.'.msg', $id))) { |
| | | $uid = $this->conn->ID2UID($mailbox, $id); |
| | | } |
| | | |
| | | $this->uid_id_map[$mbox_name][$uid] = $id; |
| | | $this->uid_id_map[$mailbox][$uid] = $id; |
| | | |
| | | return $uid; |
| | | } |
| | |
| | | $updated = false; |
| | | |
| | | if (is_array($a_mboxes)) |
| | | foreach ($a_mboxes as $i => $mbox_name) { |
| | | $mailbox = $this->mod_mailbox($mbox_name); |
| | | foreach ($a_mboxes as $i => $mailbox) { |
| | | $a_mboxes[$i] = $mailbox; |
| | | |
| | | if ($mode=='subscribe') |
| | | if ($mode == 'subscribe') |
| | | $updated = $this->conn->subscribe($mailbox); |
| | | else if ($mode=='unsubscribe') |
| | | else if ($mode == 'unsubscribe') |
| | | $updated = $this->conn->unsubscribe($mailbox); |
| | | } |
| | | |
| | |
| | | return $updated; |
| | | |
| | | // modify cached list |
| | | if ($mode=='subscribe') |
| | | if ($mode == 'subscribe') |
| | | $a_mailbox_cache = array_merge($a_mailbox_cache, $a_mboxes); |
| | | else if ($mode=='unsubscribe') |
| | | else if ($mode == 'unsubscribe') |
| | | $a_mailbox_cache = array_diff($a_mailbox_cache, $a_mboxes); |
| | | |
| | | // write mailboxlist to cache |
| | |
| | | * Increde/decrese messagecount for a specific mailbox |
| | | * @access private |
| | | */ |
| | | private function _set_messagecount($mbox_name, $mode, $increment) |
| | | private function _set_messagecount($mailbox, $mode, $increment) |
| | | { |
| | | $a_mailbox_cache = false; |
| | | $mailbox = strlen($mbox_name) ? $mbox_name : $this->mailbox; |
| | | $mode = strtoupper($mode); |
| | | |
| | | $a_mailbox_cache = $this->get_cache('messagecount'); |
| | | |
| | | if (!is_array($a_mailbox_cache[$mailbox]) || !isset($a_mailbox_cache[$mailbox][$mode]) || !is_numeric($increment)) |
| | |
| | | * Remove messagecount of a specific mailbox from cache |
| | | * @access private |
| | | */ |
| | | private function _clear_messagecount($mbox_name='', $mode=null) |
| | | private function _clear_messagecount($mailbox, $mode=null) |
| | | { |
| | | $mailbox = strlen($mbox_name) ? $mbox_name : $this->mailbox; |
| | | |
| | | $a_mailbox_cache = $this->get_cache('messagecount'); |
| | | |
| | | if (is_array($a_mailbox_cache[$mailbox])) { |
| | |
| | | private function _parse_address_list($str, $decode=true) |
| | | { |
| | | // remove any newlines and carriage returns before |
| | | $a = rcube_explode_quoted_string('[,;]', preg_replace( "/[\r\n]/", " ", $str)); |
| | | $str = preg_replace('/\r?\n(\s|\t)?/', ' ', $str); |
| | | |
| | | // extract list items, remove comments |
| | | $str = self::explode_header_string(',;', $str, true); |
| | | $result = array(); |
| | | |
| | | foreach ($a as $key => $val) { |
| | | foreach ($str as $key => $val) { |
| | | $name = ''; |
| | | $address = ''; |
| | | $val = trim($val); |
| | |
| | | |
| | | |
| | | /** |
| | | * Explodes header (e.g. address-list) string into array of strings |
| | | * using specified separator characters with proper handling |
| | | * of quoted-strings and comments (RFC2822) |
| | | * |
| | | * @param string $separator String containing separator characters |
| | | * @param string $str Header string |
| | | * @param bool $remove_comments Enable to remove comments |
| | | * |
| | | * @return array Header items |
| | | */ |
| | | static function explode_header_string($separator, $str, $remove_comments=false) |
| | | { |
| | | $length = strlen($str); |
| | | $result = array(); |
| | | $quoted = false; |
| | | $comment = 0; |
| | | $out = ''; |
| | | |
| | | for ($i=0; $i<$length; $i++) { |
| | | // we're inside a quoted string |
| | | if ($quoted) { |
| | | if ($str[$i] == '"') { |
| | | $quoted = false; |
| | | } |
| | | else if ($str[$i] == '\\') { |
| | | if ($comment <= 0) { |
| | | $out .= '\\'; |
| | | } |
| | | $i++; |
| | | } |
| | | } |
| | | // we're inside a comment string |
| | | else if ($comment > 0) { |
| | | if ($str[$i] == ')') { |
| | | $comment--; |
| | | } |
| | | else if ($str[$i] == '(') { |
| | | $comment++; |
| | | } |
| | | else if ($str[$i] == '\\') { |
| | | $i++; |
| | | } |
| | | continue; |
| | | } |
| | | // separator, add to result array |
| | | else if (strpos($separator, $str[$i]) !== false) { |
| | | if ($out) { |
| | | $result[] = $out; |
| | | } |
| | | $out = ''; |
| | | continue; |
| | | } |
| | | // start of quoted string |
| | | else if ($str[$i] == '"') { |
| | | $quoted = true; |
| | | } |
| | | // start of comment |
| | | else if ($remove_comments && $str[$i] == '(') { |
| | | $comment++; |
| | | } |
| | | |
| | | if ($comment <= 0) { |
| | | $out .= $str[$i]; |
| | | } |
| | | } |
| | | |
| | | if ($out && $comment <= 0) { |
| | | $result[] = $out; |
| | | } |
| | | |
| | | return $result; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * This is our own debug handler for the IMAP connection |
| | | * @access public |
| | | */ |