summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2011-10-27 12:38:06 (GMT)
committerJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2011-10-27 12:41:02 (GMT)
commit8a5a8f38c03289ee03d4ebfd63e6ad7ed8ace479 (patch)
tree4ac8f2c63c936ac04b9df13b846d73c5281bde7a
parentb86b698090f6b592dc2730ac42f16c27e1798f5a (diff)
downloadNet_IMAP4-8a5a8f38c03289ee03d4ebfd63e6ad7ed8ace479.tar.gz
Initial conversion of rcube_imap_generic.php into a stand-alone pear library
-rw-r--r--lib/Net/IMAP4.php3912
-rw-r--r--lib/Net/IMAP4/MessageHeader.php34
2 files changed, 3946 insertions, 0 deletions
diff --git a/lib/Net/IMAP4.php b/lib/Net/IMAP4.php
new file mode 100644
index 0000000..eef1341
--- /dev/null
+++ b/lib/Net/IMAP4.php
@@ -0,0 +1,3912 @@
+<?php
+
+ require_once(dirname(__FILE__) . '/IMAP4/MessageHeader.php');
+
+ class Net_IMAP4 {
+
+ // Proxy authorization ID and password
+ public $auth_cid = NULL;
+ public $auth_pw = NULL;
+ public $ident = "pear-Net_IMAP4";
+
+ // The following 6 properties should be private, but
+ // need to be public for rcube_imap's sake. We would rather
+ // access these through functions.
+ public $data = Array();
+ public $selected;
+ public $error;
+ public $errornum;
+ public $result;
+ public $resultcode;
+
+ // debug config is done through set_debug()
+ private $_debug = false;
+ private $_debug_handler = false;
+
+ // These are for connect()
+ private $host = 'localhost';
+ private $port = 143;
+ // Set these with connect()'s $options parameter
+ private $auth_method = 'CHECK';
+ private $force_caps = true;
+ private $timeout = 0;
+ private $literal = false;
+ /*
+ SSL mode, set to 'ssl', 'tls' or false
+ */
+ private $ssl_mode = 'tls';
+
+ // These are detected.
+ private $namespaces = Array(
+ 'personal' => Array(
+ "",
+ "/"
+ ),
+ 'user' => Array(
+ "Other Users",
+ "/"
+ ),
+ "shared" => Array(
+ "Shared Folders",
+ "/"
+ )
+ );
+
+ private $hierarchy_separator = "/";
+
+ // These are runtime status tracking
+ private $capability = Array();
+ private $capability_read = false;
+ private $cmd_tag;
+ private $cmd_num = 0;
+ private $fp;
+ private $logged = false;
+
+ // Constants
+ public $flags = array(
+ 'SEEN' => '\\Seen',
+ 'DELETED' => '\\Deleted',
+ 'ANSWERED' => '\\Answered',
+ 'DRAFT' => '\\Draft',
+ 'FLAGGED' => '\\Flagged',
+ 'FORWARDED' => '$Forwarded',
+ 'MDNSENT' => '$MDNSent',
+ '*' => '\\*',
+ );
+
+ const ERROR_OK = 0;
+ const ERROR_NO = -1;
+ const ERROR_BAD = -2;
+ const ERROR_BYE = -3;
+ const ERROR_UNKNOWN = -4;
+ const ERROR_COMMAND = -5;
+ const ERROR_READONLY = -6;
+
+ const COMMAND_NORESPONSE = 1;
+ const COMMAND_CAPABILITY = 2;
+ const COMMAND_LASTLINE = 4;
+
+ public static $compat_func = Array(
+ /*
+ IMAP functions
+ */
+ "append" => "imap_append",
+ "close" => "imap_close",
+ "connect" => "imap_connect",
+ "copy" => "imap_copy",
+ "createFolder" => "imap_create",
+ "deleteFolder" => "imap_delete",
+ "deleteACL" => "imap_deleteacl",
+ "closeConnection" => "imap_disconnect",
+ "enable" => 'imap_enable',
+ "expunge" => "imap_expunge",
+ "fetch" => 'imap_fetch',
+ "flag" => "imap_flag",
+ "getACL" => "imap_getacl",
+ "getAnnotation" => "imap_getannotation",
+ "getMetadata" => "imap_getmetadata",
+ "getNamespace" => "imap_namespace",
+ "getQuota" => "imap_getquotaroot",
+ "id" => "imap_id",
+ "listMailboxes" => "imap_list",
+ "listRights" => "imap_listrights",
+ "listSubscribed" => "imap_lsub",
+ "move" => "imap_move",
+ "myRights" => "imap_myrights",
+ "renameFolder" => "imap_rename",
+ "search" => "imap_search",
+ "select" => "imap_select",
+ "setACL" => "imap_setacl",
+ "setAnnotation" => "imap_setannotation",
+ "setMetadata" => "imap_setmetadata",
+ "sort" => "imap_sort",
+ "status" => "imap_status",
+ "subscribe" => "imap_subscribe",
+ "thread" => "imap_thread",
+ "unflag" => "imap_unflag",
+ "unsubscribe" => "imap_unsubscribe",
+ /*
+ Additional functions
+ */
+ "appendFromFile" => 'append_from_file',
+ "clearFolder" => "clear_folder",
+ "countMessages" => "count_messages",
+ "countRecent" => "count_recent",
+ "countUnseen" => "count_unseen",
+ "fetchHeader" => "fetch_header",
+ "fetchHeaderIndex" => "fetch_header_index",
+ "fetchHeaders" => "fetch_headers",
+ "fetchMIMEHeaders" => "fetch_mime_headers",
+ "fetchPartHeader" => "fetch_part_header",
+ "fetchUIDs" => "fetch_uids",
+ "getHierarchyDelimiter" => "get_hierarchyseperator",
+ "deleteAnnotation" => "imap_deleteannotation",
+ "deleteMetadata" => "imap_deletemetadata",
+ "setDebug" => "set_debug",
+
+ "clearCapability" => "_clear_capability",
+ "escape" => "_escape",
+ "getCapability" => "_get_capability",
+ "hasCapability" => "_has_capability",
+ "parseCapability" => "_parse_capability",
+ "parseThread" => "_parse_thread",
+ "closeSocket" => "__close_socket",
+ "compressMessageSet" => "__compress_messageset",
+ "eof" => "__eof",
+ "execute" => "__execute",
+ "_listMailboxes" => "__list",
+ "multLine" => "__multi_line",
+ "nextTag" => "__next_tag",
+ "parseResult" => "__parse_result",
+ "putLine" => "__put_line",
+ "putLineC" => "__put_line_c",
+ "readBytes" => "__read_bytes",
+ "readReply" => "__read_reply",
+ "readLine" => "__read_line",
+ "setError" => "__set_error",
+ "startsWith" => "__starts_with",
+ "modFlag" => "__store_flag",
+ "tokenizeResponse" => "__tokenize_response",
+ "_xor" => "__xor",
+ // Not done
+ "getStructure" => "get_structure",
+ "getStructurePartArray" => "get_structure_part_array",
+ "getStructurePartCharset" => "get_structure_part_charset",
+ "getStructurePartEncoding" => "get_structure_part_encoding",
+ "getStructurePartType" => "get_structure_part_type",
+ "handlePartBody" => "handle_part_body",
+ "ID2UID" => "id_to_uid",
+ "sortHeaders" => "sort_headers",
+ "r_implode" => NULL,
+ "strToTime" => "str_to_time",
+ "UID2ID" => "uid_to_id",
+ "uncompressMessageSet" => "__uncompress_messageset",
+ "unEscape" => NULL,
+ );
+
+ function __construct() {
+ }
+
+ function __call($name, $args) {
+ if (array_key_exists($name, self::$compat_func)) {
+ error_log(
+ "Calling $name is deprecated in favor of " .
+ self::$compat_func[$name]
+ );
+
+ return call_user_func_array(array($this, self::$compat_func[$name]), $args);
+ } else {
+ }
+ }
+
+ public static function __callStatic($name, $args) {
+ if (array_key_exists($name, self::$compat_func)) {
+ error_log(
+ "Calling $name is deprecated in favor of " .
+ self::$compat_func[$name]
+ );
+
+ return call_user_func_array(array(self, self::$compat_func[$name]), $args);
+ } else {
+ }
+ }
+
+ /**
+ * General IMAP4 pear library functions.
+ */
+
+ public function connected() {
+ return ($this->fp && $this->logged) ? true : false;
+ }
+
+ public function error() {
+ return Array($this->errornum, $this->error);
+ }
+
+ public function result() {
+ return Array($this->resultcode, $this->result);
+ }
+
+ /*
+ LOGIN Authentication
+
+ @param string $user
+ @param string $pass
+
+ @return resource Connection resourse on success, error code on error
+ */
+ public function login($user, $password) {
+ list($code, $response) = $this->__execute(
+ 'LOGIN',
+ Array(
+ $this->_escape($user),
+ $this->_escape($password)
+ ),
+ self::COMMAND_CAPABILITY
+ );
+
+ // re-set capabilities list if untagged CAPABILITY response provided
+ if (preg_match('/\* CAPABILITY (.+)/i', $response, $matches)) {
+ $this->_parse_capability($matches[1], true);
+ }
+
+ if ($code == self::ERROR_OK) {
+ return $this->fp;
+ }
+
+ return $code;
+ }
+
+ /*
+ DIGEST-MD5/CRAM-MD5/PLAIN Authentication
+
+ @param string $user
+ @param string $pass
+ @param string $type Authentication type (PLAIN/CRAM-MD5/DIGEST-MD5)
+
+ @return resource Connection resourse on success, error code on error
+ */
+ public function authenticate($user, $pass, $type='PLAIN') {
+ if ($type == 'CRAM-MD5' || $type == 'DIGEST-MD5') {
+ if ($type == 'DIGEST-MD5' && !class_exists('Auth_SASL')) {
+ $this->__set_error(
+ self::ERROR_BYE,
+ "The Auth_SASL package is required for " .
+ "DIGEST-MD5 authentication"
+ );
+
+ return self::ERROR_BAD;
+ }
+
+ $this->__put_line($this->__next_tag() . " AUTHENTICATE $type");
+ $line = trim($this->__read_reply());
+
+ if ($line[0] == '+') {
+ $challenge = substr($line, 2);
+ }
+ else {
+ return $this->__parse_result($line);
+ }
+
+ if ($type == 'CRAM-MD5') {
+ // RFC2195: CRAM-MD5
+ $ipad = '';
+ $opad = '';
+
+ // initialize ipad, opad
+ for ($i=0; $i<64; $i++) {
+ $ipad .= chr(0x36);
+ $opad .= chr(0x5C);
+ }
+
+ // pad $pass so it's 64 bytes
+ $padLen = 64 - strlen($pass);
+ for ($i=0; $i<$padLen; $i++) {
+ $pass .= chr(0);
+ }
+
+ // generate hash
+ $hash = md5(
+ $this->__xor($pass, $opad) .
+ pack(
+ "H*",
+ md5(
+ $this->__xor($pass, $ipad) .
+ base64_decode($challenge)
+ )
+ )
+ );
+
+ $reply = base64_encode($user . ' ' . $hash);
+
+ // send result
+ $this->__put_line($reply);
+ } else {
+ // RFC2831: DIGEST-MD5
+ // proxy authorization
+ if (!empty($this->auth_cid)) {
+ $authc = $this->auth_cid;
+ $pass = $this->auth_pw;
+ } else {
+ $authc = $user;
+ }
+
+ $auth_sasl = Auth_SASL::factory('digestmd5');
+ $reply = base64_encode(
+ $auth_sasl->getResponse(
+ $authc,
+ $pass,
+ base64_decode($challenge),
+ $this->host,
+ 'imap',
+ $user
+ )
+ );
+
+ // send result
+ $this->__put_line($reply);
+ $line = trim($this->__read_reply());
+
+ if ($line[0] == '+') {
+ $challenge = substr($line, 2);
+ }
+ else {
+ return $this->__parse_result($line);
+ }
+
+ // check response
+ $challenge = base64_decode($challenge);
+ if (strpos($challenge, 'rspauth=') === false) {
+ $this->__set_error(
+ self::ERROR_BAD,
+ "Unexpected response from server to " .
+ "DIGEST-MD5 response"
+ );
+
+ return self::ERROR_BAD;
+ }
+
+ $this->__put_line('');
+ }
+
+ $line = $this->__read_reply();
+ $result = $this->__parse_result($line);
+ }
+ else { // PLAIN
+ // proxy authorization
+ if (!empty($this->auth_cid)) {
+ $authc = $this->auth_cid;
+ $pass = $this->auth_pw;
+ }
+ else {
+ $authc = $user;
+ }
+
+ $reply = base64_encode($user .chr(0). $authc .chr(0). $pass);
+
+ // RFC 4959 (SASL-IR): save one round trip
+ if ($this->_get_capability('SASL-IR')) {
+ list($result, $line) = $this->__execute(
+ "AUTHENTICATE PLAIN",
+ Array($reply),
+ self::COMMAND_LASTLINE | self::COMMAND_CAPABILITY
+ );
+
+ } else {
+ $this->__put_line(
+ $this->__next_tag() . " AUTHENTICATE PLAIN"
+ );
+
+ $line = trim($this->__read_reply());
+
+ if ($line[0] != '+') {
+ return $this->__parse_result($line);
+ }
+
+ // send result, get reply and process it
+ $this->__put_line($reply);
+ $line = $this->__read_reply();
+ $result = $this->__parse_result($line);
+ }
+ }
+
+ if ($result == self::ERROR_OK) {
+ // optional CAPABILITY response
+ if (
+ $line &&
+ preg_match('/\[CAPABILITY ([^]]+)\]/i', $line, $matches)
+ ) {
+
+ $this->_parse_capability($matches[1], true);
+ }
+ return $this->fp;
+
+ } else {
+ $this->__set_error($result, "AUTHENTICATE $type: $line");
+ }
+
+ return $result;
+ }
+
+
+################################################################################
+################################################################################
+################################################################################
+ /**
+ * IMAP commands
+ */
+################################################################################
+################################################################################
+################################################################################
+
+ /*
+ Executes APPEND command.
+
+ @param $mailbox string Mailbox name.
+ */
+ public function imap_append($mailbox, &$message) {
+ if (!$mailbox) {
+ return false;
+ }
+
+ $message = str_replace("\r", '', $message);
+ $message = str_replace("\n", "\r\n", $message);
+
+ $len = strlen($message);
+ if (!$len) {
+ return false;
+ }
+
+ $key = $this->__next_tag();
+ $request = sprintf(
+ "$key APPEND %s (\\Seen) {%d%s}",
+ $this->_escape($mailbox),
+ $len,
+ ($this->literal ? '+' : '')
+ );
+
+ if ($this->__put_line($request)) {
+ // Don't wait when LITERAL+ is supported
+ if (!$this->literal) {
+ $line = $this->__read_reply();
+
+ if ($line[0] != '+') {
+ $this->__parse_result($line, 'APPEND: ');
+ return false;
+ }
+ }
+
+ if (!$this->__put_line($message)) {
+ return false;
+ }
+
+ do {
+ $line = $this->__read_line();
+ } while (!$this->__starts_with($line, $key, true, true));
+
+ // Clear internal status cache
+ unset($this->data['STATUS:'.$mailbox]);
+
+ $result = $this->__parse_result($line, 'APPEND: ');
+ return ($result == self::ERROR_OK);
+
+ } else {
+ $this->__set_error(
+ self::ERROR_COMMAND,
+ "Unable to send command: $request"
+ );
+ }
+
+ return false;
+ }
+
+ /*
+ Executes CLOSE command
+
+ @return boolean True on success, False on error
+ @access public
+ @since 0.5
+ */
+ public function imap_close() {
+ $result = $this->__execute('CLOSE', NULL, self::COMMAND_NORESPONSE);
+
+ if ($result == self::ERROR_OK) {
+ $this->selected = '';
+ return true;
+ }
+
+ return false;
+ }
+
+ /*
+ Connect to IMAP
+
+ @param $host string Server address to connect to.
+ @param $user string Username
+ @param $password string Password
+ @param $options array Array of additional options
+
+ @return boolean True on success, False on error
+ @access public
+ */
+
+ public function imap_connect($host, $user, $password, $options=null) {
+ // set options
+ if (is_array($options)) {
+ foreach ($options as $option => $value) {
+ # TODO: Check configuration options
+ $this->$option = $value;
+ }
+ }
+
+ $result = false;
+
+ // initialize connection
+ $this->error = '';
+ $this->errornum = self::ERROR_OK;
+ $this->selected = '';
+ $this->user = $user;
+ $this->host = $host;
+ $this->logged = false;
+
+ // check input
+ if (empty($host)) {
+ $this->__set_error(self::ERROR_BAD, "Empty host");
+ return false;
+ }
+
+ if (empty($user)) {
+ $this->__set_error(self::ERROR_NO, "Empty user");
+ return false;
+ }
+
+ if (empty($password)) {
+ $this->__set_error(self::ERROR_NO, "Empty password");
+ return false;
+ }
+
+ // Check for SSL
+ if ($this->ssl_mode && $this->ssl_mode != 'tls') {
+ $host = $this->ssl_mode . '://' . $host;
+ }
+
+ if ($this->timeout <= 0) {
+ $this->timeout = ini_get('default_socket_timeout');
+ }
+
+ // Connect
+ $this->fp = @fsockopen(
+ $host,
+ $this->port,
+ $errno,
+ $errstr,
+ $this->timeout
+ );
+
+ if (!$this->fp) {
+ $this->__set_error(self::ERROR_BAD, sprintf(
+ "Could not connect to %s:%d: %s",
+ $host,
+ $this->port,
+ $errstr
+ )
+ );
+
+ return false;
+ }
+
+ if ($this->timeout > 0) {
+ stream_set_timeout($this->fp, $this->timeout);
+ }
+
+ $line = trim(fgets($this->fp, 8192));
+
+ if ($this->_debug && $line) {
+ $this->debug('S: '. $line);
+ }
+
+ // Connected to wrong port or connection error?
+ if (!preg_match('/^\* (OK|PREAUTH)/i', $line)) {
+ if ($line) {
+ $error = sprintf(
+ "Wrong startup greeting (%s:%d): %s",
+ $host,
+ $this->port,
+ $line
+ );
+ } else {
+ $error = sprintf(
+ "Empty startup greeting (%s:%d)",
+ $host,
+ $this->port
+ );
+ }
+
+ $this->__set_error(self::ERROR_BAD, $error);
+ $this->imap_disconnect();
+ return false;
+ }
+
+ // RFC3501 [7.1] optional CAPABILITY response
+ if (preg_match('/\[CAPABILITY ([^]]+)\]/i', $line, $matches)) {
+ $this->_parse_capability($matches[1], true);
+ }
+
+ // TLS connection
+ if (
+ $this->ssl_mode == 'tls' &&
+ $this->_get_capability('STARTTLS')
+ ) {
+
+ if (version_compare(PHP_VERSION, '5.1.0', '>=')) {
+ $res = $this->__execute('STARTTLS');
+
+ if ($res[0] != self::ERROR_OK) {
+ $this->imap_disconnect();
+ return false;
+ }
+
+ if (!stream_socket_enable_crypto(
+ $this->fp,
+ true,
+ STREAM_CRYPTO_METHOD_TLS_CLIENT
+ )
+ ) {
+ $this->__set_error(
+ self::ERROR_BAD,
+ "Unable to negotiate TLS"
+ );
+
+ $this->imap_disconnect();
+ return false;
+ }
+
+ // Now we're secure, capabilities need to be reread
+ $this->_clear_capability();
+ } # TODO: Bail out with a proper error message?
+ }
+
+ // Send ID info
+ if (!empty($this->ident) && $this->_get_capability('ID')) {
+ $this->imap_id($this->ident);
+ }
+
+ $auth_methods = array();
+ $result = null;
+
+ // check for supported auth methods
+ if ($this->auth_method == 'CHECK') {
+ $this->debug("D: Checking for authentication methods");
+ if ($auth_caps = $this->_get_capability('AUTH')) {
+ $auth_methods = $auth_caps;
+ }
+
+ // RFC 2595 (LOGINDISABLED) LOGIN disabled when connection is
+ // not secured by a transport security layer such as TLS or SSL.
+ $login_disabled = $this->_get_capability('LOGINDISABLED');
+ if (($key = array_search('LOGIN', $auth_methods)) !== false) {
+ if ($login_disabled) {
+ unset($auth_methods[$key]);
+ }
+ } elseif (!$login_disabled) {
+ $auth_methods[] = 'LOGIN';
+ }
+
+ // Use best (for security) supported authentication method
+ foreach (Array(
+ 'DIGEST-MD5',
+ 'CRAM-MD5',
+ 'CRAM_MD5',
+ 'PLAIN',
+ 'LOGIN'
+ ) as $this->auth_method) {
+
+ if (in_array($this->auth_method, $auth_methods)) {
+ break;
+ }
+ }
+ } else {
+ // Prevent from sending credentials in plain text when
+ // connection is not secure
+ if (
+ $this->auth_method == 'LOGIN' &&
+ $this->_get_capability('LOGINDISABLED')
+ ) {
+
+ $this->__set_error(
+ self::ERROR_BAD,
+ "Login disabled by IMAP server"
+ );
+
+ $this->imap_disconnect();
+ return false;
+ }
+
+ // replace AUTH with CRAM-MD5 for backward compat.
+ if ($this->auth_method == 'AUTH') {
+ $this->auth_method = 'CRAM-MD5';
+ }
+ }
+
+ // pre-login capabilities can be not complete
+ $this->capability_read = false;
+
+ // Authenticate
+ switch ($this->auth_method) {
+ case 'CRAM_MD5':
+ $this->auth_method = 'CRAM-MD5';
+ case 'CRAM-MD5':
+ case 'DIGEST-MD5':
+ case 'PLAIN':
+ $result = $this->authenticate(
+ $user,
+ $password,
+ $this->auth_method
+ );
+
+ break;
+ case 'LOGIN':
+ $result = $this->login($user, $password);
+ break;
+ default:
+ $this->__set_error(
+ self::ERROR_BAD,
+ "Configuration error. Unknown auth method: " .
+ $this->auth_method
+ );
+ }
+
+ // Connected and authenticated
+ if (is_resource($result)) {
+ if ($this->force_caps) {
+ $this->_clear_capability();
+ }
+
+ $this->logged = true;
+ return true;
+ }
+
+ $this->imap_disconnect();
+
+ return false;
+ }
+
+ public function imap_copy($messages, $from, $to) {
+ if (!$this->imap_select($from)) {
+ return false;
+ }
+
+ // Clear internal status cache
+ unset($this->data['STATUS:'.$to]);
+
+ $result = $this->__execute('UID COPY', array(
+ $this->__compress_messageset($messages), $this->_escape($to)),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ public function imap_create($mailbox) {
+ $result = $this->__execute(
+ 'CREATE',
+ Array($this->_escape($mailbox)),
+ self::COMMAND_NORESPONSE
+ );
+
+ return ($result == self::ERROR_OK);
+ }
+
+ /*
+ Executes DELETE command for mailboxes (null $messages).
+
+ Flags all messages included in $messages as \\Deleted.
+
+ @param string $mailbox Mailbox name
+ @param array $messages Messages
+
+ @return boolean True on success, False on error
+ @access public
+ */
+ public function imap_delete($mailbox, $messages=null) {
+ if ($messages == null) {
+ $result = $this->__execute(
+ 'DELETE',
+ Array($this->_escape($mailbox)),
+ self::COMMAND_NORESPONSE
+ );
+
+ return ($result == self::ERROR_OK);
+
+ } else {
+ return $this->__store_flag($mailbox, $messages, 'DELETED', '+');
+ }
+ }
+
+ /*
+ Send the DELETEACL command (RFC4314)
+
+ @param string $mailbox Mailbox name
+ @param string $user User name
+
+ @return boolean True on success, False on failure
+
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_deleteacl($mailbox, $user) {
+ $result = $this->__execute('DELETEACL', array(
+ $this->_escape($mailbox), $this->_escape($user)),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ /*
+ Logs out and closes the connection.
+ */
+
+ public function imap_disconnect() {
+ if ($this->__put_line($this->__next_tag() . ' LOGOUT')) {
+ $this->__read_reply();
+ }
+
+ $this->__close_socket();
+ }
+
+ /*
+ Executes ENABLE command (RFC5161)
+
+ @param mixed $extension Extension name to enable (or array of names)
+
+ @return array|bool List of enabled extensions, False on error
+ @since 0.6
+ */
+ public function imap_enable($extension) {
+ if (empty($extension))
+ return false;
+
+ if (!$this->hasCapability('ENABLE'))
+ return false;
+
+ if (!is_array($extension))
+ $extension = array($extension);
+
+ list($code, $response) = $this->execute('ENABLE', $extension);
+
+ if ($code == self::ERROR_OK && preg_match('/\* ENABLED /i', $response)) {
+ $response = substr($response, 10); // remove prefix "* ENABLED "
+ $result = (array) $this->__tokenize_response($response);
+
+ return $result;
+ }
+
+ return false;
+ }
+
+ /*
+ Executes EXPUNGE command
+
+ @param string $mailbox Mailbox name
+ @param string $messages Message UIDs to expunge
+
+ @return boolean True on success, False on error
+ @access public
+ */
+ public function imap_expunge($mailbox, $messages=NULL) {
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ if (!$this->data['READ-WRITE']) {
+ $this->__set_error(self::ERROR_READONLY, "Mailbox is read-only", 'EXPUNGE');
+ return false;
+ }
+
+ // Clear internal status cache
+ unset($this->data['STATUS:'.$mailbox]);
+
+ if ($messages)
+ $result = $this->__execute('UID EXPUNGE', array($messages), self::COMMAND_NORESPONSE);
+ else
+ $result = $this->__execute('EXPUNGE', null, self::COMMAND_NORESPONSE);
+
+ if ($result == self::ERROR_OK) {
+ $this->selected = ''; // state has changed, need to reselect
+ return true;
+ }
+
+ return false;
+ }
+
+ /*
+ FETCH command (RFC3501)
+
+ @param string $mailbox Mailbox name
+ @param mixed $message_set Message(s) sequence identifier(s) or UID(s)
+ @param bool $is_uid True if $message_set contains UIDs
+ @param array $query_items FETCH command data items
+ @param string $mod_seq Modification sequence for CHANGEDSINCE (RFC4551) query
+ @param bool $vanished Enables VANISHED parameter (RFC5162) for CHANGEDSINCE query
+
+ @return array List of rcube_mail_header elements, False on error
+ @since 0.6
+ */
+ public function imap_fetch(
+ $mailbox,
+ $message_set,
+ $is_uid = false,
+ $query_items = array(),
+ $mod_seq = null,
+ $vanished = false
+ ) {
+
+ if (!$this->select($mailbox)) {
+ return false;
+ }
+
+ $message_set = $this->__compress_messageset($message_set);
+ $result = array();
+
+ $key = $this->__next_tag();
+ $request = $key . ($is_uid ? ' UID' : '') . " FETCH $message_set ";
+ $request .= "(" . implode(' ', $query_items) . ")";
+
+ if ($mod_seq !== null && $this->_has_capability('CONDSTORE')) {
+ $request .= " (CHANGEDSINCE $mod_seq" . ($vanished ? " VANISHED" : '') .")";
+ }
+
+ if (!$this->__put_line($request)) {
+ $this->setError(self::ERROR_COMMAND, "Unable to send command: $request");
+ return false;
+ }
+
+ do {
+ $line = $this->__read_line(4096);
+
+ if (!$line)
+ break;
+
+ // Sample reply line:
+ // * 321 FETCH (UID 2417 RFC822.SIZE 2730 FLAGS (\Seen)
+ // INTERNALDATE "16-Nov-2008 21:08:46 +0100" BODYSTRUCTURE (...)
+ // BODY[HEADER.FIELDS ...
+
+ if (preg_match('/^\* ([0-9]+) FETCH/', $line, $m)) {
+ $id = intval($m[1]);
+
+ $result[$id] = new Net_IMAP4_MessageHeader;
+ $result[$id]->id = $id;
+ $result[$id]->subject = '';
+ $result[$id]->messageID = 'mid:' . $id;
+
+ $lines = array();
+ $line = substr($line, strlen($m[0]) + 2);
+ $ln = 0;
+
+ // get complete entry
+ while (preg_match('/\{([0-9]+)\}\r\n$/', $line, $m)) {
+ $bytes = $m[1];
+ $out = '';
+
+ while (strlen($out) < $bytes) {
+ $out = $this->__read_bytes($bytes);
+ if ($out === NULL)
+ break;
+ $line .= $out;
+ }
+
+ $str = $this->__read_line(4096);
+ if ($str === false)
+ break;
+
+ $line .= $str;
+ }
+
+ // Tokenize response and assign to object properties
+ while (list($name, $value) = $this->__tokenize_response($line, 2)) {
+ if ($name == 'UID') {
+ $result[$id]->uid = intval($value);
+ }
+ else if ($name == 'RFC822.SIZE') {
+ $result[$id]->size = intval($value);
+ }
+ else if ($name == 'RFC822.TEXT') {
+ $result[$id]->body = $value;
+ }
+ else if ($name == 'INTERNALDATE') {
+ $result[$id]->internaldate = $value;
+ $result[$id]->date = $value;
+ $result[$id]->timestamp = $this->str_to_time($value);
+ }
+ else if ($name == 'FLAGS') {
+ if (!empty($value)) {
+ foreach ((array)$value as $flag) {
+ $flag = str_replace(array('$', '\\'), '', $flag);
+ $flag = strtoupper($flag);
+
+ $result[$id]->flags[$flag] = true;
+ }
+ }
+ }
+ else if ($name == 'MODSEQ') {
+ $result[$id]->modseq = $value[0];
+ }
+ else if ($name == 'ENVELOPE') {
+ $result[$id]->envelope = $value;
+ }
+ else if ($name == 'BODYSTRUCTURE' || ($name == 'BODY' && count($value) > 2)) {
+ if (!is_array($value[0]) && (strtolower($value[0]) == 'message' && strtolower($value[1]) == 'rfc822')) {
+ $value = array($value);
+ }
+ $result[$id]->bodystructure = $value;
+ }
+ else if ($name == 'RFC822') {
+ $result[$id]->body = $value;
+ }
+ else if ($name == 'BODY') {
+ $body = $this->__tokenize_response($line, 1);
+ if ($value[0] == 'HEADER.FIELDS')
+ $headers = $body;
+ else if (!empty($value))
+ $result[$id]->bodypart[$value[0]] = $body;
+ else
+ $result[$id]->body = $body;
+ }
+ }
+
+ // create array with header field:data
+ if (!empty($headers)) {
+ $headers = explode("\n", trim($headers));
+ foreach ($headers as $hid => $resln) {
+ if (ord($resln[0]) <= 32) {
+ $lines[$ln] .= (empty($lines[$ln]) ? '' : "\n") . trim($resln);
+ } else {
+ $lines[++$ln] = trim($resln);
+ }
+ }
+
+ while (list($lines_key, $str) = each($lines)) {
+ list($field, $string) = explode(':', $str, 2);
+
+ $field = strtolower($field);
+ $string = preg_replace('/\n[\t\s]*/', ' ', trim($string));
+
+ switch ($field) {
+ case 'date';
+ $result[$id]->date = $string;
+ $result[$id]->timestamp = $this->str_to_time($string);
+ break;
+ case 'from':
+ $result[$id]->from = $string;
+ break;
+ case 'to':
+ $result[$id]->to = preg_replace('/undisclosed-recipients:[;,]*/', '', $string);
+ break;
+ case 'subject':
+ $result[$id]->subject = $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;
+ case 'content-type':
+ $ctype_parts = preg_split('/[; ]/', $string);
+ $result[$id]->ctype = strtolower(array_shift($ctype_parts));
+ if (preg_match('/charset\s*=\s*"?([a-z0-9\-\.\_]+)"?/i', $string, $regs)) {
+ $result[$id]->charset = $regs[1];
+ }
+ break;
+ 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':
+ $result[$id]->mdn_to = $string;
+ break;
+ case 'message-id':
+ $result[$id]->messageID = $string;
+ break;
+ case 'x-priority':
+ if (preg_match('/^(\d+)/', $string, $matches)) {
+ $result[$id]->priority = intval($matches[1]);
+ }
+ break;
+ default:
+ if (strlen($field) > 2) {
+ $result[$id]->others[$field] = $string;
+ }
+ break;
+ }
+ }
+ }
+ }
+
+ // VANISHED response (QRESYNC RFC5162)
+ // Sample: * VANISHED (EARLIER) 300:310,405,411
+
+ else if (preg_match('/^\* VANISHED [()EARLIER]*/i', $line, $match)) {
+ $line = substr($line, strlen($match[0]));
+ $v_data = $this->__tokenize_response($line, 1);
+
+ $this->data['VANISHED'] = $v_data;
+ }
+
+ } while (!$this->__starts_with($line, $key, true));
+
+ return $result;
+ }
+
+ public function imap_flag($mailbox, $messages, $flag) {
+ return $this->__store_flag($mailbox, $messages, $flag, '+');
+ }
+
+ /*
+ Send the GETACL command (RFC4314)
+
+ @param string $mailbox Mailbox name
+
+ @return array User-rights array on success, NULL on error
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_getacl($mailbox) {
+ list($code, $response) = $this->__execute(
+ 'GETACL',
+ Array($this->_escape($mailbox))
+ );
+
+ if (
+ $code == self::ERROR_OK &&
+ preg_match('/^\* ACL /i', $response)
+ ) {
+
+ // Parse server response (remove "* ACL ")
+ $response = substr($response, 6);
+ $ret = $this->__tokenize_response($response);
+ $mbox = array_shift($ret);
+ $size = count($ret);
+
+ // Create user-rights hash array
+ // @TODO: Consider implementing fixACL() method according to
+ // RFC4314.2.1.1 so we could return only standard rights
+ // defined in RFC4314, excluding 'c' and 'd' defined in RFC2086.
+ if ($size % 2 == 0) {
+ for ($i=0; $i<$size; $i++) {
+ $ret[$ret[$i]] = str_split($ret[++$i]);
+ unset($ret[$i-1]);
+ unset($ret[$i]);
+ }
+ return $ret;
+ }
+
+ $this->__set_error(
+ self::ERROR_COMMAND,
+ "Incomplete ACL response"
+ );
+
+ return NULL;
+ }
+
+ return NULL;
+ }
+
+ /*
+ Send the GETANNOTATION command (draft-daboo-imap-annotatemore)
+
+ @param string $mailbox Mailbox name
+ @param array $entries Entries names
+ @param array $attribs Attribs names
+
+ @return array Annotations result on success, NULL on error
+
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_getannotation($mailbox, $entries, $attribs) {
+ if (!is_array($entries)) {
+ $entries = array($entries);
+ }
+ // create entries string
+ // ANNOTATEMORE drafts before version 08 require quoted parameters
+ foreach ($entries as $idx => $name) {
+ $entries[$idx] = $this->_escape($name, true);
+ }
+ $entries = '(' . implode(' ', $entries) . ')';
+
+ if (!is_array($attribs)) {
+ $attribs = array($attribs);
+ }
+ // create entries string
+ foreach ($attribs as $idx => $name) {
+ $attribs[$idx] = $this->_escape($name, true);
+ }
+ $attribs = '(' . implode(' ', $attribs) . ')';
+
+ list($code, $response) = $this->__execute('GETANNOTATION', array(
+ $this->_escape($mailbox), $entries, $attribs));
+
+ if ($code == self::ERROR_OK) {
+ $result = array();
+ $data = $this->__tokenize_response($response);
+
+ // Here we returns only data compatible with METADATA result
+ // format
+ if (!empty($data) && ($size = count($data))) {
+ for ($i=0; $i<$size; $i++) {
+ $entry = $data[$i];
+ if (isset($mbox) && is_array($entry)) {
+ $attribs = $entry;
+ $entry = $last_entry;
+ }
+ else if ($entry == '*') {
+ if ($data[$i+1] == 'ANNOTATION') {
+ $mbox = $data[$i+2];
+ unset($data[$i]); // "*"
+ unset($data[++$i]); // "ANNOTATION"
+ unset($data[++$i]); // Mailbox
+ }
+ // get rid of other untagged responses
+ else {
+ unset($mbox);
+ unset($data[$i]);
+ }
+ continue;
+ }
+ else if (isset($mbox)) {
+ $attribs = $data[$i++];
+ }
+ else {
+ unset($data[$i]);
+ continue;
+ }
+
+ if (!empty($attribs)) {
+ for ($x=0, $len=count($attribs); $x<$len;) {
+ $attr = $attribs[$x++];
+ $value = $attribs[$x++];
+ if ($attr == 'value.priv') {
+ $result[$mbox]['/private'.$entry] = $value;
+ }
+ else if ($attr == 'value.shared') {
+ $result[$mbox]['/shared'.$entry] = $value;
+ }
+ }
+ }
+ $last_entry = $entry;
+ unset($data[$i]);
+ }
+ }
+
+ return $result;
+ }
+
+ return NULL;
+ }
+
+ /*
+ Send the GETMETADATA command (RFC5464)
+
+ @param string $mailbox Mailbox name
+ @param array $entries Entries
+ @param array $options Command options (with MAXSIZE and DEPTH keys)
+
+ @return array GETMETADATA result on success, NULL on error
+
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_getmetadata($mailbox, $entries, $options=array()) {
+ if (!is_array($entries)) {
+ $entries = array($entries);
+ }
+
+ // create entries string
+ foreach ($entries as $idx => $name) {
+ $entries[$idx] = $this->_escape($name);
+ }
+
+ $optlist = '';
+ $entlist = '(' . implode(' ', $entries) . ')';
+
+ // create options string
+ if (is_array($options)) {
+ $options = array_change_key_case($options, CASE_UPPER);
+ $opts = array();
+
+ if (!empty($options['MAXSIZE'])) {
+ $opts[] = 'MAXSIZE '.intval($options['MAXSIZE']);
+ }
+ if (!empty($options['DEPTH'])) {
+ $opts[] = 'DEPTH '.intval($options['DEPTH']);
+ }
+
+ if ($opts) {
+ $optlist = '(' . implode(' ', $opts) . ')';
+ }
+ }
+
+ $optlist .= ($optlist ? ' ' : '') . $entlist;
+
+ list($code, $response) = $this->__execute('GETMETADATA', array(
+ $this->_escape($mailbox), $optlist));
+
+ if ($code == self::ERROR_OK) {
+ $result = array();
+ $data = $this->__tokenize_response($response);
+
+ // The METADATA response can contain multiple entries in a
+ // single response or multiple responses for each entry or
+ // group of entries.
+ if (!empty($data) && ($size = count($data))) {
+ for ($i=0; $i<$size; $i++) {
+ if (isset($mbox) && is_array($data[$i])) {
+ $size_sub = count($data[$i]);
+ for ($x=0; $x<$size_sub; $x++) {
+ $result[$mbox][$data[$i][$x]] = $data[$i][++$x];
+ }
+ unset($data[$i]);
+ }
+ else if ($data[$i] == '*') {
+ if ($data[$i+1] == 'METADATA') {
+ $mbox = $data[$i+2];
+ unset($data[$i]); // "*"
+ unset($data[++$i]); // "METADATA"
+ unset($data[++$i]); // Mailbox
+ }
+ // get rid of other untagged responses
+ else {
+ unset($mbox);
+ unset($data[$i]);
+ }
+ }
+ else if (isset($mbox)) {
+ $result[$mbox][$data[$i]] = $data[++$i];
+ unset($data[$i]);
+ unset($data[$i-1]);
+ }
+ else {
+ unset($data[$i]);
+ }
+ }
+ }
+
+ return $result;
+ }
+
+ return NULL;
+ }
+
+ public function imap_getquotaroot($mailbox="INBOX") {
+ /*
+ * GETQUOTAROOT "INBOX"
+ * QUOTAROOT INBOX user/rchijiiwa1
+ * QUOTA user/rchijiiwa1 (STORAGE 654 9765)
+ * OK Completed
+ */
+ $result = false;
+ $quota_lines = array();
+ $key = $this->__next_tag();
+ $command = $key . ' GETQUOTAROOT INBOX';
+
+ // get line(s) containing quota info
+ if ($this->__put_line($command)) {
+ do {
+ $line = rtrim($this->__read_line(5000));
+ if (preg_match('/^\* QUOTA /', $line)) {
+ $quota_lines[] = $line;
+ }
+ } while (!$this->__starts_with($line, $key, true, true));
+ }
+ else {
+ $this->__set_error(self::ERROR_COMMAND, "Unable to send command: $command");
+ }
+
+ // return false if not found, parse if found
+ $min_free = PHP_INT_MAX;
+ foreach ($quota_lines as $key => $quota_line) {
+ $quota_line = str_replace(array('(', ')'), '', $quota_line);
+ $parts = explode(' ', $quota_line);
+ $storage_part = array_search('STORAGE', $parts);
+
+ if (!$storage_part) {
+ continue;
+ }
+
+ $used = intval($parts[$storage_part+1]);
+ $total = intval($parts[$storage_part+2]);
+ $free = $total - $used;
+
+ // return lowest available space from all quotas
+ if ($free < $min_free) {
+ $min_free = $free;
+ $result['used'] = $used;
+ $result['total'] = $total;
+ $result['percent'] = min(100, round(($used/max(1,$total))*100));
+ $result['free'] = 100 - $result['percent'];
+ }
+ }
+
+ return $result;
+ }
+
+ /*
+ Executes ID command (RFC2971)
+
+ @param array $items Client identification information key/value hash
+
+ @return array Server identification information key/value hash
+ @access public
+ @since 0.6
+ */
+ private function imap_id($items=array()) {
+ if (is_array($items) && !empty($items)) {
+ foreach ($items as $key => $value) {
+ $args[] = $this->_escape($key, true);
+ $args[] = $this->_escape($value, true);
+ }
+ }
+
+ list($code, $response) = $this->__execute('ID', array(
+ !empty($args) ? '(' . implode(' ', (array) $args) . ')' : $this->_escape(null)
+ ));
+
+
+ if ($code == self::ERROR_OK && preg_match('/\* ID /i', $response)) {
+ $response = substr($response, 5); // remove prefix "* ID "
+ $items = $this->__tokenize_response($response, 1);
+ $result = null;
+
+ for ($i=0, $len=count($items); $i<$len; $i += 2) {
+ $result[$items[$i]] = $items[$i+1];
+ }
+
+ return $result;
+ }
+
+ return false;
+ }
+
+ /*
+ Returns list of mailboxes
+
+ @param string $ref Reference name
+ @param string $mailbox Mailbox name
+ @param array $status_opts (see self::__list)
+ @param array $select_opts (see self::__list)
+
+ @return array List of mailboxes or hash of options if $status_opts argument
+ is non-empty.
+ @access public
+ */
+ public function imap_list($ref="", $mailbox="*", $status_opts=array(), $select_opts=array()) {
+ return $this->__list($ref, $mailbox, false, $status_opts, $select_opts);
+ }
+
+ /*
+ Send the LISTRIGHTS command (RFC4314)
+
+ @param string $mailbox Mailbox name
+ @param string $user User name
+
+ @return array List of user rights
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_listrights($mailbox, $user) {
+ list($code, $response) = $this->__execute('LISTRIGHTS', array(
+ $this->_escape($mailbox), $this->_escape($user)));
+
+ if ($code == self::ERROR_OK && preg_match('/^\* LISTRIGHTS /i', $response)) {
+ // Parse server response (remove "* LISTRIGHTS ")
+ $response = substr($response, 13);
+
+ $ret_mbox = $this->__tokenize_response($response, 1);
+ $ret_user = $this->__tokenize_response($response, 1);
+ $granted = $this->__tokenize_response($response, 1);
+ $optional = trim($response);
+
+ return array(
+ 'granted' => str_split($granted),
+ 'optional' => explode(' ', $optional),
+ );
+ }
+
+ return NULL;
+ }
+
+ /*
+ Returns list of subscribed mailboxes
+
+ @param string $ref Reference name
+ @param string $mailbox Mailbox name
+ @param array $status_opts (see self::__list)
+
+ @return array List of mailboxes or hash of options if $status_opts argument
+ is non-empty.
+ @access public
+ */
+ public function imap_lsub($ref="", $mailbox="*", $status_opts=array()) {
+ return $this->__list($ref, $mailbox, true, $status_opts, NULL);
+ }
+
+ public function imap_move($messages, $from, $to) {
+ if (!$this->imap_select($from)) {
+ return false;
+ }
+
+ if (!$this->data['READ-WRITE']) {
+ $this->__set_error(self::ERROR_READONLY, "Mailbox is read-only", 'STORE');
+ return false;
+ }
+
+ $r = $this->copy($messages, $from, $to);
+
+ if ($r) {
+ // Clear internal status cache
+ unset($this->data['STATUS:'.$from]);
+
+ return $this->delete($from, $messages);
+ }
+ return $r;
+ }
+
+ /*
+ Send the MYRIGHTS command (RFC4314)
+
+ @param string $mailbox Mailbox name
+
+ @return array MYRIGHTS response on success, NULL on error
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_myrights($mailbox) {
+ list($code, $response) = $this->__execute('MYRIGHTS', array($this->_escape($mailbox)));
+
+ if ($code == self::ERROR_OK && preg_match('/^\* MYRIGHTS /i', $response)) {
+ // Parse server response (remove "* MYRIGHTS ")
+ $response = substr($response, 11);
+
+ $ret_mbox = $this->__tokenize_response($response, 1);
+ $rights = $this->__tokenize_response($response, 1);
+
+ return str_split($rights);
+ }
+
+ return NULL;
+ }
+
+ public function imap_rename($from, $to) {
+ $result = $this->__execute('RENAME', array($this->_escape($from), $this->_escape($to)),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ /*
+ Executes SEARCH command
+
+ @param string $mailbox Mailbox name
+ @param string $criteria Searching criteria
+ @param bool $return_uid Enable UID in result instead of sequence ID
+ @param array $items Return items (MIN, MAX, COUNT, ALL)
+
+ @return array Message identifiers or item-value hash
+ */
+ public function imap_search($mailbox, $criteria, $return_uid=false, $items=array()) {
+ $old_sel = $this->selected;
+
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ // return empty result when folder is empty and we're just after SELECT
+ if ($old_sel != $mailbox && !$this->data['EXISTS']) {
+ if (!empty($items))
+ return array_combine($items, array_fill(0, count($items), 0));
+ else
+ return array();
+ }
+
+ $esearch = empty($items) ? false : $this->_get_capability('ESEARCH');
+ $criteria = trim($criteria);
+ $params = '';
+
+ // RFC4731: ESEARCH
+ if (!empty($items) && $esearch) {
+ $params .= 'RETURN (' . implode(' ', $items) . ')';
+ }
+ if (!empty($criteria)) {
+ $params .= ($params ? ' ' : '') . $criteria;
+ }
+ else {
+ $params .= 'ALL';
+ }
+
+ list($code, $response) = $this->__execute($return_uid ? 'UID SEARCH' : 'SEARCH',
+ array($params));
+
+ if ($code == self::ERROR_OK) {
+ // remove prefix...
+ $response = substr($response, stripos($response,
+ $esearch ? '* ESEARCH' : '* SEARCH') + ($esearch ? 10 : 9));
+ // ...and unilateral untagged server responses
+ if ($pos = strpos($response, '*')) {
+ $response = rtrim(substr($response, 0, $pos));
+ }
+
+ if ($esearch) {
+ // Skip prefix: ... (TAG "A285") UID ...
+ $this->__tokenize_response($response, $return_uid ? 2 : 1);
+
+ $result = array();
+ for ($i=0; $i<count($items); $i++) {
+ // If the SEARCH results in no matches, the server MUST NOT
+ // include the item result option in the ESEARCH response
+ if ($ret = $this->__tokenize_response($response, 2)) {
+ list ($name, $value) = $ret;
+ $result[$name] = $value;
+ }
+ }
+
+ return $result;
+ }
+ else {
+ $response = preg_split('/[\s\r\n]+/', $response, -1, PREG_SPLIT_NO_EMPTY);
+
+ if (!empty($items)) {
+ $result = array();
+ if (in_array('COUNT', $items)) {
+ $result['COUNT'] = count($response);
+ }
+ if (in_array('MIN', $items)) {
+ $result['MIN'] = !empty($response) ? min($response) : 0;
+ }
+ if (in_array('MAX', $items)) {
+ $result['MAX'] = !empty($response) ? max($response) : 0;
+ }
+ if (in_array('ALL', $items)) {
+ $result['ALL'] = $this->__compress_messageset($response, true);
+ }
+
+ return $result;
+ }
+ else {
+ return $response;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /*
+ Executes SELECT command (if mailbox is already not in selected state)
+
+ @param string $mailbox Mailbox name
+
+ @return boolean True on success, false on error
+ @access public
+ */
+ public function imap_select($mailbox) {
+ if (!strlen($mailbox)) {
+ return false;
+ }
+
+ if ($this->selected == $mailbox) {
+ return true;
+ }
+
+ /*
+ // Temporary commented out because Courier returns \Noselect for INBOX
+ // Requires more investigation
+
+ if (is_array($this->data['LIST']) && is_array($opts = $this->data['LIST'][$mailbox])) {
+ if (in_array('\\Noselect', $opts)) {
+ return false;
+ }
+ }
+ */
+
+ list($code, $response) = $this->__execute('SELECT', array($this->_escape($mailbox)));
+
+ if ($code == self::ERROR_OK) {
+ $response = explode("\r\n", $response);
+ foreach ($response as $line) {
+ if (preg_match('/^\* ([0-9]+) (EXISTS|RECENT)$/i', $line, $m)) {
+ $this->data[strtoupper($m[2])] = (int) $m[1];
+ }
+ else if (preg_match('/^\* OK \[(UIDNEXT|UIDVALIDITY|UNSEEN) ([0-9]+)\]/i', $line, $match)) {
+ $this->data[strtoupper($match[1])] = (int) $match[2];
+ }
+ else if (preg_match('/^\* OK \[PERMANENTFLAGS \(([^\)]+)\)\]/iU', $line, $match)) {
+ $this->data['PERMANENTFLAGS'] = explode(' ', $match[1]);
+ }
+ }
+
+ $this->data['READ-WRITE'] = $this->resultcode != 'READ-ONLY';
+
+ $this->selected = $mailbox;
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /*
+ Send the SETACL command (RFC4314)
+
+ @param string $mailbox Mailbox name
+ @param string $user User name
+ @param mixed $acl ACL string or array
+
+ @return boolean True on success, False on failure
+
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_setacl($mailbox, $user, $acl) {
+ if (is_array($acl)) {
+ $acl = implode('', $acl);
+ }
+
+ $result = $this->__execute('SETACL', array(
+ $this->_escape($mailbox), $this->_escape($user), strtolower($acl)),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ /*
+ Send the SETANNOTATION command (draft-daboo-imap-annotatemore)
+
+ @param string $mailbox Mailbox name
+ @param array $data Data array where each item is an array with
+ three elements: entry name, attribute name, value
+
+ @return boolean True on success, False on failure
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_setannotation($mailbox, $data) {
+ if (!is_array($data) || empty($data)) {
+ $this->__set_error(self::ERROR_COMMAND, "Wrong argument for SETANNOTATION command");
+ return false;
+ }
+
+ foreach ($data as $entry) {
+ // ANNOTATEMORE drafts before version 08 require quoted parameters
+ $entries[] = sprintf('%s (%s %s)', $this->_escape($entry[0], true),
+ $this->_escape($entry[1], true), $this->_escape($entry[2], true));
+ }
+
+ $entries = implode(' ', $entries);
+ $result = $this->__execute('SETANNOTATION', array(
+ $this->_escape($mailbox), $entries), self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ /*
+ Send the SETMETADATA command (RFC5464)
+
+ @param string $mailbox Mailbox name
+ @param array $entries Entry-value array (use NULL value as NIL)
+
+ @return boolean True on success, False on failure
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_setmetadata($mailbox, $entries) {
+ if (!is_array($entries) || empty($entries)) {
+ $this->__set_error(self::ERROR_COMMAND, "Wrong argument for SETMETADATA command");
+ return false;
+ }
+
+ foreach ($entries as $name => $value) {
+ $entries[$name] = $this->_escape($name) . ' ' . $this->_escape($value);
+ }
+
+ $entries = implode(' ', $entries);
+ $result = $this->__execute('SETMETADATA', array(
+ $this->_escape($mailbox), '(' . $entries . ')'),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ public function imap_sort($mailbox, $field, $add='', $is_uid=FALSE, $encoding = 'US-ASCII') {
+ $field = strtoupper($field);
+ if ($field == 'INTERNALDATE') {
+ $field = 'ARRIVAL';
+ }
+
+ $fields = Array(
+ 'ARRIVAL' => 1,
+ 'CC' => 1,
+ 'DATE' => 1,
+ 'FROM' => 1,
+ 'SIZE' => 1,
+ 'SUBJECT' => 1,
+ 'TO' => 1
+ );
+
+ if (!$fields[$field]) {
+ return false;
+ }
+
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ // Message IDs
+ if (!empty($add))
+ $add = $this->__compress_messageset($add);
+
+ list($code, $response) = $this->__execute(
+ $is_uid ? 'UID SORT' : 'SORT',
+ Array(
+ "($field)",
+ $encoding,
+ 'ALL' . (!empty($add) ? ' '.$add : '')
+ )
+ );
+
+ if ($code == self::ERROR_OK) {
+ // remove prefix and unilateral untagged server responses
+ $response = substr($response, stripos($response, '* SORT') + 7);
+ if ($pos = strpos($response, '*')) {
+ $response = substr($response, 0, $pos);
+ }
+ return preg_split('/[\s\r\n]+/', $response, -1, PREG_SPLIT_NO_EMPTY);
+ }
+
+ return false;
+ }
+
+ /*
+ Executes STATUS command
+
+ @param string $mailbox Mailbox name
+ @param array $items Additional requested item names. By default
+ MESSAGES and UNSEEN are requested. Other defined
+ in RFC3501: UIDNEXT, UIDVALIDITY, RECENT
+
+ @return array Status item-value hash
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_status($mailbox, $items=array()) {
+ if (!strlen($mailbox)) {
+ return false;
+ }
+
+ if (!in_array('MESSAGES', $items)) {
+ $items[] = 'MESSAGES';
+ }
+ if (!in_array('UNSEEN', $items)) {
+ $items[] = 'UNSEEN';
+ }
+
+ list($code, $response) = $this->__execute('STATUS', array($this->_escape($mailbox),
+ '(' . implode(' ', (array) $items) . ')'));
+
+ if ($code == self::ERROR_OK && preg_match('/\* STATUS /i', $response)) {
+ $result = array();
+ $response = substr($response, 9); // remove prefix "* STATUS "
+
+ list($mbox, $items) = $this->__tokenize_response($response, 2);
+
+ // Fix for #1487859. Some buggy server returns not quoted
+ // folder name with spaces. Let's try to handle this situation
+ if (!is_array($items) && ($pos = strpos($response, '(')) !== false) {
+ $response = substr($response, $pos);
+ $items = $this->__tokenize_response($response, 1);
+ if (!is_array($items)) {
+ return $result;
+ }
+ }
+
+ for ($i=0, $len=count($items); $i<$len; $i += 2) {
+ $result[$items[$i]] = (int) $items[$i+1];
+ }
+
+ $this->data['STATUS:'.$mailbox] = $result;
+
+ return $result;
+ }
+
+ return false;
+ }
+
+ /*
+ Executes SUBSCRIBE command
+
+ @param string $mailbox Mailbox name
+
+ @return boolean True on success, False on error
+ @access public
+ */
+ public function imap_subscribe($mailbox) {
+ $result = $this->__execute('SUBSCRIBE', array($this->_escape($mailbox)),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ public function imap_thread($mailbox, $algorithm='REFERENCES', $criteria='', $encoding='US-ASCII') {
+ $old_sel = $this->selected;
+
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ // return empty result when folder is empty and we're just after SELECT
+ if ($old_sel != $mailbox && !$this->data['EXISTS']) {
+ return array(array(), array(), array());
+ }
+
+ $encoding = $encoding ? trim($encoding) : 'US-ASCII';
+ $algorithm = $algorithm ? trim($algorithm) : 'REFERENCES';
+ $criteria = $criteria ? 'ALL '.trim($criteria) : 'ALL';
+ $data = '';
+
+ list($code, $response) = $this->__execute('THREAD', array(
+ $algorithm, $encoding, $criteria));
+
+ if ($code == self::ERROR_OK) {
+ // remove prefix...
+ $response = substr($response, stripos($response, '* THREAD') + 9);
+ // ...unilateral untagged server responses
+ if ($pos = strpos($response, '*')) {
+ $response = substr($response, 0, $pos);
+ }
+
+ $response = str_replace("\r\n", '', $response);
+ $depthmap = array();
+ $haschildren = array();
+
+ $tree = $this->_parse_thread($response, 0, strlen($response),
+ null, null, 0, $depthmap, $haschildren);
+
+ return array($tree, $depthmap, $haschildren);
+ }
+
+ return false;
+ }
+
+ /*
+ Executes UNSUBSCRIBE command
+
+ @param string $mailbox Mailbox name
+
+ @return boolean True on success, False on error
+ @access public
+ */
+ public function imap_unsubscribe($mailbox) {
+ $result = $this->__execute('UNSUBSCRIBE', array($this->_escape($mailbox)),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ public function imap_unflag($mailbox, $messages, $flag) {
+ return $this->__store_flag($mailbox, $messages, $flag, '-');
+ }
+
+################################################################################
+################################################################################
+################################################################################
+ /**
+ * Useful commands
+ */
+################################################################################
+################################################################################
+################################################################################
+
+ /*
+ Append a message from a file.
+
+ @param $mailbox string Mailbox name
+ @param $path string Path to file
+ @param $headers string Headers
+
+ @return boolean True on success, False on error
+ */
+ public function append_from_file($mailbox, $path, $headers=null) {
+ if (!$mailbox) {
+ return false;
+ }
+
+ // open message file
+ $in_fp = false;
+ if (file_exists(realpath($path))) {
+ $in_fp = fopen($path, 'r');
+ }
+ if (!$in_fp) {
+ $this->__set_error(self::ERROR_UNKNOWN, "Couldn't open $path for reading");
+ return false;
+ }
+
+ $body_separator = "\r\n\r\n";
+ $len = filesize($path);
+
+ if (!$len) {
+ return false;
+ }
+
+ if ($headers) {
+ $headers = preg_replace('/[\r\n]+$/', '', $headers);
+ $len += strlen($headers) + strlen($body_separator);
+ }
+
+ // send APPEND command
+ $key = $this->__next_tag();
+ $request = sprintf("$key APPEND %s (\\Seen) {%d%s}", $this->_escape($mailbox),
+ $len, ($this->prefs['literal+'] ? '+' : ''));
+
+ if ($this->__put_line($request)) {
+ // Don't wait when LITERAL+ is supported
+ if (!$this->prefs['literal+']) {
+ $line = $this->readReply();
+
+ if ($line[0] != '+') {
+ $this->parseResult($line, 'APPEND: ');
+ return false;
+ }
+ }
+
+ // send headers with body separator
+ if ($headers) {
+ $this->__put_line($headers . $body_separator, false);
+ }
+
+ // send file
+ while (!feof($in_fp) && $this->fp) {
+ $buffer = fgets($in_fp, 4096);
+ $this->__put_line($buffer, false);
+ }
+ fclose($in_fp);
+
+ if (!$this->__put_line('')) { // \r\n
+ return false;
+ }
+
+ // read response
+ do {
+ $line = $this->__read_line();
+ } while (!$this->__starts_with($line, $key, true, true));
+
+ // Clear internal status cache
+ unset($this->data['STATUS:'.$mailbox]);
+
+ return ($this->parseResult($line, 'APPEND: ') == self::ERROR_OK);
+ }
+ else {
+ $this->__set_error(self::ERROR_COMMAND, "Unable to send command: $request");
+ }
+
+ return false;
+ }
+
+ /*
+ Removes all messages in a folder
+
+ @param string $mailbox Mailbox name
+
+ @return boolean True on success, False on error
+ @access public
+ */
+ public function clear_folder($mailbox) {
+ $num_in_trash = $this->countMessages($mailbox);
+ if ($num_in_trash > 0) {
+ $res = $this->delete($mailbox, '1:*');
+ }
+
+ if ($res) {
+ if ($this->selected == $mailbox)
+ $res = $this->close();
+ else
+ $res = $this->expunge($mailbox);
+ }
+
+ return $res;
+ }
+
+ /*
+ Returns count of all messages in a folder
+
+ @param string $mailbox Mailbox name
+
+ @return int Number of messages, False on error
+ @access public
+ */
+ public function count_messages($mailbox, $refresh = false) {
+ if ($refresh) {
+ $this->selected = '';
+ }
+
+ if ($this->selected == $mailbox) {
+ return $this->data['EXISTS'];
+ }
+
+ // Check internal cache
+ $cache = $this->data['STATUS:'.$mailbox];
+ if (!empty($cache) && isset($cache['MESSAGES'])) {
+ return (int) $cache['MESSAGES'];
+ }
+
+ // Try STATUS (should be faster than SELECT)
+ $counts = $this->status($mailbox);
+ if (is_array($counts)) {
+ return (int) $counts['MESSAGES'];
+ }
+
+ return false;
+ }
+
+ /*
+ Returns count of messages with \Recent flag in a folder
+
+ @param string $mailbox Mailbox name
+
+ @return int Number of messages, False on error
+ @access public
+ */
+ public function count_recent($mailbox) {
+ if (!strlen($mailbox)) {
+ $mailbox = 'INBOX';
+ }
+
+ $this->imap_select($mailbox);
+
+ if ($this->selected == $mailbox) {
+ return $this->data['RECENT'];
+ }
+
+ return false;
+ }
+
+ /*
+ Returns count of messages without \Seen flag in a specified folder
+
+ @param string $mailbox Mailbox name
+
+ @return int Number of messages, False on error
+ @access public
+ */
+ public function count_unseen($mailbox) {
+ // Check internal cache
+ $cache = $this->data['STATUS:'.$mailbox];
+ if (!empty($cache) && isset($cache['UNSEEN'])) {
+ return (int) $cache['UNSEEN'];
+ }
+
+ // Try STATUS (should be faster than SELECT+SEARCH)
+ $counts = $this->status($mailbox);
+ if (is_array($counts)) {
+ return (int) $counts['UNSEEN'];
+ }
+
+ // Invoke SEARCH as a fallback
+ $index = $this->search($mailbox, 'ALL UNSEEN', false, array('COUNT'));
+ if (is_array($index)) {
+ return (int) $index['COUNT'];
+ }
+
+ return false;
+ }
+
+ public function fetch_header(
+ $mailbox,
+ $id,
+ $uidfetch=false,
+ $bodystr=false,
+ $add=''
+ ) {
+
+ $a = $this->fetch_headers($mailbox, $id, $uidfetch, $bodystr, $add);
+ if (is_array($a)) {
+ return array_shift($a);
+ }
+ return false;
+ }
+
+ public function fetch_headers(
+ $mailbox,
+ $message_set,
+ $is_uid = false,
+ $bodystr = false,
+ $add = ''
+ ) {
+
+ $query_items = array('UID', 'RFC822.SIZE', 'FLAGS', 'INTERNALDATE');
+ if ($bodystr)
+ $query_items[] = 'BODYSTRUCTURE';
+ $query_items[] = 'BODY.PEEK[HEADER.FIELDS ('
+ . 'DATE FROM TO SUBJECT CONTENT-TYPE CC REPLY-TO LIST-POST DISPOSITION-NOTIFICATION-TO X-PRIORITY'
+ . ($add ? ' ' . trim($add) : '')
+ . ')]';
+
+ $result = $this->imap_fetch($mailbox, $message_set, $is_uid, $query_items);
+
+ return $result;
+ }
+
+ public function fetch_header_index(
+ $mailbox,
+ $message_set,
+ $index_field='',
+ $skip_deleted=true,
+ $uidfetch=false
+ ) {
+
+ if (is_array($message_set)) {
+ if (!($message_set = $this->__compress_messageset($message_set)))
+ return false;
+ } else {
+ list($from_idx, $to_idx) = explode(':', $message_set);
+ if (empty($message_set) ||
+ (isset($to_idx) && $to_idx != '*' && (int)$from_idx > (int)$to_idx)) {
+ return false;
+ }
+ }
+
+ $index_field = empty($index_field) ? 'DATE' : strtoupper($index_field);
+
+ $fields_a['DATE'] = 1;
+ $fields_a['INTERNALDATE'] = 4;
+ $fields_a['ARRIVAL'] = 4;
+ $fields_a['FROM'] = 1;
+ $fields_a['REPLY-TO'] = 1;
+ $fields_a['SENDER'] = 1;
+ $fields_a['TO'] = 1;
+ $fields_a['CC'] = 1;
+ $fields_a['SUBJECT'] = 1;
+ $fields_a['UID'] = 2;
+ $fields_a['SIZE'] = 2;
+ $fields_a['SEEN'] = 3;
+ $fields_a['RECENT'] = 3;
+ $fields_a['DELETED'] = 3;
+
+ if (!($mode = $fields_a[$index_field])) {
+ return false;
+ }
+
+ /* Do "SELECT" command */
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ // build FETCH command string
+ $key = $this->__next_tag();
+ $cmd = $uidfetch ? 'UID FETCH' : 'FETCH';
+ $deleted = $skip_deleted ? ' FLAGS' : '';
+
+ if ($mode == 1 && $index_field == 'DATE')
+ $request = " $cmd $message_set (INTERNALDATE BODY.PEEK[HEADER.FIELDS (DATE)]$deleted)";
+ else if ($mode == 1)
+ $request = " $cmd $message_set (BODY.PEEK[HEADER.FIELDS ($index_field)]$deleted)";
+ else if ($mode == 2) {
+ if ($index_field == 'SIZE')
+ $request = " $cmd $message_set (RFC822.SIZE$deleted)";
+ else
+ $request = " $cmd $message_set ($index_field$deleted)";
+ } else if ($mode == 3)
+ $request = " $cmd $message_set (FLAGS)";
+ else // 4
+ $request = " $cmd $message_set (INTERNALDATE$deleted)";
+
+ $request = $key . $request;
+
+ if (!$this->__put_line($request)) {
+ $this->__set_error(self::ERROR_COMMAND, "Unable to send command: $request");
+ return false;
+ }
+
+ $result = array();
+
+ do {
+ $line = rtrim($this->__read_line(200));
+ $line = $this->__multi_line($line);
+
+ if (preg_match('/^\* ([0-9]+) FETCH/', $line, $m)) {
+ $id = $m[1];
+ $flags = NULL;
+
+ if ($skip_deleted && preg_match('/FLAGS \(([^)]+)\)/', $line, $matches)) {
+ $flags = explode(' ', strtoupper($matches[1]));
+ if (in_array('\\DELETED', $flags)) {
+ $deleted[$id] = $id;
+ continue;
+ }
+ }
+
+ if ($mode == 1 && $index_field == 'DATE') {
+ if (preg_match('/BODY\[HEADER\.FIELDS \("*DATE"*\)\] (.*)/', $line, $matches)) {
+ $value = preg_replace(array('/^"*[a-z]+:/i'), '', $matches[1]);
+ $value = trim($value);
+ $result[$id] = $this->str_to_time($value);
+ }
+ // non-existent/empty Date: header, use INTERNALDATE
+ if (empty($result[$id])) {
+ if (preg_match('/INTERNALDATE "([^"]+)"/', $line, $matches))
+ $result[$id] = $this->str_to_time($matches[1]);
+ else
+ $result[$id] = 0;
+ }
+ } 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 {
+ $result[$id] = '';
+ }
+ } else if ($mode == 2) {
+ if (preg_match('/(UID|RFC822\.SIZE) ([0-9]+)/', $line, $matches)) {
+ $result[$id] = trim($matches[2]);
+ } else {
+ $result[$id] = 0;
+ }
+ } 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) {
+ if (preg_match('/INTERNALDATE "([^"]+)"/', $line, $matches)) {
+ $result[$id] = $this->str_to_time($matches[1]);
+ } else {
+ $result[$id] = 0;
+ }
+ }
+ }
+ } while (!$this->__starts_with($line, $key, true, true));
+
+ return $result;
+ }
+
+ public function fetch_mime_headers($mailbox, $id, $parts, $mime=true) {
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ $result = false;
+ $parts = (array) $parts;
+ $key = $this->__next_tag();
+ $peeks = '';
+ $idx = 0;
+ $type = $mime ? 'MIME' : 'HEADER';
+
+ // format request
+ foreach($parts as $part) {
+ $peeks[] = "BODY.PEEK[$part.$type]";
+ }
+
+ $request = "$key FETCH $id (" . implode(' ', $peeks) . ')';
+
+ // send request
+ if (!$this->__put_line($request)) {
+ $this->__set_error(self::ERROR_COMMAND, "Unable to send command: $request");
+ return false;
+ }
+
+ do {
+ $line = $this->__read_line(1024);
+ $line = $this->__multi_line($line);
+
+ if (preg_match('/BODY\[([0-9\.]+)\.'.$type.'\]/', $line, $matches)) {
+ $idx = $matches[1];
+ $result[$idx] = preg_replace('/^(\* '.$id.' FETCH \()?\s*BODY\['.$idx.'\.'.$type.'\]\s+/', '', $line);
+ $result[$idx] = trim($result[$idx], '"');
+ $result[$idx] = rtrim($result[$idx], "\t\r\n\0\x0B");
+ }
+ } while (!$this->__starts_with($line, $key, true));
+
+ return $result;
+ }
+
+ public function fetch_part_header($mailbox, $id, $is_uid=false, $part=NULL) {
+ $part = empty($part) ? 'HEADER' : $part.'.MIME';
+
+ return $this->handlePartBody($mailbox, $id, $is_uid, $part);
+ }
+
+ public function fetch_structure_string($mailbox, $id, $is_uid=false) {
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ $key = $this->__next_tag();
+ $result = false;
+ $command = $key . ($is_uid ? ' UID' : '') ." FETCH $id (BODYSTRUCTURE)";
+
+ if ($this->__put_line($command)) {
+ do {
+ $line = $this->__read_line(5000);
+ $line = $this->multLine($line, true);
+ if (!preg_match("/^$key /", $line))
+ $result .= $line;
+ } while (!$this->__starts_with($line, $key, true, true));
+
+ $result = trim(substr($result, strpos($result, 'BODYSTRUCTURE')+13, -1));
+ }
+ else {
+ $this->__set_error(self::ERROR_COMMAND, "Unable to send command: $command");
+ }
+
+ return $result;
+ }
+
+ public function fetch_uids($mailbox, $message_set=null) {
+ if (is_array($message_set))
+ $message_set = join(',', $message_set);
+ else if (empty($message_set))
+ $message_set = '1:*';
+
+ return $this->fetch_header_index($mailbox, $message_set, 'UID', false);
+ }
+
+ /*
+ Gets the delimiter
+
+ @return string The delimiter
+ */
+ public function get_hierarchyseperator($mailbox=null) {
+ /*
+ For a null mailbox, assume personal namespace.
+ */
+
+ $namespaces = $this->imap_namespace();
+
+ # Fake a bad response on IMAP command NAMESPACE
+ $namespaces = self::ERROR_BAD;
+
+ if ($namespaces < 0) {
+ if (isset($this->delimiter)) {
+ return $this->delimiter;
+ }
+
+ // try (LIST "" ""), should return delimiter (RFC2060 Sec 6.3.8)
+ list($code, $response) = $this->__execute(
+ 'LIST',
+ Array($this->_escape(''), $this->_escape(''))
+ );
+
+ if ($code == self::ERROR_OK) {
+ $args = $this->__tokenize_response($response, 4);
+ $delimiter = $args[3];
+
+ if (strlen($delimiter) > 0) {
+ return ($this->delimiter = $delimiter);
+ }
+ }
+ } else {
+ if ($mailbox == null) {
+ if (isset($namespaces)) {
+ return $namespaces['personal'][1];
+ } elseif (isset($this->delimiter)) {
+ return $this->delimiter;
+ } else {
+ return self::ERROR_BAD;
+ }
+ } else {
+ if (substr(
+ $mailbox,
+ 0,
+ strlen($namespaces['user'][0])
+ ) == $namespaces['user'][0]
+ ) {
+
+ return $namespaces['user'][1];
+ } elseif (substr(
+ $mailbox,
+ 0,
+ strlen($namespaces['shared'][0])
+ ) == $namespaces['shared'][0]
+ ) {
+
+ return $namespaces['shared'][1];
+ } elseif (substr(
+ $mailbox,
+ 0,
+ strlen($namespaces['personal'][0])
+ ) == $namespaces['personal'][0]
+ ) {
+
+ return $namespaces['personal'][1];
+ }
+ return self::ERROR_BAD;
+ }
+ }
+ }
+
+ /*
+ Returns BODYSTRUCTURE for the specified message.
+
+ @param string $mailbox Folder name
+ @param int $id Message sequence number or UID
+ @param bool $is_uid True if $id is an UID
+
+ @return array/bool Body structure array or False on error.
+ @since 0.6
+ */
+ public function get_structure($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;
+ }
+
+ static function get_structure_part_type($structure, $part)
+ {
+ $part_a = self::get_structure_part_array($structure, $part);
+ if (!empty($part_a)) {
+ if (is_array($part_a[0]))
+ return 'multipart';
+ else if ($part_a[0])
+ return $part_a[0];
+ }
+
+ return 'other';
+ }
+
+ static function get_structure_part_encoding($structure, $part)
+ {
+ $part_a = self::get_structure_part_array($structure, $part);
+ if ($part_a) {
+ if (!is_array($part_a[0]))
+ return $part_a[5];
+ }
+
+ return '';
+ }
+
+ static function get_structure_part_charset($structure, $part)
+ {
+ $part_a = self::get_structure_part_array($structure, $part);
+ if ($part_a) {
+ if (is_array($part_a[0]))
+ return '';
+ else {
+ if (is_array($part_a[2])) {
+ $name = '';
+ while (list($key, $val) = each($part_a[2]))
+ if (strcasecmp($val, 'charset') == 0)
+ return $part_a[2][$key+1];
+ }
+ }
+ }
+
+ return '';
+ }
+
+ static function get_structure_part_array($a, $part)
+ {
+ if (!is_array($a)) {
+ return false;
+ }
+ if (strpos($part, '.') > 0) {
+ $original_part = $part;
+ $pos = strpos($part, '.');
+ $rest = substr($original_part, $pos+1);
+ $part = substr($original_part, 0, $pos);
+ if ((strcasecmp($a[0], 'message') == 0) && (strcasecmp($a[1], 'rfc822') == 0)) {
+ $a = $a[8];
+ }
+ return self::get_structure_part_array($a[$part-1], $rest);
+ }
+ else if ($part>0) {
+ if (!is_array($a[0]) && (strcasecmp($a[0], 'message') == 0)
+ && (strcasecmp($a[1], 'rfc822') == 0)) {
+ $a = $a[8];
+ }
+ if (is_array($a[$part-1]))
+ return $a[$part-1];
+ else
+ return $a;
+ }
+ else if (($part == 0) || (empty($part))) {
+ return $a;
+ }
+ }
+
+ public function handle_part_body(
+ $mailbox,
+ $id,
+ $is_uid=false,
+ $part='',
+ $encoding=NULL,
+ $print=NULL,
+ $file=NULL
+ ) {
+
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ switch ($encoding) {
+ case 'base64':
+ $mode = 1;
+ break;
+ case 'quoted-printable':
+ $mode = 2;
+ break;
+ case 'x-uuencode':
+ case 'x-uue':
+ case 'uue':
+ case 'uuencode':
+ $mode = 3;
+ break;
+ default:
+ $mode = 0;
+ }
+
+ // format request
+ $reply_key = '* ' . $id;
+ $key = $this->__next_tag();
+ $request = $key . ($is_uid ? ' UID' : '') . " FETCH $id (BODY.PEEK[$part])";
+
+ // send request
+ if (!$this->__put_line($request)) {
+ $this->__set_error(self::ERROR_COMMAND, "Unable to send command: $request");
+ return false;
+ }
+
+ // receive reply line
+ do {
+ $line = rtrim($this->__read_line(1024));
+ $a = explode(' ', $line);
+ } while (!($end = $this->__starts_with($line, $key, true)) && $a[2] != 'FETCH');
+
+ $len = strlen($line);
+ $result = false;
+
+ // handle empty "* X FETCH ()" response
+ if ($line[$len-1] == ')' && $line[$len-2] != '(') {
+ // one line response, get everything between first and last quotes
+ if (substr($line, -4, 3) == 'NIL') {
+ // NIL response
+ $result = '';
+ } else {
+ $from = strpos($line, '"') + 1;
+ $to = strrpos($line, '"');
+ $len = $to - $from;
+ $result = substr($line, $from, $len);
+ }
+
+ if ($mode == 1) {
+ $result = base64_decode($result);
+ }
+ else if ($mode == 2) {
+ $result = quoted_printable_decode($result);
+ }
+ else if ($mode == 3) {
+ $result = convert_uudecode($result);
+ }
+
+ } else if ($line[$len-1] == '}') {
+ // multi-line request, find sizes of content and receive that many bytes
+ $from = strpos($line, '{') + 1;
+ $to = strrpos($line, '}');
+ $len = $to - $from;
+ $sizeStr = substr($line, $from, $len);
+ $bytes = (int)$sizeStr;
+ $prev = '';
+
+ while ($bytes > 0) {
+ $line = $this->__read_line(4096);
+
+ if ($line === NULL) {
+ break;
+ }
+
+ $len = strlen($line);
+
+ if ($len > $bytes) {
+ $line = substr($line, 0, $bytes);
+ $len = strlen($line);
+ }
+ $bytes -= $len;
+
+ // BASE64
+ if ($mode == 1) {
+ $line = rtrim($line, "\t\r\n\0\x0B");
+ // create chunks with proper length for base64 decoding
+ $line = $prev.$line;
+ $length = strlen($line);
+ if ($length % 4) {
+ $length = floor($length / 4) * 4;
+ $prev = substr($line, $length);
+ $line = substr($line, 0, $length);
+ }
+ else
+ $prev = '';
+ $line = base64_decode($line);
+ // QUOTED-PRINTABLE
+ } else if ($mode == 2) {
+ $line = rtrim($line, "\t\r\0\x0B");
+ $line = quoted_printable_decode($line);
+ // Remove NULL characters (#1486189)
+ $line = str_replace("\x00", '', $line);
+ // UUENCODE
+ } else if ($mode == 3) {
+ $line = rtrim($line, "\t\r\n\0\x0B");
+ if ($line == 'end' || preg_match('/^begin\s+[0-7]+\s+.+$/', $line))
+ continue;
+ $line = convert_uudecode($line);
+ // default
+ } else {
+ $line = rtrim($line, "\t\r\n\0\x0B") . "\n";
+ }
+
+ if ($file)
+ fwrite($file, $line);
+ else if ($print)
+ echo $line;
+ else
+ $result .= $line;
+ }
+ }
+
+ // read in anything up until last line
+ if (!$end)
+ do {
+ $line = $this->__read_line(1024);
+ } while (!$this->__starts_with($line, $key, true));
+
+ if ($result !== false) {
+ if ($file) {
+ fwrite($file, $result);
+ } else if ($print) {
+ echo $result;
+ } else
+ return $result;
+ return true;
+ }
+
+ return false;
+ }
+
+ /*
+ Returns message unique identifier (UID)
+
+ @param string $mailbox Mailbox name
+ @param int $id Message sequence identifier
+
+ @return int Message unique identifier
+ @access public
+ */
+ public function id_to_uid($mailbox, $id) {
+ if (empty($id) || $id < 0) {
+ return null;
+ }
+
+ if (!$this->imap_select($mailbox)) {
+ return null;
+ }
+
+ list($code, $response) = $this->execute('FETCH', array($id, '(UID)'));
+
+ if ($code == self::ERROR_OK && preg_match("/^\* $id FETCH \(UID (.*)\)/i", $response, $m)) {
+ return (int) $m[1];
+ }
+
+ return null;
+ }
+
+ /*
+ Send the SETANNOTATION command with NIL values
+ (draft-daboo-imap-annotatemore)
+
+ @param string $mailbox Mailbox name
+ @param array $data Data array where each item is an array with
+ two elements: entry name and attribute name
+
+ @return boolean True on success, False on failure
+
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_deleteannotation($mailbox, $data) {
+ if (!is_array($data) || empty($data)) {
+ $this->__set_error(self::ERROR_COMMAND, "Wrong argument for SETANNOTATION command");
+ return false;
+ }
+
+ return $this->setannotation($mailbox, $data);
+ }
+
+ /*
+ Send the SETMETADATA command with NIL values (RFC5464)
+
+ @param string $mailbox Mailbox name
+ @param array $entries Entry names array
+
+ @return boolean True on success, False on failure
+
+ @access public
+ @since 0.5-beta
+ */
+ public function imap_deletemetadata($mailbox, $entries) {
+ if (!is_array($entries) && !empty($entries)) {
+ $entries = explode(' ', $entries);
+ }
+
+ if (empty($entries)) {
+ $this->__set_error(self::ERROR_COMMAND, "Wrong argument for SETMETADATA command");
+ return false;
+ }
+
+ foreach ($entries as $entry) {
+ $data[$entry] = NULL;
+ }
+
+ return $this->setmetadata($mailbox, $data);
+ }
+
+ /*
+ NAMESPACE handler (RFC 2342)
+
+ @return array Namespace data hash (personal, user, shared)
+ */
+ public function imap_namespace() {
+ if (!isset($this->namespaces) && !$this->_get_capability('NAMESPACE')) {
+ return self::ERROR_BAD;
+ } elseif ($this->_get_capability('NAMESPACE')) {
+ if (isset($this->_namespaces)) {
+ return $this->_namespaces;
+ }
+
+ list($code, $response) = $this->__execute('NAMESPACE');
+
+ if ($code == self::ERROR_OK && preg_match('/^\* NAMESPACE /', $response)) {
+ $data = $this->__tokenize_response(substr($response, 11));
+ }
+
+ if (!is_array($data)) {
+ return $code;
+ }
+
+ $this->_namespaces = Array(
+ 'personal' => Array(
+ $data[0][0][0],
+ $data[0][0][1],
+ ),
+ 'user' => Array(
+ $data[1][0][0],
+ $data[1][0][1],
+ ),
+ 'shared' => Array(
+ $data[2][0][0],
+ $data[2][0][1],
+ )
+ );
+
+ return $this->_namespaces;
+ } else {
+ return $this->namespaces;
+ }
+ }
+
+ /*
+ Set the value of the debugging flag.
+
+ @param boolean $debug New value for the debugging flag.
+
+ @access public
+ @since 0.5-stable
+ */
+ public function set_debug($debug, $handler = null) {
+ $this->_debug = $debug;
+ $this->_debug_handler = $handler;
+ }
+
+ public function sort_headers($a, $field, $flag) {
+ if (empty($field)) {
+ $field = 'uid';
+ }
+ else {
+ $field = strtolower($field);
+ }
+
+ if ($field == 'date' || $field == 'internaldate') {
+ $field = 'timestamp';
+ }
+
+ if (empty($flag)) {
+ $flag = 'ASC';
+ } else {
+ $flag = strtoupper($flag);
+ }
+
+ $c = count($a);
+ if ($c > 0) {
+ // Strategy:
+ // First, we'll create an "index" array.
+ // Then, we'll use sort() on that array,
+ // and use that to sort the main array.
+
+ // create "index" array
+ $index = array();
+ reset($a);
+ while (list($key, $val) = each($a)) {
+ if ($field == 'timestamp') {
+ $data = $this->str_to_time($val->date);
+ if (!$data) {
+ $data = $val->timestamp;
+ }
+ } else {
+ $data = $val->$field;
+ if (is_string($data)) {
+ $data = str_replace('"', '', $data);
+ if ($field == 'subject') {
+ $data = preg_replace('/^(Re: \s*|Fwd:\s*|Fw:\s*)+/i', '', $data);
+ }
+ $data = strtoupper($data);
+ }
+ }
+ $index[$key] = $data;
+ }
+
+ // sort index
+ if ($flag == 'ASC') {
+ asort($index);
+ } else {
+ arsort($index);
+ }
+
+ // form new array based on index
+ $result = array();
+ reset($index);
+ while (list($key, $val) = each($index)) {
+ $result[$key] = $a[$key];
+ }
+ }
+
+ return $result;
+ }
+
+ /*
+ Converts datetime string into unix timestamp
+
+ @param string $date Date string
+
+ @return int Unix timestamp
+ */
+ static function str_to_time($date) {
+ // support non-standard "GMTXXXX" literal
+ $date = preg_replace('/GMT\s*([+-][0-9]+)/', '\\1', $date);
+
+ // if date parsing fails, we have a date in non-rfc format
+ // remove token from the end and try again
+ while (($ts = intval(@strtotime($date))) <= 0) {
+ $d = explode(' ', $date);
+ array_pop($d);
+ if (empty($d)) {
+ break;
+ }
+ $date = implode(' ', $d);
+ }
+
+ return $ts < 0 ? 0 : $ts;
+ }
+
+ /*
+ Returns message sequence identifier
+
+ @param string $mailbox Mailbox name
+ @param int $uid Message unique identifier (UID)
+
+ @return int Message sequence identifier
+ @access public
+ */
+ public function uid_to_id($mailbox, $uid) {
+ if ($uid > 0) {
+ $id_a = $this->search($mailbox, "UID $uid");
+ if (is_array($id_a) && count($id_a) == 1) {
+ return (int) $id_a[0];
+ }
+ }
+ return null;
+ }
+
+################################################################################
+################################################################################
+################################################################################
+ /**
+ * Routine shortcut commands (pretty high-level)
+ */
+################################################################################
+################################################################################
+################################################################################
+
+ private function _has_capability($name) {
+ if (empty($this->capability) || $name == '') {
+ return false;
+ }
+
+ if (in_array($name, $this->capability)) {
+ return true;
+ }
+ else if (strpos($name, '=')) {
+ return false;
+ }
+
+ $result = array();
+ foreach ($this->capability as $cap) {
+ $entry = explode('=', $cap);
+ if ($entry[0] == $name) {
+ $result[] = $entry[1];
+ }
+ }
+
+ return !empty($result) ? $result : false;
+ }
+
+ private function _clear_capability() {
+ $this->capability = array();
+ $this->capability_read = false;
+ }
+
+ /*
+ Capabilities checker
+
+ @param string $name Capability name
+
+ @return mixed Capability values array for key=value pairs, true/false for others
+ */
+ private function _get_capability($name) {
+ $result = $this->_has_capability($name);
+
+ if (!empty($result)) {
+ return $result;
+ }
+ else if ($this->capability_read) {
+ return false;
+ }
+
+ // get capabilities (only once) because initial
+ // optional CAPABILITY response may differ
+ $result = $this->__execute('CAPABILITY');
+
+ if ($result[0] == self::ERROR_OK) {
+ $this->_parse_capability($result[1]);
+ }
+
+ $this->capability_read = true;
+
+ return $this->_has_capability($name);
+ }
+
+ private function _parse_capability($str, $trusted=false) {
+ $str = preg_replace('/^\* CAPABILITY /i', '', $str);
+
+ $this->capability = explode(' ', strtoupper($str));
+
+ if (!isset($this->literal) && in_array('LITERAL+', $this->capability)) {
+ $this->literal = true;
+ }
+
+ if ($trusted) {
+ $this->capability_read = true;
+ }
+ }
+
+ // Don't be tempted to change $str to pass by reference to speed this up - it will slow it down by about
+ // 7 times instead :-) See comments on http://uk2.php.net/references and this article:
+ // http://derickrethans.nl/files/phparch-php-variables-article.pdf
+ private function _parse_thread(
+ $str,
+ $begin,
+ $end,
+ $root,
+ $parent,
+ $depth,
+ &$depthmap,
+ &$haschildren
+ ) {
+
+ $node = Array();
+
+ if ($str[$begin] != '(') {
+ $stop = $begin + strspn($str, '1234567890', $begin, $end - $begin);
+ $msg = substr($str, $begin, $stop - $begin);
+
+ if ($msg == 0)
+ return $node;
+
+ if (is_null($root))
+ $root = $msg;
+
+ $depthmap[$msg] = $depth;
+ $haschildren[$msg] = false;
+
+ if (!is_null($parent))
+ $haschildren[$parent] = true;
+
+ if ($stop + 1 < $end) {
+ $node[$msg] = $this->_parse_thread(
+ $str,
+ $stop + 1,
+ $end,
+ $root,
+ $msg,
+ $depth + 1,
+ $depthmap,
+ $haschildren
+ );
+
+ } else {
+ $node[$msg] = array();
+ }
+
+ } else {
+ $off = $begin;
+
+ while ($off < $end) {
+ $start = $off;
+ $off++;
+ $n = 1;
+
+ while ($n > 0) {
+ $p = strpos($str, ')', $off);
+
+ if ($p === false) {
+ error_log(
+ "Mismatched brackets parsing IMAP THREAD " .
+ "response:"
+ );
+
+ error_log(substr(
+ $str,
+ ($begin < 10) ? 0 : ($begin - 10),
+ $end - $begin + 20
+ ));
+
+ error_log(str_repeat(
+ ' ',
+ $off - (($begin < 10) ? 0 : ($begin - 10))
+ ));
+
+ return $node;
+ }
+
+ $p1 = strpos($str, '(', $off);
+
+ if ($p1 !== false && $p1 < $p) {
+ $off = $p1 + 1;
+ $n++;
+ } else {
+ $off = $p + 1;
+ $n--;
+ }
+ }
+
+ $node += $this->_parse_thread(
+ $str,
+ $start + 1,
+ $off - 1,
+ $root,
+ $parent,
+ $depth,
+ $depthmap,
+ $haschildren
+ );
+ }
+ }
+
+ return $node;
+ }
+
+################################################################################
+################################################################################
+################################################################################
+ /**
+ * Commands only this library uses (pretty low-level)
+ */
+################################################################################
+################################################################################
+################################################################################
+
+ private function __close_socket()
+ {
+ @fclose($this->fp);
+ $this->fp = null;
+ }
+
+ /*
+ IMAP LIST/LSUB command. Used with imap_list() and imap_lsub().
+
+ @param string $ref Reference name
+ @param string $mailbox Mailbox name
+ @param bool $subscribed Enables returning subscribed mailboxes
+ only.
+
+ @param array $status_opts RFC5819: LIST-STATUS Options.
+ Possible Values: MESSAGES, RECENT,
+ UIDNEXT, UIDVALIDITY, UNSEEN
+
+ @param array $select_opts RFC5258: LIST-EXTENDED Selection options
+ Possible Values: SUBSCRIBED,
+ RECURSIVEMATCH, REMOTE
+
+ @return array List of mailboxes or hash of options if $status_ops
+ argument is non-empty.
+
+ @access private
+ */
+ private function __list($ref, $mailbox, $subscribed=false,
+ $status_opts=array(), $select_opts=array()) {
+
+ $lstatus = false;
+
+ if (!strlen($mailbox)) {
+ $mailbox = '*';
+ }
+
+ $args = array();
+
+ if (!empty($select_opts) && $this->_get_capability('LIST-EXTENDED')) {
+ $select_opts = (array) $select_opts;
+
+ $args[] = '(' . implode(' ', $select_opts) . ')';
+ }
+
+ $args[] = $this->_escape($ref);
+ $args[] = $this->_escape($mailbox);
+
+ if (!empty($status_opts) && $this->_get_capability('LIST-STATUS')) {
+ $status_opts = (array) $status_opts;
+ $lstatus = true;
+
+ $args[] = 'RETURN (STATUS (' . implode(' ', $status_opts) . '))';
+ }
+
+ list($code, $response) = $this->__execute($subscribed ? 'LSUB' : 'LIST', $args);
+
+ if ($code == self::ERROR_OK) {
+ $folders = array();
+ while ($this->__tokenize_response($response, 1) == '*') {
+ $cmd = strtoupper($this->__tokenize_response($response, 1));
+ // * LIST (<options>) <delimiter> <mailbox>
+ if ($cmd == 'LIST' || $cmd == 'LSUB') {
+ list($opts, $delim, $mailbox) = $this->__tokenize_response($response, 3);
+
+ // Add to result array
+ if (!$lstatus) {
+ $folders[] = $mailbox;
+ }
+ else {
+ $folders[$mailbox] = array();
+ }
+
+ // Add to options array
+ if (!empty($opts)) {
+ if (empty($this->data['LIST'][$mailbox]))
+ $this->data['LIST'][$mailbox] = $opts;
+ else
+ $this->data['LIST'][$mailbox] = array_unique(array_merge(
+ $this->data['LIST'][$mailbox], $opts));
+ }
+ }
+ // * STATUS <mailbox> (<result>)
+ else if ($cmd == 'STATUS') {
+ list($mailbox, $status) = $this->__tokenize_response($response, 2);
+
+ for ($i=0, $len=count($status); $i<$len; $i += 2) {
+ list($name, $value) = $this->__tokenize_response($status, 2);
+ $folders[$mailbox][$name] = $value;
+ }
+ }
+ // other untagged response line, skip it
+ else {
+ $response = ltrim($response);
+ if (($position = strpos($response, "\n")) !== false)
+ $response = substr($response, $position+1);
+ else
+ $response = '';
+ }
+ }
+
+ return $folders;
+ }
+
+ return false;
+ }
+
+ private function __read_line($size=1024) {
+ $line = '';
+
+ if (!$size) {
+ $size = 1024;
+ }
+
+ do {
+ if ($this->__eof()) {
+ return $line ? $line : NULL;
+ }
+
+ $buffer = fgets($this->fp, $size);
+
+ if ($buffer === false) {
+ $this->__close_socket();
+ break;
+ }
+ if ($this->_debug) {
+ $this->debug('S: '. rtrim($buffer));
+ }
+ $line .= $buffer;
+ } while (substr($buffer, -1) != "\n");
+
+ return $line;
+ }
+
+ private function __read_reply(&$untagged=null) {
+ do {
+ $line = trim($this->__read_line(1024));
+ // store untagged response lines
+ if ($line[0] == '*')
+ $untagged[] = $line;
+ } while ($line[0] == '*');
+
+ if ($untagged)
+ $untagged = join("\n", $untagged);
+
+ return $line;
+ }
+
+ private function __store_flag($mailbox, $messages, $flag, $mod) {
+ if ($mod != '+' && $mod != '-') {
+ $mod = '+';
+ }
+
+ if (!$this->imap_select($mailbox)) {
+ return false;
+ }
+
+ if (!$this->data['READ-WRITE']) {
+ $this->__set_error(self::ERROR_READONLY, "Mailbox is read-only", 'STORE');
+ return false;
+ }
+
+ // Clear internal status cache
+ if ($flag == 'SEEN') {
+ unset($this->data['STATUS:'.$mailbox]['UNSEEN']);
+ }
+
+ $flag = $this->flags[strtoupper($flag)];
+ $result = $this->__execute('UID STORE', array(
+ $this->__compress_messageset($messages), $mod . 'FLAGS.SILENT', "($flag)"),
+ self::COMMAND_NORESPONSE);
+
+ return ($result == self::ERROR_OK);
+ }
+
+ static function __compress_messageset($messages, $force=false) {
+ // given a comma delimited list of independent mid's,
+ // compresses by grouping sequences together
+
+ if (!is_array($messages)) {
+ // if less than 255 bytes long, let's not bother
+ if (!$force && strlen($messages)<255) {
+ return $messages;
+ }
+
+ // see if it's already been compressed
+ if (strpos($messages, ':') !== false) {
+ return $messages;
+ }
+
+ // separate, then sort
+ $messages = explode(',', $messages);
+ }
+
+ sort($messages);
+
+ $result = array();
+ $start = $prev = $messages[0];
+
+ foreach ($messages as $id) {
+ $incr = $id - $prev;
+ if ($incr > 1) { // found a gap
+ if ($start == $prev) {
+ $result[] = $prev; // push single id
+ } else {
+ $result[] = $start . ':' . $prev; // push sequence as start_id:end_id
+ }
+ $start = $id; // start of new sequence
+ }
+ $prev = $id;
+ }
+
+ // handle the last sequence/id
+ if ($start == $prev) {
+ $result[] = $prev;
+ } else {
+ $result[] = $start.':'.$prev;
+ }
+
+ // return as comma separated string
+ return implode(',', $result);
+ }
+
+ private function __eof() {
+ if (!is_resource($this->fp)) {
+ return true;
+ }
+
+ // If a connection opened by fsockopen() wasn't closed
+ // by the server, feof() will hang.
+ $start = microtime(true);
+
+ if (feof($this->fp) ||
+ ($this->timeout && (microtime(true) - $start > $this->timeout))
+ ) {
+ $this->__close_socket();
+ return true;
+ }
+
+ return false;
+ }
+
+ /*
+ Sends IMAP command and parses result
+
+ @param string $command IMAP command
+ @param array $arguments Command arguments
+ @param int $options Execution options
+
+ @return mixed Response code or list of response code and data
+ @since 0.5-beta
+ */
+ private function __execute($command, $arguments=array(), $options=0) {
+ $tag = $this->__next_tag();
+ $query = $tag . ' ' . $command;
+ $noresp = ($options & self::COMMAND_NORESPONSE);
+ $response = $noresp ? null : '';
+
+ if (!empty($arguments)) {
+ foreach ($arguments as $arg) {
+ $query .= ' ' . self::r_implode($arg);
+ }
+ }
+
+ // Send command
+ if (!$this->__put_line_c($query)) {
+ $this->setError(self::ERROR_COMMAND, "Unable to send command: $query");
+ return $noresp ? self::ERROR_COMMAND : array(self::ERROR_COMMAND, '');
+ }
+
+ // Parse response
+ do {
+ $line = $this->__read_line(4096);
+ if ($response !== null) {
+ $response .= $line;
+ }
+ } while (!$this->__starts_with($line, $tag . ' ', true, true));
+
+ $code = $this->__parse_result($line, $command . ': ');
+
+ // Remove last line from response
+ if ($response) {
+ $line_len = min(strlen($response), strlen($line) + 2);
+ $response = substr($response, 0, -$line_len);
+ }
+
+ // optional CAPABILITY response
+ if (($options & self::COMMAND_CAPABILITY) && $code == self::ERROR_OK
+ && preg_match('/\[CAPABILITY ([^]]+)\]/i', $line, $matches)
+ ) {
+ $this->_parse_capability($matches[1], true);
+ }
+
+ // return last line only (without command tag, result and response code)
+ if ($line && ($options & self::COMMAND_LASTLINE)) {
+ $response = preg_replace("/^$tag (OK|NO|BAD|BYE|PREAUTH)?\s*(\[[a-z-]+\])?\s*/i", '', trim($line));
+ }
+
+ return $noresp ? $code : array($code, $response);
+ }
+
+ /*
+ Creates next command identifier (tag)
+
+ @return string Command identifier
+ @access public
+ @since 0.5-beta
+ */
+ private function __next_tag() {
+ $this->cmd_num++;
+ $this->cmd_tag = sprintf('A%04d', $this->cmd_num);
+
+ return $this->cmd_tag;
+ }
+
+ private function __parse_result($string, $err_prefix='') {
+ if (preg_match('/^[a-z0-9*]+ (OK|NO|BAD|BYE)(.*)$/i', trim($string), $matches)) {
+ $res = strtoupper($matches[1]);
+ $str = trim($matches[2]);
+
+ if ($res == 'OK') {
+ $this->errornum = self::ERROR_OK;
+ } else if ($res == 'NO') {
+ $this->errornum = self::ERROR_NO;
+ } else if ($res == 'BAD') {
+ $this->errornum = self::ERROR_BAD;
+ } else if ($res == 'BYE') {
+ $this->__close_socket();
+ $this->errornum = self::ERROR_BYE;
+ }
+
+ if ($str) {
+ $str = trim($str);
+ // get response string and code (RFC5530)
+ if (preg_match("/^\[([a-z-]+)\]/i", $str, $m)) {
+ $this->resultcode = strtoupper($m[1]);
+ $str = trim(substr($str, strlen($m[1]) + 2));
+ }
+ else {
+ $this->resultcode = null;
+ }
+ $this->result = $str;
+
+ if ($this->errornum != self::ERROR_OK) {
+ $this->error = $err_prefix ? $err_prefix.$str : $str;
+ }
+ }
+
+ return $this->errornum;
+ }
+ return self::ERROR_UNKNOWN;
+ }
+
+ /*
+ Send simple (one line) command to the connection stream
+
+ @param string $string Command string
+ @param bool $endln True if CRLF need to be added at the end of command
+
+ @param int Number of bytes sent, False on error
+ */
+ private function __put_line($string, $endln=true) {
+ if (!$this->fp)
+ return false;
+
+ if ($this->_debug) {
+ $this->debug('C: '. rtrim($string));
+ }
+
+ $res = fwrite($this->fp, $string . ($endln ? "\r\n" : ''));
+
+ if ($res === false) {
+ @fclose($this->fp);
+ $this->fp = null;
+ }
+
+ return $res;
+ }
+
+ /*
+ Send command to the connection stream with Command Continuation
+ Requests (RFC3501 7.5) and LITERAL+ (RFC2088) support
+
+ @param string $string Command string
+ @param bool $endln True if CRLF need to be added at the end of command
+
+ @param int Number of bytes sent, False on error
+ */
+ private function __put_line_c($string, $endln=true) {
+ if (!$this->fp)
+ return false;
+
+ if ($endln)
+ $string .= "\r\n";
+
+ $res = 0;
+ if ($parts = preg_split('/(\{[0-9]+\}\r\n)/m', $string, -1, PREG_SPLIT_DELIM_CAPTURE)) {
+ for ($i=0, $cnt=count($parts); $i<$cnt; $i++) {
+ if (isset($parts[$i+1]) && preg_match('/^\{([0-9]+)\}\r\n$/', $parts[$i+1], $matches)) {
+ // LITERAL+ support
+ if ($this->literal) {
+ $parts[$i+1] = sprintf("{%d+}\r\n", $matches[1]);
+ }
+
+ $bytes = $this->__put_line($parts[$i].$parts[$i+1], false);
+ if ($bytes === false)
+ return false;
+ $res += $bytes;
+
+ // don't wait if server supports LITERAL+ capability
+ if (!$this->literal) {
+ $line = $this->__read_line(1000);
+ // handle error in command
+ if ($line[0] != '+')
+ return false;
+ }
+ $i++;
+ }
+ else {
+ $bytes = $this->__put_line($parts[$i], false);
+ if ($bytes === false)
+ return false;
+ $res += $bytes;
+ }
+ }
+ }
+ return $res;
+ }
+
+ private function __multi_line($line, $escape=false) {
+ $line = rtrim($line);
+ if (preg_match('/\{[0-9]+\}$/', $line)) {
+ $out = '';
+
+ preg_match_all('/(.*)\{([0-9]+)\}$/', $line, $a);
+ $bytes = $a[2][0];
+ while (strlen($out) < $bytes) {
+ $line = $this->__read_bytes($bytes);
+ if ($line === NULL)
+ break;
+ $out .= $line;
+ }
+
+ $line = $a[1][0] . ($escape ? $this->_escape($out) : $out);
+ }
+
+ return $line;
+ }
+
+ private function __read_bytes($bytes) {
+ $data = '';
+ $len = 0;
+ while ($len < $bytes && !$this->__eof())
+ {
+ $d = fread($this->fp, $bytes-$len);
+ if ($this->_debug) {
+ $this->debug('S: '. $d);
+ }
+ $data .= $d;
+ $data_len = strlen($data);
+ if ($len == $data_len) {
+ break; // nothing was read -> exit to avoid apache lockups
+ }
+ $len = $data_len;
+ }
+
+ return $data;
+ }
+
+ private function __set_error($code, $msg='') {
+ $this->errornum = $code;
+ $this->error = $msg;
+ }
+
+ // check if $string starts with $match (or * BYE/BAD)
+ private function __starts_with($string, $match, $error=false, $nonempty=false) {
+ $len = strlen($match);
+ if ($len == 0) {
+ return false;
+ }
+ if (!$this->fp) {
+ return true;
+ }
+ if (strncmp($string, $match, $len) == 0) {
+ return true;
+ }
+ if ($error && preg_match('/^\* (BYE|BAD) /i', $string, $m)) {
+ if (strtoupper($m[1]) == 'BYE') {
+ $this->__close_socket();
+ }
+ return true;
+ }
+ if ($nonempty && !strlen($string)) {
+ return true;
+ }
+ return false;
+ }
+
+ /*
+ Splits IMAP response into string tokens
+
+ @param string &$str The IMAP's server response
+ @param int $num Number of tokens to return
+
+ @return mixed Tokens array or string if $num=1
+ @since 0.5-beta
+ */
+ static function __tokenize_response(&$str, $num=0) {
+ $result = array();
+
+ while (!$num || count($result) < $num) {
+ // remove spaces from the beginning of the string
+ $str = ltrim($str);
+
+ switch ($str[0]) {
+
+ // String literal
+ case '{':
+ if (($epos = strpos($str, "}\r\n", 1)) == false) {
+ // error
+ }
+ if (!is_numeric(($bytes = substr($str, 1, $epos - 1)))) {
+ // error
+ }
+ $result[] = $bytes ? substr($str, $epos + 3, $bytes) : '';
+ // Advance the string
+ $str = substr($str, $epos + 3 + $bytes);
+ break;
+
+ // Quoted string
+ case '"':
+ $len = strlen($str);
+
+ for ($pos=1; $pos<$len; $pos++) {
+ if ($str[$pos] == '"') {
+ break;
+ }
+ if ($str[$pos] == "\\") {
+ if ($str[$pos + 1] == '"' || $str[$pos + 1] == "\\") {
+ $pos++;
+ }
+ }
+ }
+ if ($str[$pos] != '"') {
+ // error
+ }
+ // we need to strip slashes for a quoted string
+ $result[] = stripslashes(substr($str, 1, $pos - 1));
+ $str = substr($str, $pos + 1);
+ break;
+
+ // Parenthesized list
+ case '(':
+ case '[':
+ $str = substr($str, 1);
+ $result[] = self::__tokenize_response($str);
+ break;
+ case ')':
+ case ']':
+ $str = substr($str, 1);
+ return $result;
+ break;
+
+ // String atom, number, NIL, *, %
+ default:
+ // empty or one character
+ if ($str === '') {
+ break 2;
+ }
+ if (strlen($str) < 2) {
+ $result[] = $str;
+ $str = '';
+ break;
+ }
+
+ // excluded chars: SP, CTL, ), [, ]
+ if (preg_match('/^([^\x00-\x20\x29\x5B\x5D\x7F]+)/', $str, $m)) {
+ $result[] = $m[1] == 'NIL' ? NULL : $m[1];
+ $str = substr($str, strlen($m[1]));
+ }
+ break;
+ }
+ }
+
+ return $num == 1 ? $result[0] : $result;
+ }
+
+ static function __uncompress_messageset($messages) {
+ $result = array();
+ $messages = explode(',', $messages);
+
+ foreach ($messages as $part) {
+ $items = explode(':', $part);
+ $max = max($items[0], $items[1]);
+
+ for ($x=$items[0]; $x<=$max; $x++) {
+ $result[] = $x;
+ }
+ }
+
+ return $result;
+ }
+
+ private function __xor($string, $string2) {
+ $result = '';
+ $size = strlen($string);
+
+ for ($i=0; $i<$size; $i++) {
+ $result .= chr(ord($string[$i]) ^ ord($string2[$i]));
+ }
+
+ return $result;
+ }
+
+ /*
+ Write the given debug text to the current debug output handler.
+
+ @param string $message Debug mesage text.
+
+ @access private
+ @since 0.5-stable
+ */
+ private function debug($message) {
+ if ($this->_debug_handler) {
+ call_user_func_array($this->_debug_handler, array(&$this, $message));
+ } else {
+ echo "DEBUG: $message\n";
+ }
+ }
+
+ /*
+ Escapes a string when it contains special characters (RFC3501)
+
+ @param string $string IMAP string
+ @param boolean $force_quotes Forces string quoting (for atoms)
+
+ @return string String atom, quoted-string or string literal
+ @todo lists
+ */
+ static function _escape($string, $force_quotes=false) {
+ if ($string === null) {
+ return 'NIL';
+ }
+ if ($string === '') {
+ return '""';
+ }
+ // atom-string (only safe characters)
+ if (!$force_quotes && !preg_match('/[\x00-\x20\x22\x28-\x2A\x5B-\x5D\x7B\x7D\x80-\xFF]/', $string)) {
+ return $string;
+ }
+ // quoted-string
+ if (!preg_match('/[\r\n\x00\x80-\xFF]/', $string)) {
+ return '"' . addcslashes($string, '\\"') . '"';
+ }
+
+ // literal-string
+ return sprintf("{%d}\r\n%s", strlen($string), $string);
+ }
+
+ static function r_implode($element) {
+ $string = '';
+
+ if (is_array($element)) {
+ reset($element);
+ while (list($key, $value) = each($element)) {
+ $string .= ' ' . self::r_implode($value);
+ }
+ }
+ else {
+ return $element;
+ }
+
+ return '(' . trim($string) . ')';
+ }
+
+ static function _unescape($string) {
+ return stripslashes($string);
+ }
+
+ }
+
+ /* Backwards compatibility with Roundcube caching storing the class
+ name in the cache...
+ */
+ class rcube_mail_header extends Net_IMAP4_MessageHeader {
+ }
+
+?> \ No newline at end of file
diff --git a/lib/Net/IMAP4/MessageHeader.php b/lib/Net/IMAP4/MessageHeader.php
new file mode 100644
index 0000000..8c1f4c6
--- /dev/null
+++ b/lib/Net/IMAP4/MessageHeader.php
@@ -0,0 +1,34 @@
+<?php
+
+ /*
+ Struct representing an e-mail message header
+
+ @package Mail
+ @author Aleksander Machniak <alec@alec.pl>
+ */
+ class Net_IMAP4_MessageHeader {
+ public $id;
+ public $uid;
+ public $subject;
+ public $from;
+ public $to;
+ public $cc;
+ public $replyto;
+ public $in_reply_to;
+ public $date;
+ public $messageID;
+ public $size;
+ public $encoding;
+ public $charset;
+ public $ctype;
+ public $timestamp;
+ public $bodystructure;
+ public $internaldate;
+ public $references;
+ public $priority;
+ public $mdn_to;
+ public $others = array();
+ public $flags = array();
+ }
+
+?>