diff --git a/program/lib/Roundcube/rcube_imap_generic.php b/program/lib/Roundcube/rcube_imap_generic.php index 85cbfa91e..3ec216740 100644 --- a/program/lib/Roundcube/rcube_imap_generic.php +++ b/program/lib/Roundcube/rcube_imap_generic.php @@ -301,12 +301,12 @@ class rcube_imap_generic /** * Response parser. * - * @param string $string Response text - * @param string $err_prefix Error message prefix + * @param string $string Response text + * @param string $err_prefix Error message prefix * * @return int Response status */ - function parseResult($string, $err_prefix='') + function parseResult($string, $err_prefix = '') { if (preg_match('/^[a-z0-9*]+ (OK|NO|BAD|BYE)(.*)$/i', trim($string), $matches)) { $res = strtoupper($matches[1]); @@ -314,11 +314,14 @@ class rcube_imap_generic if ($res == 'OK') { $this->errornum = self::ERROR_OK; - } else if ($res == 'NO') { + } + else if ($res == 'NO') { $this->errornum = self::ERROR_NO; - } else if ($res == 'BAD') { + } + else if ($res == 'BAD') { $this->errornum = self::ERROR_BAD; - } else if ($res == 'BYE') { + } + else if ($res == 'BYE') { $this->closeSocket(); $this->errornum = self::ERROR_BYE; } @@ -341,6 +344,7 @@ class rcube_imap_generic $this->data['COPYUID'] = array($m[1], $m[2]); } } + $this->result = $str; if ($this->errornum != self::ERROR_OK) { @@ -391,7 +395,7 @@ class rcube_imap_generic /** * Error code/message setter. */ - function setError($code, $msg = '') + protected function setError($code, $msg = '') { $this->errornum = $code; $this->error = $msg; @@ -408,7 +412,7 @@ class rcube_imap_generic * * @return bool True any check is true or connection is closed. */ - function startsWith($string, $match, $error = false, $nonempty = false) + protected function startsWith($string, $match, $error = false, $nonempty = false) { if (!$this->fp) { return true; @@ -432,6 +436,9 @@ class rcube_imap_generic return false; } + /** + * Capabilities checker + */ protected function hasCapability($name) { if (empty($this->capability) || $name == '') { @@ -463,7 +470,7 @@ class rcube_imap_generic * * @return mixed Capability values array for key=value pairs, true/false for others */ - function getCapability($name) + public function getCapability($name) { $result = $this->hasCapability($name); @@ -487,7 +494,10 @@ class rcube_imap_generic return $this->hasCapability($name); } - function clearCapability() + /** + * Clears detected server capabilities + */ + public function clearCapability() { $this->capability = array(); $this->capability_readed = false; @@ -502,7 +512,7 @@ class rcube_imap_generic * * @return resource Connection resourse on success, error code on error */ - function authenticate($user, $pass, $type = 'PLAIN') + protected function authenticate($user, $pass, $type = 'PLAIN') { if ($type == 'CRAM-MD5' || $type == 'DIGEST-MD5') { if ($type == 'DIGEST-MD5' && !class_exists('Auth_SASL')) { @@ -557,8 +567,9 @@ class rcube_imap_generic $authc = $user; $user = ''; } + $auth_sasl = Auth_SASL::factory('digestmd5'); - $reply = base64_encode($auth_sasl->getResponse($authc, $pass, + $reply = base64_encode($auth_sasl->getResponse($authc, $pass, base64_decode($challenge), $this->host, 'imap', $user)); // send result @@ -581,10 +592,10 @@ class rcube_imap_generic $this->putLine(''); } - $line = $this->readReply(); + $line = $this->readReply(); $result = $this->parseResult($line); } - elseif ($type == 'GSSAPI') { + else if ($type == 'GSSAPI') { if (!extension_loaded('krb5')) { $this->setError(self::ERROR_BYE, "The krb5 extension is required for GSSAPI authentication"); @@ -672,7 +683,7 @@ class rcube_imap_generic // send result, get reply and process it $this->putLine($reply, true, true); - $line = $this->readReply(); + $line = $this->readReply(); $result = $this->parseResult($line); } } @@ -694,12 +705,12 @@ class rcube_imap_generic /** * LOGIN Authentication * - * @param string $user - * @param string $pass + * @param string $user Username + * @param string $pass Password * * @return resource Connection resourse on success, error code on error */ - function login($user, $password) + protected function login($user, $password) { list($code, $response) = $this->execute('LOGIN', array( $this->escape($user), $this->escape($password)), self::COMMAND_CAPABILITY | self::COMMAND_ANONYMIZED); @@ -721,7 +732,7 @@ class rcube_imap_generic * * @return string The delimiter */ - function getHierarchyDelimiter() + public function getHierarchyDelimiter() { if ($this->prefs['delimiter']) { return $this->prefs['delimiter']; @@ -746,7 +757,7 @@ class rcube_imap_generic * * @return array Namespace data hash (personal, other, shared) */ - function getNamespace() + public function getNamespace() { if (array_key_exists('namespace', $this->prefs)) { return $this->prefs['namespace']; @@ -786,7 +797,7 @@ class rcube_imap_generic * * @return bool True on success, False on failure */ - function connect($host, $user, $password, $options = null) + public function connect($host, $user, $password, $options = null) { // configure $this->set_prefs($options); @@ -1032,7 +1043,7 @@ class rcube_imap_generic * * @return bool True if connection is active and user is logged in, False otherwise. */ - function connected() + public function connected() { return ($this->fp && $this->logged) ? true : false; } @@ -1040,7 +1051,7 @@ class rcube_imap_generic /** * Closes connection with logout. */ - function closeConnection() + public function closeConnection() { if ($this->logged && $this->putLine($this->nextTag() . ' LOGOUT')) { $this->readReply(); @@ -1057,7 +1068,7 @@ class rcube_imap_generic * * @return boolean True on success, false on error */ - function select($mailbox, $qresync_data = null) + public function select($mailbox, $qresync_data = null) { if (!strlen($mailbox)) { return false; @@ -1158,7 +1169,7 @@ class rcube_imap_generic * @return array Status item-value hash * @since 0.5-beta */ - function status($mailbox, $items = array()) + public function status($mailbox, $items = array()) { if (!strlen($mailbox)) { return false; @@ -1211,7 +1222,7 @@ class rcube_imap_generic * * @return boolean True on success, False on error */ - function expunge($mailbox, $messages = null) + public function expunge($mailbox, $messages = null) { if (!$this->select($mailbox)) { return false; @@ -1247,7 +1258,7 @@ class rcube_imap_generic * @return boolean True on success, False on error * @since 0.5 */ - function close() + public function close() { $result = $this->execute('CLOSE', null, self::COMMAND_NORESPONSE); @@ -1266,12 +1277,12 @@ class rcube_imap_generic * * @return boolean True on success, False on error */ - function subscribe($mailbox) + public function subscribe($mailbox) { $result = $this->execute('SUBSCRIBE', array($this->escape($mailbox)), self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } /** @@ -1281,23 +1292,23 @@ class rcube_imap_generic * * @return boolean True on success, False on error */ - function unsubscribe($mailbox) + public function unsubscribe($mailbox) { $result = $this->execute('UNSUBSCRIBE', array($this->escape($mailbox)), self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } /** * Folder creation (CREATE) * * @param string $mailbox Mailbox name - * @param array $types Optional folder types (RFC 6154) + * @param array $types Optional folder types (RFC 6154) * * @return bool True on success, False on error */ - function createFolder($mailbox, $types = null) + public function createFolder($mailbox, $types = null) { $args = array($this->escape($mailbox)); @@ -1308,7 +1319,7 @@ class rcube_imap_generic $result = $this->execute('CREATE', $args, self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } /** @@ -1318,12 +1329,12 @@ class rcube_imap_generic * * @return bool True on success, False on error */ - function renameFolder($from, $to) + public function renameFolder($from, $to) { $result = $this->execute('RENAME', array($this->escape($from), $this->escape($to)), self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } /** @@ -1333,12 +1344,12 @@ class rcube_imap_generic * * @return boolean True on success, False on error */ - function deleteFolder($mailbox) + public function deleteFolder($mailbox) { $result = $this->execute('DELETE', array($this->escape($mailbox)), self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } /** @@ -1348,18 +1359,19 @@ class rcube_imap_generic * * @return boolean True on success, False on error */ - function clearFolder($mailbox) + public function clearFolder($mailbox) { - $num_in_trash = $this->countMessages($mailbox); - if ($num_in_trash > 0) { + if ($this->countMessages($mailbox) > 0) { $res = $this->flag($mailbox, '1:*', 'DELETED'); } if ($res) { - if ($this->selected === $mailbox) + if ($this->selected === $mailbox) { $res = $this->close(); - else + } + else { $res = $this->expunge($mailbox); + } } return $res; @@ -1376,7 +1388,7 @@ class rcube_imap_generic * @return array|bool List of mailboxes or hash of options if STATUS/MYROGHTS response * is requested, False on error. */ - function listMailboxes($ref, $mailbox, $return_opts=array(), $select_opts=array()) + public function listMailboxes($ref, $mailbox, $return_opts = array(), $select_opts = array()) { return $this->_listMailboxes($ref, $mailbox, false, $return_opts, $select_opts); } @@ -1391,7 +1403,7 @@ class rcube_imap_generic * @return array|bool List of mailboxes or hash of options if STATUS/MYROGHTS response * is requested, False on error. */ - function listSubscribed($ref, $mailbox, $return_opts = array()) + public function listSubscribed($ref, $mailbox, $return_opts = array()) { return $this->_listMailboxes($ref, $mailbox, true, $return_opts, null); } @@ -1500,11 +1512,13 @@ class rcube_imap_generic // store folder options if ($cmd == 'LIST') { // Add to options array - if (empty($this->data['LIST'][$mailbox])) + if (empty($this->data['LIST'][$mailbox])) { $this->data['LIST'][$mailbox] = $opts; - else if (!empty($opts)) + } + else if (!empty($opts)) { $this->data['LIST'][$mailbox] = array_unique(array_merge( $this->data['LIST'][$mailbox], $opts)); + } } } else if ($lstatus) { @@ -1538,7 +1552,7 @@ class rcube_imap_generic * * @return int Number of messages, False on error */ - function countMessages($mailbox) + public function countMessages($mailbox) { if ($this->selected === $mailbox && isset($this->data['EXISTS'])) { return $this->data['EXISTS']; @@ -1566,7 +1580,7 @@ class rcube_imap_generic * * @return int Number of messages, False on error */ - function countRecent($mailbox) + public function countRecent($mailbox) { if ($this->selected === $mailbox && isset($this->data['RECENT'])) { return $this->data['RECENT']; @@ -1594,7 +1608,7 @@ class rcube_imap_generic * * @return int Number of messages, False on error */ - function countUnseen($mailbox) + public function countUnseen($mailbox) { // Check internal cache $cache = $this->data['STATUS:'.$mailbox]; @@ -1625,7 +1639,7 @@ class rcube_imap_generic * @return array Server identification information key/value hash * @since 0.6 */ - function id($items = array()) + public function id($items = array()) { if (is_array($items) && !empty($items)) { foreach ($items as $key => $value) { @@ -1661,7 +1675,7 @@ class rcube_imap_generic * @return array|bool List of enabled extensions, False on error * @since 0.6 */ - function enable($extension) + public function enable($extension) { if (empty($extension)) { return false; @@ -1714,7 +1728,7 @@ class rcube_imap_generic * * @return rcube_result_index Response data */ - function sort($mailbox, $field = 'ARRIVAL', $criteria = '', $return_uid = false, $encoding = 'US-ASCII') + public function sort($mailbox, $field = 'ARRIVAL', $criteria = '', $return_uid = false, $encoding = 'US-ASCII') { $old_sel = $this->selected; $supported = array('ARRIVAL', 'CC', 'DATE', 'FROM', 'SIZE', 'SUBJECT', 'TO'); @@ -1766,7 +1780,7 @@ class rcube_imap_generic * * @return rcube_result_thread Thread data */ - function thread($mailbox, $algorithm='REFERENCES', $criteria='', $return_uid=false, $encoding='US-ASCII') + public function thread($mailbox, $algorithm = 'REFERENCES', $criteria = '', $return_uid = false, $encoding = 'US-ASCII') { $old_sel = $this->selected; @@ -1803,7 +1817,7 @@ class rcube_imap_generic * * @return rcube_result_index Result data */ - function search($mailbox, $criteria, $return_uid=false, $items=array()) + public function search($mailbox, $criteria, $return_uid = false, $items = array()) { $old_sel = $this->selected; @@ -1860,7 +1874,7 @@ class rcube_imap_generic * * @return rcube_result_index Response data */ - function index($mailbox, $message_set, $index_field='', $skip_deleted=true, + public function index($mailbox, $message_set, $index_field='', $skip_deleted=true, $uidfetch=false, $return_uid=false) { $msg_index = $this->fetchHeaderIndex($mailbox, $message_set, @@ -1878,16 +1892,31 @@ class rcube_imap_generic return new rcube_result_index($mailbox, $msg_index); } - function fetchHeaderIndex($mailbox, $message_set, $index_field='', $skip_deleted=true, - $uidfetch=false, $return_uid=false) + /** + * Fetches specified header/data value for a set of messages. + * + * @param string $mailbox Mailbox name + * @param string|array $message_set Searching criteria (list of messages to return) + * @param string $index_field Field to sort by (ARRIVAL, CC, DATE, FROM, SIZE, SUBJECT, TO) + * @param bool $skip_deleted Makes that DELETED messages will be skipped + * @param bool $uidfetch Enables UID FETCH usage + * @param bool $return_uid Enables returning UIDs instead of IDs + * + * @return array|bool List of header values or False on failure + */ + public function fetchHeaderIndex($mailbox, $message_set, $index_field = '', $skip_deleted = true, + $uidfetch = false, $return_uid = false) { if (is_array($message_set)) { - if (!($message_set = $this->compressMessageSet($message_set))) + if (!($message_set = $this->compressMessageSet($message_set))) { return false; - } else { + } + } + else { list($from_idx, $to_idx) = explode(':', $message_set); if (empty($message_set) || - (isset($to_idx) && $to_idx != '*' && (int)$from_idx > (int)$to_idx)) { + (isset($to_idx) && $to_idx != '*' && (int)$from_idx > (int)$to_idx) + ) { return false; } } @@ -1913,7 +1942,7 @@ class rcube_imap_generic return false; } - /* Do "SELECT" command */ + // Select the mailbox if (!$this->select($mailbox)) { return false; } @@ -1923,26 +1952,33 @@ class rcube_imap_generic $cmd = $uidfetch ? 'UID FETCH' : 'FETCH'; $fields = array(); - if ($return_uid) + if ($return_uid) { $fields[] = 'UID'; - if ($skip_deleted) + } + if ($skip_deleted) { $fields[] = 'FLAGS'; + } if ($mode == 1) { - if ($index_field == 'DATE') + if ($index_field == 'DATE') { $fields[] = 'INTERNALDATE'; + } $fields[] = "BODY.PEEK[HEADER.FIELDS ($index_field)]"; } else if ($mode == 2) { - if ($index_field == 'SIZE') + if ($index_field == 'SIZE') { $fields[] = 'RFC822.SIZE'; - else if (!$return_uid || $index_field != 'UID') + } + else if (!$return_uid || $index_field != 'UID') { $fields[] = $index_field; + } } - else if ($mode == 3 && !$skip_deleted) + else if ($mode == 3 && !$skip_deleted) { $fields[] = 'FLAGS'; - else if ($mode == 4) + } + else if ($mode == 4) { $fields[] = 'INTERNALDATE'; + } $request = "$key $cmd $message_set (" . implode(' ', $fields) . ")"; @@ -1962,10 +1998,12 @@ class rcube_imap_generic $flags = null; if ($return_uid) { - if (preg_match('/UID ([0-9]+)/', $line, $matches)) + if (preg_match('/UID ([0-9]+)/', $line, $matches)) { $id = (int) $matches[1]; - else + } + else { continue; + } } if ($skip_deleted && preg_match('/FLAGS \(([^)]+)\)/', $line, $matches)) { $flags = explode(' ', strtoupper($matches[1])); @@ -1982,38 +2020,48 @@ class rcube_imap_generic } // non-existent/empty Date: header, use INTERNALDATE if (empty($result[$id])) { - if (preg_match('/INTERNALDATE "([^"]+)"/', $line, $matches)) + if (preg_match('/INTERNALDATE "([^"]+)"/', $line, $matches)) { $result[$id] = $this->strToTime($matches[1]); - else + } + else { $result[$id] = 0; + } } - } else if ($mode == 1) { + } + else if ($mode == 1) { if (preg_match('/BODY\[HEADER\.FIELDS \("?(FROM|REPLY-TO|SENDER|TO|SUBJECT)"?\)\] (.*)/', $line, $matches)) { $value = preg_replace(array('/^"*[a-z]+:/i', '/\s+$/sm'), array('', ''), $matches[2]); $result[$id] = trim($value); - } else { + } + else { $result[$id] = ''; } - } else if ($mode == 2) { + } + else if ($mode == 2) { if (preg_match('/' . $index_field . ' ([0-9]+)/', $line, $matches)) { $result[$id] = trim($matches[1]); - } else { + } + else { $result[$id] = 0; } - } else if ($mode == 3) { + } + else if ($mode == 3) { if (!$flags && preg_match('/FLAGS \(([^)]+)\)/', $line, $matches)) { $flags = explode(' ', $matches[1]); } - $result[$id] = in_array('\\'.$index_field, $flags) ? 1 : 0; - } else if ($mode == 4) { + $result[$id] = in_array("\\".$index_field, (array) $flags) ? 1 : 0; + } + else if ($mode == 4) { if (preg_match('/INTERNALDATE "([^"]+)"/', $line, $matches)) { $result[$id] = $this->strToTime($matches[1]); - } else { + } + else { $result[$id] = 0; } } } - } while (!$this->startsWith($line, $key, true, true)); + } + while (!$this->startsWith($line, $key, true, true)); return $result; } @@ -2026,7 +2074,7 @@ class rcube_imap_generic * * @return int Message sequence identifier */ - function UID2ID($mailbox, $uid) + public function UID2ID($mailbox, $uid) { if ($uid > 0) { $index = $this->search($mailbox, "UID $uid"); @@ -2046,7 +2094,7 @@ class rcube_imap_generic * * @return int Message unique identifier */ - function ID2UID($mailbox, $id) + public function ID2UID($mailbox, $id) { if (empty($id) || $id < 0) { return null; @@ -2075,41 +2123,47 @@ class rcube_imap_generic /** * Sets flag of the message(s) * - * @param string $mailbox Mailbox name - * @param string|array $messages Message UID(s) - * @param string $flag Flag name + * @param string $mailbox Mailbox name + * @param string|array $messages Message UID(s) + * @param string $flag Flag name * * @return bool True on success, False on failure */ - function flag($mailbox, $messages, $flag) { + public function flag($mailbox, $messages, $flag) + { return $this->modFlag($mailbox, $messages, $flag, '+'); } /** * Unsets flag of the message(s) * - * @param string $mailbox Mailbox name - * @param string|array $messages Message UID(s) - * @param string $flag Flag name + * @param string $mailbox Mailbox name + * @param string|array $messages Message UID(s) + * @param string $flag Flag name * * @return bool True on success, False on failure */ - function unflag($mailbox, $messages, $flag) { + public function unflag($mailbox, $messages, $flag) + { return $this->modFlag($mailbox, $messages, $flag, '-'); } /** * Changes flag of the message(s) * - * @param string $mailbox Mailbox name - * @param string|array $messages Message UID(s) - * @param string $flag Flag name - * @param string $mod Modifier [+|-]. Default: "+". + * @param string $mailbox Mailbox name + * @param string|array $messages Message UID(s) + * @param string $flag Flag name + * @param string $mod Modifier [+|-]. Default: "+". * * @return bool True on success, False on failure */ protected function modFlag($mailbox, $messages, $flag, $mod = '+') { + if (!$flag) { + return false; + } + if (!$this->select($mailbox)) { return false; } @@ -2123,10 +2177,6 @@ class rcube_imap_generic $flag = $this->flags[strtoupper($flag)]; } - if (!$flag) { - return false; - } - // if PERMANENTFLAGS is not specified all flags are allowed if (!empty($this->data['PERMANENTFLAGS']) && !in_array($flag, (array) $this->data['PERMANENTFLAGS']) @@ -2148,19 +2198,19 @@ class rcube_imap_generic $this->compressMessageSet($messages), $mod . 'FLAGS.SILENT', "($flag)"), self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } /** * Copies message(s) from one folder to another * - * @param string|array $messages Message UID(s) - * @param string $from Mailbox name - * @param string $to Destination mailbox name + * @param string|array $messages Message UID(s) + * @param string $from Mailbox name + * @param string $to Destination mailbox name * * @return bool True on success, False on failure */ - function copy($messages, $from, $to) + public function copy($messages, $from, $to) { // Clear last COPYUID data unset($this->data['COPYUID']); @@ -2176,19 +2226,19 @@ class rcube_imap_generic $this->compressMessageSet($messages), $this->escape($to)), self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } /** * Moves message(s) from one folder to another. * - * @param string|array $messages Message UID(s) - * @param string $from Mailbox name - * @param string $to Destination mailbox name + * @param string|array $messages Message UID(s) + * @param string $from Mailbox name + * @param string $to Destination mailbox name * * @return bool True on success, False on failure */ - function move($messages, $from, $to) + public function move($messages, $from, $to) { if (!$this->select($from)) { return false; @@ -2212,7 +2262,7 @@ class rcube_imap_generic $this->compressMessageSet($messages), $this->escape($to)), self::COMMAND_NORESPONSE); - return ($result == self::ERROR_OK); + return $result == self::ERROR_OK; } // use COPY + STORE +FLAGS.SILENT \Deleted + EXPUNGE @@ -2249,7 +2299,7 @@ class rcube_imap_generic * @return array List of rcube_message_header elements, False on error * @since 0.6 */ - function fetch($mailbox, $message_set, $is_uid = false, $query_items = array(), + public function fetch($mailbox, $message_set, $is_uid = false, $query_items = array(), $mod_seq = null, $vanished = false) { if (!$this->select($mailbox)) { @@ -2275,8 +2325,9 @@ class rcube_imap_generic do { $line = $this->readLine(4096); - if (!$line) + if (!$line) { break; + } // Sample reply line: // * 321 FETCH (UID 2417 RFC822.SIZE 2730 FLAGS (\Seen) @@ -2303,14 +2354,16 @@ class rcube_imap_generic while (strlen($out) < $bytes) { $out = $this->readBytes($bytes); - if ($out === null) + if ($out === null) { break; + } $line .= $out; } $str = $this->readLine(4096); - if ($str === false) + if ($str === false) { break; + } $line .= $str; } @@ -2334,7 +2387,7 @@ class rcube_imap_generic else if ($name == 'FLAGS') { if (!empty($value)) { foreach ((array)$value as $flag) { - $flag = str_replace(array('$', '\\'), '', $flag); + $flag = str_replace(array('$', "\\"), '', $flag); $flag = strtoupper($flag); $result[$id]->flags[$flag] = true; @@ -2364,10 +2417,12 @@ class rcube_imap_generic $this->tokenizeResponse($line, 1); $headers = $this->tokenizeResponse($line, 1); } - else if (strlen($name)) + else if (strlen($name)) { $result[$id]->bodypart[$name] = $value; - else + } + else { $result[$id]->body = $value; + } } } @@ -2377,7 +2432,8 @@ class rcube_imap_generic foreach ($headers as $resln) { if (ord($resln[0]) <= 32) { $lines[$ln] .= (empty($lines[$ln]) ? '' : "\n") . trim($resln); - } else { + } + else { $lines[++$ln] = trim($resln); } } @@ -2393,24 +2449,19 @@ class rcube_imap_generic $result[$id]->date = $string; $result[$id]->timestamp = $this->strToTime($string); break; - case 'from': - $result[$id]->from = $string; - break; case 'to': $result[$id]->to = preg_replace('/undisclosed-recipients:[;,]*/', '', $string); break; + case 'from': case 'subject': - $result[$id]->subject = $string; + case 'cc': + case 'bcc': + case 'references': + $result[$id]->{$field} = $string; break; case 'reply-to': $result[$id]->replyto = $string; break; - case 'cc': - $result[$id]->cc = $string; - break; - case 'bcc': - $result[$id]->bcc = $string; - break; case 'content-transfer-encoding': $result[$id]->encoding = $string; break; @@ -2424,9 +2475,6 @@ class rcube_imap_generic case 'in-reply-to': $result[$id]->in_reply_to = str_replace(array("\n", '<', '>'), '', $string); break; - case 'references': - $result[$id]->references = $string; - break; case 'return-receipt-to': case 'disposition-notification-to': case 'x-confirm-reading-to': @@ -2452,7 +2500,6 @@ class rcube_imap_generic } } } - // VANISHED response (QRESYNC RFC5162) // Sample: * VANISHED (EARLIER) 300:310,405,411 else if (preg_match('/^\* VANISHED [()EARLIER]*/i', $line, $match)) { @@ -2461,8 +2508,8 @@ class rcube_imap_generic $this->data['VANISHED'] = $v_data; } - - } while (!$this->startsWith($line, $key, true)); + } + while (!$this->startsWith($line, $key, true)); return $result; } @@ -2478,7 +2525,7 @@ class rcube_imap_generic * * @return bool|array List of rcube_message_header elements, False on error */ - function fetchHeaders($mailbox, $message_set, $is_uid = false, $bodystr = false, $add_headers = array()) + public function fetchHeaders($mailbox, $message_set, $is_uid = false, $bodystr = false, $add_headers = array()) { $query_items = array('UID', 'RFC822.SIZE', 'FLAGS', 'INTERNALDATE'); $headers = array('DATE', 'FROM', 'TO', 'SUBJECT', 'CONTENT-TYPE', 'CC', 'REPLY-TO', @@ -2495,9 +2542,7 @@ class rcube_imap_generic $query_items[] = 'BODY.PEEK[HEADER.FIELDS (' . implode(' ', $headers) . ')]'; - $result = $this->fetch($mailbox, $message_set, $is_uid, $query_items); - - return $result; + return $this->fetch($mailbox, $message_set, $is_uid, $query_items); } /** @@ -2511,12 +2556,13 @@ class rcube_imap_generic * * @return bool|rcube_message_header Message data, False on error */ - function fetchHeader($mailbox, $id, $is_uid = false, $bodystr = false, $add_headers = array()) + public function fetchHeader($mailbox, $id, $is_uid = false, $bodystr = false, $add_headers = array()) { $a = $this->fetchHeaders($mailbox, $id, $is_uid, $bodystr, $add_headers); if (is_array($a)) { return array_shift($a); } + return false; } @@ -2531,23 +2577,11 @@ class rcube_imap_generic */ public static function sortHeaders($messages, $field, $flag) { - if (empty($field)) { - $field = 'uid'; - } - else { - $field = strtolower($field); - } - - if (empty($flag)) { - $flag = 'ASC'; - } - else { - $flag = strtoupper($flag); - } - // Strategy: First, we'll create an "index" array. // Then, we'll use sort() on that array, and use that to sort the main array. + $field = empty($field) ? 'uid' : strtolower($field); + $flag = empty($flag) ? 'ASC' : strtoupper($flag); $index = array(); $result = array(); @@ -2603,7 +2637,18 @@ class rcube_imap_generic return $result; } - function fetchMIMEHeaders($mailbox, $uid, $parts, $mime=true) + /** + * Fetch MIME headers of specified message parts + * + * @param string $mailbox Mailbox name + * @param int $uid Message UID + * @param array $parts Message part identifiers + * @param bool $mime Use MIME instad of HEADER + * + * @return array|bool Array containing headers string for each specified body + * False on failure. + */ + public function fetchMIMEHeaders($mailbox, $uid, $parts, $mime = true) { if (!$this->select($mailbox)) { return false; @@ -2631,44 +2676,40 @@ class rcube_imap_generic do { $line = $this->readLine(1024); - if (preg_match('/^\* [0-9]+ FETCH [0-9UID( ]+BODY\[([0-9\.]+)\.'.$type.'\]/', $line, $matches)) { - $idx = $matches[1]; - $headers = ''; - - // get complete entry - if (preg_match('/\{([0-9]+)\}\r\n$/', $line, $m)) { - $bytes = $m[1]; - $out = ''; - - while (strlen($out) < $bytes) { - $out = $this->readBytes($bytes); - if ($out === null) - break; - $headers .= $out; - } + if (preg_match('/^\* [0-9]+ FETCH [0-9UID( ]+/', $line, $m)) { + $line = ltrim(substr($line, strlen($m[0]))); + while (preg_match('/^BODY\[([0-9\.]+)\.'.$type.'\]/', $line, $matches)) { + $line = substr($line, strlen($matches[0])); + $result[$matches[1]] = trim($this->multLine($line)); + $line = ltrim($this->readLine(1024)); } - - $result[$idx] = trim($headers); } - } while (!$this->startsWith($line, $key, true)); + } + while (!$this->startsWith($line, $key, true)); return $result; } - function fetchPartHeader($mailbox, $id, $is_uid = false, $part = null) + /** + * Fetches message part header + */ + public function fetchPartHeader($mailbox, $id, $is_uid = false, $part = null) { $part = empty($part) ? 'HEADER' : $part.'.MIME'; return $this->handlePartBody($mailbox, $id, $is_uid, $part); } - function handlePartBody($mailbox, $id, $is_uid=false, $part='', $encoding=null, $print=null, $file=null, $formatted=false, $max_bytes=0) + /** + * Fetches body of the specified message part + */ + public function handlePartBody($mailbox, $id, $is_uid=false, $part='', $encoding=null, $print=null, $file=null, $formatted=false, $max_bytes=0) { if (!$this->select($mailbox)) { return false; } - $binary = true; + $binary = true; do { if (!$initiated) { @@ -2830,7 +2871,8 @@ class rcube_imap_generic } } } - } while (!$this->startsWith($line, $key, true) || !$initiated); + } + while (!$this->startsWith($line, $key, true) || !$initiated); if ($result !== false) { if ($file) { @@ -2858,7 +2900,7 @@ class rcube_imap_generic * * @return string|bool On success APPENDUID response (if available) or True, False on failure */ - function append($mailbox, &$message, $flags = array(), $date = null, $binary = false) + public function append($mailbox, &$message, $flags = array(), $date = null, $binary = false) { unset($this->data['APPENDUID']); @@ -2976,7 +3018,7 @@ class rcube_imap_generic * * @return string|bool On success APPENDUID response (if available) or True, False on failure */ - function appendFromFile($mailbox, $path, $headers=null, $flags = array(), $date = null, $binary = false) + public function appendFromFile($mailbox, $path, $headers=null, $flags = array(), $date = null, $binary = false) { // open message file if (file_exists(realpath($path))) { @@ -3004,7 +3046,7 @@ class rcube_imap_generic * * @return array Quota information */ - function getQuota($mailbox = null) + public function getQuota($mailbox = null) { if ($mailbox === null || $mailbox === '') { $mailbox = 'INBOX'; @@ -3074,7 +3116,7 @@ class rcube_imap_generic * * @since 0.5-beta */ - function setACL($mailbox, $user, $acl) + public function setACL($mailbox, $user, $acl) { if (is_array($acl)) { $acl = implode('', $acl); @@ -3097,7 +3139,7 @@ class rcube_imap_generic * * @since 0.5-beta */ - function deleteACL($mailbox, $user) + public function deleteACL($mailbox, $user) { $result = $this->execute('DELETEACL', array( $this->escape($mailbox), $this->escape($user)), @@ -3114,7 +3156,7 @@ class rcube_imap_generic * @return array User-rights array on success, NULL on error * @since 0.5-beta */ - function getACL($mailbox) + public function getACL($mailbox) { list($code, $response) = $this->execute('GETACL', array($this->escape($mailbox))); @@ -3151,7 +3193,7 @@ class rcube_imap_generic * @return array List of user rights * @since 0.5-beta */ - function listRights($mailbox, $user) + public function listRights($mailbox, $user) { list($code, $response) = $this->execute('LISTRIGHTS', array( $this->escape($mailbox), $this->escape($user))); @@ -3180,7 +3222,7 @@ class rcube_imap_generic * @return array MYRIGHTS response on success, NULL on error * @since 0.5-beta */ - function myRights($mailbox) + public function myRights($mailbox) { list($code, $response) = $this->execute('MYRIGHTS', array($this->escape($mailbox))); @@ -3204,7 +3246,7 @@ class rcube_imap_generic * @return boolean True on success, False on failure * @since 0.5-beta */ - function setMetadata($mailbox, $entries) + public function setMetadata($mailbox, $entries) { if (!is_array($entries) || empty($entries)) { $this->setError(self::ERROR_COMMAND, "Wrong argument for SETMETADATA command"); @@ -3233,7 +3275,7 @@ class rcube_imap_generic * * @since 0.5-beta */ - function deleteMetadata($mailbox, $entries) + public function deleteMetadata($mailbox, $entries) { if (!is_array($entries) && !empty($entries)) { $entries = explode(' ', $entries); @@ -3262,7 +3304,7 @@ class rcube_imap_generic * * @since 0.5-beta */ - function getMetadata($mailbox, $entries, $options=array()) + public function getMetadata($mailbox, $entries, $options=array()) { if (!is_array($entries)) { $entries = array($entries); @@ -3353,7 +3395,7 @@ class rcube_imap_generic * @return boolean True on success, False on failure * @since 0.5-beta */ - function setAnnotation($mailbox, $data) + public function setAnnotation($mailbox, $data) { if (!is_array($data) || empty($data)) { $this->setError(self::ERROR_COMMAND, "Wrong argument for SETANNOTATION command"); @@ -3384,7 +3426,7 @@ class rcube_imap_generic * * @since 0.5-beta */ - function deleteAnnotation($mailbox, $data) + public function deleteAnnotation($mailbox, $data) { if (!is_array($data) || empty($data)) { $this->setError(self::ERROR_COMMAND, "Wrong argument for SETANNOTATION command"); @@ -3405,7 +3447,7 @@ class rcube_imap_generic * * @since 0.5-beta */ - function getAnnotation($mailbox, $entries, $attribs) + public function getAnnotation($mailbox, $entries, $attribs) { if (!is_array($entries)) { $entries = array($entries); @@ -3494,13 +3536,15 @@ class rcube_imap_generic * @return array/bool Body structure array or False on error. * @since 0.6 */ - function getStructure($mailbox, $id, $is_uid = false) + public function getStructure($mailbox, $id, $is_uid = false) { $result = $this->fetch($mailbox, $id, $is_uid, array('BODYSTRUCTURE')); + if (is_array($result)) { $result = array_shift($result); return $result->bodystructure; } + return false; } @@ -3512,7 +3556,7 @@ class rcube_imap_generic * * @return array Part data as hash array (type, encoding, charset, size) */ - static function getStructurePartData($structure, $part) + public static function getStructurePartData($structure, $part) { $part_a = self::getStructurePartArray($structure, $part); $data = array(); @@ -3548,7 +3592,7 @@ class rcube_imap_generic return $data; } - static function getStructurePartArray($a, $part) + public static function getStructurePartArray($a, $part) { if (!is_array($a)) { return false; @@ -3583,7 +3627,7 @@ class rcube_imap_generic * @return string Command identifier * @since 0.5-beta */ - function nextTag() + public function nextTag() { $this->cmd_num++; $this->cmd_tag = sprintf('A%04d', $this->cmd_num); @@ -3601,7 +3645,7 @@ class rcube_imap_generic * @return mixed Response code or list of response code and data * @since 0.5-beta */ - function execute($command, $arguments=array(), $options=0) + public function execute($command, $arguments=array(), $options=0) { $tag = $this->nextTag(); $query = $tag . ' ' . $command; @@ -3626,7 +3670,8 @@ class rcube_imap_generic if ($response !== null) { $response .= $line; } - } while (!$this->startsWith($line, $tag . ' ', true, true)); + } + while (!$this->startsWith($line, $tag . ' ', true, true)); $code = $this->parseResult($line, $command . ': '); @@ -3660,7 +3705,7 @@ class rcube_imap_generic * @return mixed Tokens array or string if $num=1 * @since 0.5-beta */ - static function tokenizeResponse(&$str, $num=0) + public static function tokenizeResponse(&$str, $num=0) { $result = array(); @@ -3735,7 +3780,7 @@ class rcube_imap_generic return $num == 1 ? $result[0] : $result; } - static function r_implode($element) + protected static function r_implode($element) { $string = ''; @@ -3760,7 +3805,7 @@ class rcube_imap_generic * * @return string Compressed sequence-set */ - static function compressMessageSet($messages, $force=false) + public static function compressMessageSet($messages, $force=false) { // given a comma delimited list of independent mid's, // compresses by grouping sequences together @@ -3790,7 +3835,8 @@ class rcube_imap_generic if ($incr > 1) { // found a gap if ($start == $prev) { $result[] = $prev; // push single id - } else { + } + else { $result[] = $start . ':' . $prev; // push sequence as start_id:end_id } $start = $id; // start of new sequence @@ -3801,7 +3847,8 @@ class rcube_imap_generic // handle the last sequence/id if ($start == $prev) { $result[] = $prev; - } else { + } + else { $result[] = $start.':'.$prev; } @@ -3816,7 +3863,7 @@ class rcube_imap_generic * * @return array List of message identifiers */ - static function uncompressMessageSet($messages) + public static function uncompressMessageSet($messages) { if (empty($messages)) { return array(); @@ -3904,7 +3951,7 @@ class rcube_imap_generic * * @return int Unix timestamp */ - static function strToTime($date) + protected static function strToTime($date) { // Clean malformed data $date = preg_replace( @@ -3966,7 +4013,7 @@ class rcube_imap_generic * @return string String atom, quoted-string or string literal * @todo lists */ - static function escape($string, $force_quotes=false) + public static function escape($string, $force_quotes=false) { if ($string === null) { return 'NIL'; @@ -3998,9 +4045,9 @@ class rcube_imap_generic * * @since 0.5-stable */ - function setDebug($debug, $handler = null) + public function setDebug($debug, $handler = null) { - $this->debug = $debug; + $this->debug = $debug; $this->debug_handler = $handler; } @@ -4025,7 +4072,8 @@ class rcube_imap_generic if ($this->debug_handler) { call_user_func_array($this->debug_handler, array(&$this, $message)); - } else { + } + else { echo "DEBUG: $message\n"; } }