| | |
| | | */ |
| | | require_once('lib/imap.inc'); |
| | | require_once('lib/mime.inc'); |
| | | require_once('lib/utf7.inc'); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @package RoundCube Webmail |
| | | * @author Thomas Bruederli <roundcube@gmail.com> |
| | | * @version 1.30 |
| | | * @version 1.31 |
| | | * @link http://ilohamail.org |
| | | */ |
| | | class rcube_imap |
| | |
| | | var $sort_order = 'DESC'; |
| | | var $delimiter = NULL; |
| | | var $caching_enabled = FALSE; |
| | | var $default_folders = array('inbox', 'drafts', 'sent', 'junk', 'trash'); |
| | | var $default_folders = array('INBOX'); |
| | | var $default_folders_lc = array('inbox'); |
| | | var $cache = array(); |
| | | var $cache_keys = array(); |
| | | var $cache_changes = array(); |
| | |
| | | { |
| | | if (is_array($arr)) |
| | | { |
| | | $this->default_folders = array(); |
| | | |
| | | // add mailbox names lower case |
| | | foreach ($arr as $mbox_row) |
| | | $this->default_folders[] = strtolower($mbox_row); |
| | | |
| | | $this->default_folders = $arr; |
| | | $this->default_folders_lc = array(); |
| | | |
| | | // add inbox if not included |
| | | if (!in_array('inbox', $this->default_folders)) |
| | | array_unshift($arr, 'inbox'); |
| | | if (!in_array_nocase('INBOX', $this->default_folders)) |
| | | array_unshift($this->default_folders, 'INBOX'); |
| | | |
| | | // create a second list with lower cased names |
| | | foreach ($this->default_folders as $mbox) |
| | | $this->default_folders_lc[] = strtolower($mbox); |
| | | } |
| | | } |
| | | |
| | |
| | | $a_out[] = $name; |
| | | } |
| | | |
| | | // INBOX should always be available |
| | | if (!in_array_nocase('INBOX', $a_out)) |
| | | array_unshift($a_out, 'INBOX'); |
| | | |
| | | // sort mailboxes |
| | | $a_out = $this->_sort_mailbox_list($a_out); |
| | | |
| | |
| | | |
| | | if (!is_array($a_folders) || !sizeof($a_folders)) |
| | | $a_folders = array(); |
| | | |
| | | // create Default folders if they do not exist |
| | | global $CONFIG; |
| | | foreach ($CONFIG['default_imap_folders'] as $folder) |
| | | { |
| | | if (!in_array_nocase($folder, $a_folders)) |
| | | { |
| | | $this->create_mailbox($folder, TRUE); |
| | | $this->subscribe($folder); |
| | | } |
| | | } |
| | | |
| | | $a_folders = iil_C_ListSubscribed($this->conn, $this->_mod_mailbox($root), $filter); |
| | | $a_mailbox_cache = array(); |
| | | |
| | | // write mailboxlist to cache |
| | | $this->update_cache('mailboxes', $a_folders); |
| | |
| | | $a_msg_headers = $this->get_message_cache($cache_key, $start_msg, $start_msg+$this->page_size, $this->sort_field, $this->sort_order); |
| | | $headers_sorted = TRUE; |
| | | } |
| | | // cache is dirty, sync it |
| | | else if ($this->caching_enabled && $cache_status==-1 && !$recursive) |
| | | { |
| | | $this->sync_header_index($mailbox); |
| | | return $this->_list_headers($mailbox, $page, $this->sort_field, $this->sort_order, TRUE); |
| | | } |
| | | else |
| | | { |
| | | $sorter = new rcube_header_sorter(); |
| | | |
| | | // retrieve headers from IMAP |
| | | if ($this->get_capability('sort') && ($msg_index = iil_C_Sort($this->conn, $mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : ''))) |
| | | { |
| | | $sorter->set_sequence_numbers($msg_index); |
| | | |
| | | { |
| | | $msgs = $msg_index[$begin]; |
| | | for ($i=$begin+1; $i < $end; $i++) |
| | | $msgs = $msgs.','.$msg_index[$i]; |
| | | } |
| | | else |
| | | { |
| | | $msgs = sprintf("%d:%d", $begin+1, $end); |
| | | $msgs = sprintf("%d:%d", $begin+1, $end); |
| | | |
| | | $i = 0; |
| | | for ($msg_seqnum = $begin; $msg_seqnum <= $end; $msg_seqnum++) |
| | | $msg_index[$i++] = $msg_seqnum; |
| | | } |
| | | |
| | | |
| | | // cache is dirty, sync it |
| | | if ($this->caching_enabled && $cache_status==-1 && !$recursive) |
| | | { |
| | | $this->sync_header_index($mailbox); |
| | | return $this->_list_headers($mailbox, $page, $this->sort_field, $this->sort_order, TRUE); |
| | | } |
| | | |
| | | // use this class for message sorting |
| | | $sorter = new rcube_header_sorter(); |
| | | $sorter->set_sequence_numbers($msg_index); |
| | | |
| | | // fetch reuested headers from server |
| | | $a_msg_headers = array(); |
| | |
| | | |
| | | return array_values($a_msg_headers); |
| | | } |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | function gethdrids($hdr) |
| | | { |
| | | return $hdr->uid . ',' . $hdr->id; |
| | | } |
| | | |
| | | |
| | | |
| | | |
| | |
| | | * @return array search results as list of message ids |
| | | * @access public |
| | | */ |
| | | function search($mbox_name='', $criteria='ALL', $str=NULL) |
| | | function search($mbox_name='', $criteria='ALL', $str=NULL, $charset=NULL) |
| | | { |
| | | $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; |
| | | if ($str && $criteria) |
| | | { |
| | | $criteria = 'CHARSET UTF-8 '.$criteria.' "'.UTF7EncodeString($str).'"'; |
| | | return $this->_search_index($mailbox, $criteria); |
| | | $search = (!empty($charset) ? "CHARSET $charset " : '') . sprintf("%s {%d}\r\n%s", $criteria, strlen($str), $str); |
| | | $results = $this->_search_index($mailbox, $search); |
| | | |
| | | // try search with ISO charset (should be supported by server) |
| | | if (empty($results) && !empty($charset) && $charset!='ISO-8859-1') |
| | | $results = $this->search($mbox_name, $criteria, rcube_charset_convert($str, $charset, 'ISO-8859-1'), 'ISO-8859-1'); |
| | | |
| | | return $results; |
| | | } |
| | | else |
| | | return $this->_search_index($mailbox, $criteria); |
| | |
| | | * --------------------------------*/ |
| | | |
| | | |
| | | // return an array with all folders available in IMAP server |
| | | /** |
| | | * Get a list of all folders available on the IMAP server |
| | | * |
| | | * @param string IMAP root dir |
| | | * @return array Inbdexed array with folder names |
| | | */ |
| | | function list_unsubscribed($root='') |
| | | { |
| | | static $sa_unsubscribed; |
| | |
| | | } |
| | | |
| | | |
| | | // subscribe to a specific mailbox(es) |
| | | /** |
| | | * subscribe to a specific mailbox(es) |
| | | */ |
| | | function subscribe($mbox_name, $mode='subscribe') |
| | | { |
| | | if (is_array($mbox_name)) |
| | |
| | | } |
| | | |
| | | |
| | | // unsubscribe mailboxes |
| | | /** |
| | | * unsubscribe mailboxes |
| | | */ |
| | | function unsubscribe($mbox_name) |
| | | { |
| | | if (is_array($mbox_name)) |
| | |
| | | } |
| | | |
| | | |
| | | // create a new mailbox on the server and register it in local cache |
| | | /** |
| | | * Create a new mailbox on the server and register it in local cache |
| | | * |
| | | * @param string New mailbox name (as utf-7 string) |
| | | * @param boolean True if the new mailbox should be subscribed |
| | | * @param string Name of the created mailbox, false on error |
| | | */ |
| | | function create_mailbox($name, $subscribe=FALSE) |
| | | { |
| | | $result = FALSE; |
| | |
| | | // replace backslashes |
| | | $name = preg_replace('/[\\\]+/', '-', $name); |
| | | |
| | | $name_enc = UTF7EncodeString($name); |
| | | |
| | | // reduce mailbox name to 100 chars |
| | | $name_enc = substr($name_enc, 0, 100); |
| | | $name = substr($name, 0, 100); |
| | | |
| | | $abs_name = $this->_mod_mailbox($name_enc); |
| | | $abs_name = $this->_mod_mailbox($name); |
| | | $a_mailbox_cache = $this->get_cache('mailboxes'); |
| | | |
| | | if (strlen($abs_name) && (!is_array($a_mailbox_cache) || !in_array($abs_name, $a_mailbox_cache))) |
| | | |
| | | if (strlen($abs_name) && (!is_array($a_mailbox_cache) || !in_array_nocase($abs_name, $a_mailbox_cache))) |
| | | $result = iil_C_CreateFolder($this->conn, $abs_name); |
| | | |
| | | // update mailboxlist cache |
| | | if ($result && $subscribe) |
| | | $this->subscribe($name_enc); |
| | | // try to subscribe it |
| | | if ($subscribe) |
| | | $this->subscribe($name); |
| | | |
| | | return $result ? $name : FALSE; |
| | | } |
| | | |
| | | |
| | | // set a new name to an existing mailbox |
| | | /** |
| | | * Set a new name to an existing mailbox |
| | | * |
| | | * @param string Mailbox to rename (as utf-7 string) |
| | | * @param string New mailbox name (as utf-7 string) |
| | | * @param string Name of the renames mailbox, false on error |
| | | */ |
| | | function rename_mailbox($mbox_name, $new_name) |
| | | { |
| | | $result = FALSE; |
| | |
| | | $name = preg_replace('/[\\\]+/', '-', $new_name); |
| | | |
| | | // encode mailbox name and reduce it to 100 chars |
| | | $name_enc = substr(UTF7EncodeString($new_name), 0, 100); |
| | | $name = substr($new_name, 0, 100); |
| | | |
| | | // make absolute path |
| | | $mailbox = $this->_mod_mailbox($mbox_name); |
| | | $abs_name = $this->_mod_mailbox($name_enc); |
| | | |
| | | $abs_name = $this->_mod_mailbox($name); |
| | | |
| | | if (strlen($abs_name)) |
| | | $result = iil_C_RenameFolder($this->conn, $mailbox, $abs_name); |
| | | |
| | | |
| | | // clear cache |
| | | if ($result) |
| | | { |
| | | $this->clear_message_cache($mailbox.'.msg'); |
| | | $this->clear_cache('mailboxes'); |
| | | } |
| | | |
| | | // try to subscribe it |
| | | $this->subscribe($name); |
| | | |
| | | return $result ? $name : FALSE; |
| | | } |
| | | |
| | | |
| | | // remove mailboxes from server |
| | | /** |
| | | * remove mailboxes from server |
| | | */ |
| | | function delete_mailbox($mbox_name) |
| | | { |
| | | $deleted = FALSE; |
| | |
| | | |
| | | // unsubscribe mailbox before deleting |
| | | iil_C_UnSubscribe($this->conn, $mailbox); |
| | | |
| | | |
| | | // send delete command to server |
| | | $result = iil_C_DeleteFolder($this->conn, $mailbox); |
| | | if ($result>=0) |
| | |
| | | return $deleted; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Create all folders specified as default |
| | | */ |
| | | function create_default_folders() |
| | | { |
| | | $a_folders = iil_C_ListMailboxes($this->conn, $this->_mod_mailbox(''), '*'); |
| | | $a_subscribed = iil_C_ListSubscribed($this->conn, $this->_mod_mailbox(''), '*'); |
| | | |
| | | // create default folders if they do not exist |
| | | foreach ($this->default_folders as $folder) |
| | | { |
| | | $abs_name = $this->_mod_mailbox($folder); |
| | | if (!in_array_nocase($abs_name, $a_subscribed)) |
| | | { |
| | | if (!in_array_nocase($abs_name, $a_folders)) |
| | | $this->create_mailbox($folder, TRUE); |
| | | else |
| | | $this->subscribe($folder); |
| | | } |
| | | } |
| | | } |
| | | |
| | | |
| | | |
| | |
| | | |
| | | function _mod_mailbox($mbox_name, $mode='in') |
| | | { |
| | | if ((!empty($this->root_ns) && $this->root_ns == $mbox_name) || ($mbox_name == 'INBOX' && $mode == 'in')) |
| | | if ((!empty($this->root_ns) && $this->root_ns == $mbox_name) || $mbox_name == 'INBOX') |
| | | return $mbox_name; |
| | | |
| | | if (!empty($this->root_dir) && $mode=='in') |
| | |
| | | { |
| | | if ($folder{0}=='.') |
| | | continue; |
| | | |
| | | if (($p = array_search(strtolower($folder), $this->default_folders))!==FALSE) |
| | | |
| | | if (($p = array_search(strtolower($folder), $this->default_folders_lc))!==FALSE) |
| | | $a_defaults[$p] = $folder; |
| | | else |
| | | $a_out[] = $folder; |