--- /dev/null
+<?php
+/**
+ * Horde_Imap_Client_Socket_Pop3 provides an interface to a POP3 server using
+ * PHP functions.
+ * This driver is an abstraction layer allowing POP3 commands to be used based
+ * on the IMAP equivalents.
+ *
+ * Caching is not supported in this driver.
+ *
+ * Optional Parameters: NONE
+ *
+ * This driver implements the following POP3-related RFCs:
+ * STD 53/RFC 1939 - POP3 specification
+ * RFC 2195 - CRAM-MD5 authentication
+ * RFC 2449 - POP3 extension mechanism
+ * RFC 2595/4616 - PLAIN authentication
+ * RFC 1734/5034 - POP3 SASL
+ *
+ * TODO (or not necessary?):
+ * RFC 3206 - AUTH/SYS response codes
+ *
+ * ---------------------------------------------------------------------------
+ *
+ * Originally based on the PEAR Net_POP3 package (version 1.3.6) by:
+ * Richard Heyes <richard@phpguru.org>
+ * Damian Fernandez Sosa <damlists@cnba.uba.ar>
+ *
+ * Copyright (c) 2002, Richard Heyes
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * o Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * o Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * o The names of the authors may not be used to endorse or promote
+ * products derived from this software without specific prior written
+ * permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ---------------------------------------------------------------------------
+ *
+ * Copyright 2009 The Horde Project (http://www.horde.org/)
+ *
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
+ *
+ * @author Michael Slusarz <slusarz@horde.org>
+ * @category Horde
+ * @package Horde_Imap_Client
+ */
+class Horde_Imap_Client_Socket_Pop3 extends Horde_Imap_Client_Base
+{
+ /**
+ * The socket connection to the POP3 server.
+ *
+ * @var resource
+ */
+ protected $_stream = null;
+
+ /**
+ * Constructs a new object.
+ *
+ * @param array $params A hash containing configuration parameters.
+ */
+ public function __construct($params)
+ {
+ if (empty($params['port'])) {
+ $params['port'] = ($params['secure'] == 'ssl') ? 995 : 110;
+ }
+
+ parent::__construct($params);
+
+ // Disable caching.
+ $this->_params['cache'] = array('fields' => array());
+ }
+
+ /**
+ * Do cleanup prior to serialization and provide a list of variables
+ * to serialize.
+ */
+ public function __sleep()
+ {
+ $this->logout();
+ parent::__sleep();
+ return array_diff(array_keys(get_class_vars(__CLASS__)), array('encryptKey'));
+ }
+
+ /**
+ * Get CAPABILITY info from the server.
+ *
+ * @return array The capability array.
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _capability()
+ {
+ $this->_connect();
+
+ $this->_init['capability'] = array();
+
+ try {
+ $this->_sendLine('CAPA');
+
+ foreach ($this->_getMultiline(true) as $val) {
+ $prefix = explode(' ', $val);
+
+ $this->_init['capability'][strtoupper($prefix[0])] = (count($prefix) > 1)
+ ? array_slice($prefix, 1)
+ : true;
+ }
+ } catch (Horde_Imap_Client_Exception $e) {
+ // TODO
+ }
+
+ return $this->_init['capability'];
+ }
+
+ /**
+ * Send a NOOP command.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _noop()
+ {
+ $this->_sendLine('NOOP');
+ }
+
+ /**
+ * Get the NAMESPACE information from the server.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getNamespaces()
+ {
+ throw new Horde_Imap_Client_Exception('IMAP namespaces not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Return a list of alerts that MUST be presented to the user (RFC 3501
+ * [7.1]).
+ *
+ * @return array An array of alert messages.
+ */
+ public function alerts()
+ {
+ return array();
+ }
+
+ /**
+ * Login to the server.
+ *
+ * @return boolean Return true if global login tasks should be run.
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _login()
+ {
+ $this->_connect();
+
+ // Switch to secure channel if using TLS.
+ if (!$this->_isSecure &&
+ ($this->_params['secure'] == 'tls')) {
+ // Switch over to a TLS connection.
+ if (!$this->queryCapability('STLS')) {
+ throw new Horde_Imap_Client_Exception('Could not open secure TLS connection to the POP3 server - server does not support TLS.');
+ }
+
+ $this->_sendLine('STLS');
+
+ $old_error = error_reporting(0);
+ $res = stream_socket_enable_crypto($this->_stream, true, STREAM_CRYPTO_METHOD_TLS_CLIENT);
+ error_reporting($old_error);
+
+ if (!$res) {
+ $this->logout();
+ throw new Horde_Imap_Client_Exception('Could not open secure TLS connection to the POP3 server.');
+ }
+
+ // Expire cached CAPABILITY information (RFC 3501 [6.2.1])
+ unset($this->_init['capability']);
+
+ $this->_isSecure = true;
+ }
+
+ if (empty($this->_init['authmethod'])) {
+ $auth_mech = ($sasl = $this->queryCapability('SASL'))
+ ? $sasl
+ : array();
+
+ if (isset($this->_temp['pop3timestamp'])) {
+ $auth_mech[] = 'APOP';
+ }
+
+ $auth_mech[] = 'USER';
+ } else {
+ $auth_mech = array($this->_init['authmethod']);
+ }
+
+ foreach ($auth_mech as $method) {
+ try {
+ $this->_tryLogin($method);
+ $this->_init['authmethod'] = $method;
+ return true;
+ } catch (Horde_Imap_Client_Exception $e) {
+ if (!empty($this->_init['authmethod'])) {
+ unset($this->_init['authmethod']);
+ return $this->login();
+ }
+ }
+ }
+
+ throw new Horde_Imap_Client_Exception('POP3 server denied authentication.');
+ }
+
+ /**
+ * Connects to the server.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _connect()
+ {
+ if (!is_null($this->_stream)) {
+ return;
+ }
+
+ if (!empty($this->_params['secure']) && !extension_loaded('openssl')) {
+ throw new Horde_Imap_Client_Exception('Secure connections require the PHP openssl extension.');
+ }
+
+ switch ($this->_params['secure']) {
+ case 'ssl':
+ $conn = 'ssl://';
+ $this->_isSecure = true;
+ break;
+
+ case 'tls':
+ default:
+ $conn = 'tcp://';
+ break;
+ }
+
+ $old_error = error_reporting(0);
+ $this->_stream = stream_socket_client($conn . $this->_params['hostspec'] . ':' . $this->_params['port'], $error_number, $error_string, $this->_params['timeout']);
+ error_reporting($old_error);
+
+ if ($this->_stream === false) {
+ $this->_stream = null;
+ $this->_isSecure = false;
+ throw new Horde_Imap_Client_Exception('Error connecting to POP3 server: [' . $error_number . '] ' . $error_string, Horde_Imap_Client_Exception::SERVER_CONNECT);
+ }
+
+ stream_set_timeout($this->_stream, $this->_params['timeout']);
+
+ $line = $this->_getLine();
+
+ // Check for string matching APOP timestamp
+ if (preg_match('/<.+@.+>/U', $line['line'], $matches)) {
+ $this->_temp['pop3timestamp'] = $matches[0];
+ }
+ }
+
+ /**
+ * Authenticate to the IMAP server.
+ *
+ * @param string $method IMAP login method.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _tryLogin($method)
+ {
+ switch ($method) {
+ case 'CRAM-MD5':
+ // RFC 5034
+ if (!class_exists('Auth_SASL')) {
+ throw new Horde_Imap_Client_Exception('The Auth_SASL package is required for CRAM-MD5 authentication');
+ }
+
+ $challenge = $this->_sendLine('AUTH CRAM-MD5');
+
+ $auth_sasl = Auth_SASL::factory('crammd5');
+ $response = base64_encode($auth_sasl->getResponse($this->_params['username'], $this->_params['password'], base64_decode(substr($challenge['line'], 2))));
+ $this->_sendLine($response, array('debug' => '[CRAM-MD5 Response]'));
+ break;
+
+ case 'DIGEST-MD5':
+ // RFC 5034
+ if (!class_exists('Auth_SASL')) {
+ throw new Horde_Imap_Client_Exception('The Auth_SASL package is required for DIGEST-MD5 authentication');
+ }
+
+ $challenge = $this->_sendLine('AUTH DIGEST-MD5');
+
+ $auth_sasl = Auth_SASL::factory('digestmd5');
+ $response = base64_encode($auth_sasl->getResponse($this->_params['username'], $this->_params['password'], base64_decode(substr($challenge['line'], 2)), $this->_params['hostspec'], 'pop3'));
+
+ $sresponse = $this->_sendLine($response, array('debug' => '[DIGEST-MD5 Response]'));
+ if (stripos(base64_decode(substr($sresponse['line'], 2)), 'rspauth=') === false) {
+ throw new Horde_Imap_Client_Exception('Unexpected response from server to Digest-MD5 response.');
+ }
+
+ /* POP3 doesn't use protocol's third step. */
+ $this->_sendLine('');
+ break;
+
+ case 'LOGIN':
+ // RFC 5034
+ $this->_sendLine('AUTH LOGIN');
+ $this->_sendLine(base64_encode($this->_params['username']));
+ $this->_sendLine(base64_encode($this->_params['password']));
+ break;
+
+ case 'PLAIN':
+ // RFC 5034
+ $this->_sendLine('AUTH PLAIN ' . base64_encode(chr(0) . $this->_params['username'] . chr(0) . $this->_params['password']));
+ break;
+
+ case 'APOP':
+ // RFC 1939 [7]
+ $this->_sendLine('APOP ' . $this->_params['username'] . ' ' . hash('md5', $this->_timestamp . $pass));
+ break;
+
+ case 'USER':
+ // RFC 1939 [7]
+ $this->_sendLine('USER ' . $this->_params['username']);
+ $this->_sendLine('PASS ' . $this->_params['password']);
+ break;
+ }
+ }
+
+ /**
+ * Logout from the server (see RFC 3501 [6.1.3]).
+ */
+ protected function _logout()
+ {
+ if (!is_null($this->_stream)) {
+ try {
+ $this->_sendLine('QUIT');
+ } catch (Horde_Imap_Client_Exception $e) {}
+ fclose($this->_stream);
+ $this->_stream = null;
+ }
+ }
+
+ /**
+ * Send ID information to the IMAP server (RFC 2971).
+ *
+ * @param array $info The information to send to the server.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _sendID($info)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP ID command not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Return ID information from the IMAP server (RFC 2971).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getID()
+ {
+ throw new Horde_Imap_Client_Exception('IMAP ID command not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Sets the preferred language for server response messages (RFC 5255).
+ *
+ * @param array $info The preferred list of languages.
+ *
+ * @return string The language accepted by the server, or null if the
+ * default language is used.
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _setLanguage($langs)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP LANGUAGE extension not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Gets the preferred language for server response messages (RFC 5255).
+ *
+ * @param array $list If true, return the list of available languages.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getLanguage($list)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP LANGUAGE extension not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Open a mailbox.
+ *
+ * @param string $mailbox The mailbox to open (UTF7-IMAP).
+ * @param integer $mode The access mode.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _openMailbox($mailbox, $mode)
+ {
+ if (strcasecmp($mailbox, 'INBOX') !== 0) {
+ throw new Horde_Imap_Client_Exception('Mailboxes other than INBOX not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ $this->login();
+ }
+
+ /**
+ * Create a mailbox.
+ *
+ * @param string $mailbox The mailbox to create (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _createMailbox($mailbox)
+ {
+ throw new Horde_Imap_Client_Exception('Creating mailboxes not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Delete a mailbox.
+ *
+ * @param string $mailbox The mailbox to delete (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _deleteMailbox($mailbox)
+ {
+ throw new Horde_Imap_Client_Exception('Deleting mailboxes not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Rename a mailbox.
+ *
+ * @param string $old The old mailbox name (UTF7-IMAP).
+ * @param string $new The new mailbox name (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _renameMailbox($old, $new)
+ {
+ throw new Horde_Imap_Client_Exception('Renaming mailboxes not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Manage subscription status for a mailbox.
+ *
+ * @param string $mailbox The mailbox to [un]subscribe to (UTF7-IMAP).
+ * @param boolean $subscribe True to subscribe, false to unsubscribe.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _subscribeMailbox($mailbox, $subscribe)
+ {
+ throw new Horde_Imap_Client_Exception('Mailboxes other than INBOX not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Obtain a list of mailboxes matching a pattern.
+ *
+ * @param string $pattern The mailbox search pattern.
+ * @param integer $mode Which mailboxes to return.
+ * @param array $options Additional options.
+ *
+ * @return array See Horde_Imap_Client_Base::listMailboxes().
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _listMailboxes($pattern, $mode, $options)
+ {
+ $tmp = array('mailbox' => 'INBOX');
+
+ if (!empty($options['attributes'])) {
+ $tmp['attributes'] = array();
+ }
+ if (!empty($options['delimiter'])) {
+ $tmp['delimiter'] = '';
+ }
+
+ return array('INBOX' => $tmp);
+ }
+
+ /**
+ * Obtain status information for a mailbox.
+ *
+ * @param string $mailbox The mailbox to query (UTF7-IMAP).
+ * @param string $flags A bitmask of information requested from the
+ * server. This driver only supports the options
+ * listed under Horde_Imap_Client::STATUS_ALL.
+ *
+ * @return array See Horde_Imap_Client_Base::status().
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _status($mailbox, $flags)
+ {
+ $this->openMailbox($mailbox);
+
+ // This driver only supports the base flags given by c-client.
+ if (($flags & Horde_Imap_Client::STATUS_FIRSTUNSEEN) ||
+ ($flags & Horde_Imap_Client::STATUS_FLAGS) ||
+ ($flags & Horde_Imap_Client::STATUS_PERMFLAGS) ||
+ ($flags & Horde_Imap_Client::STATUS_HIGHESTMODSEQ) ||
+ ($flags & Horde_Imap_Client::STATUS_UIDNOTSTICKY)) {
+ throw new Horde_Imap_Client_Exception('Improper status request on POP3 server.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ $ret = array();
+
+ if ($flags & Horde_Imap_Client::STATUS_MESSAGES) {
+ $res = $this->_pop3Cache('stat');
+ $ret['messages'] = $res['msgs'];
+ }
+
+ if ($flags & Horde_Imap_Client::STATUS_RECENT) {
+ $res = $this->_pop3Cache('stat');
+ $ret['recent'] = $res['msgs'];
+ }
+
+ if ($flags & Horde_Imap_Client::STATUS_UIDNEXT) {
+ $res = $this->_pop3Cache('stat');
+ $ret['uidnext'] = $res['msgs'] + 1;
+ }
+
+ if ($flags & Horde_Imap_Client::STATUS_UIDVALIDITY) {
+ $ret['uidvalidity'] = microtime(true);
+ }
+
+ if ($flags & Horde_Imap_Client::STATUS_UNSEEN) {
+ $ret['unseen'] = 0;
+ }
+
+ return $ret;
+ }
+
+ /**
+ * Append a message to the mailbox.
+ *
+ * @param array $mailbox The mailboxes to append the messages to
+ * (UTF7-IMAP).
+ * @param array $data The message data.
+ * @param array $options Additional options.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _append($mailbox, $data, $options)
+ {
+ throw new Horde_Imap_Client_Exception('Appending messages not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Request a checkpoint of the currently selected mailbox.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _check()
+ {
+ $this->noop();
+ }
+
+ /**
+ * Close the connection to the currently selected mailbox, optionally
+ * expunging all deleted messages (RFC 3501 [6.4.2]).
+ *
+ * @param array $options Additional options.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _close($options)
+ {
+ if (!empty($options['expunge'])) {
+ $this->logout();
+ }
+ }
+
+ /**
+ * Expunge all deleted messages from the given mailbox.
+ *
+ * @param array $options Additional options. 'ids' and 'sequence' have
+ * no effect in this driver.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _expunge($options)
+ {
+ $this->logout();
+ }
+
+ /**
+ * Search a mailbox.
+ *
+ * @param object $query The search string.
+ * @param array $options Additional options.
+ *
+ * @return array An array of UIDs (default) or an array of message
+ * sequence numbers (if 'sequence' is true).
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _search($query, $options)
+ {
+ // Only support a single query: an ALL search sorted by arrival.
+ if (($options['_query']['query'] != 'ALL') ||
+ (!empty($options['sort']) &&
+ ((count($options['sort']) > 1) || (reset($options['sort']) != Horde_Imap_Client::SORT_ARRIVAL)))) {
+ throw new Horde_Imap_Client_Exception('Server search not supported on POP3 server.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ $status = $this->status($this->_selected, Horde_Imap_Client::STATUS_MESSAGES);
+ $res = range(1, $status['messages']);
+
+ if (empty($options['sequence'])) {
+ $tmp = array();
+ $uidllist = $this->_pop3Cache('uidl');
+ foreach ($res as $val) {
+ $tmp[] = $uidllist[$val];
+ }
+ $res = $tmp;
+ }
+
+ $ret = array();
+ foreach ($options['results'] as $val) {
+ switch ($val) {
+ case Horde_Imap_Client::SORT_RESULTS_COUNT:
+ $ret['count'] = count($res);
+ break;
+
+ case Horde_Imap_Client::SORT_RESULTS_MATCH:
+ $ret[empty($options['sort']) ? 'match' : 'sort'] = $res;
+ break;
+
+ case Horde_Imap_Client::SORT_RESULTS_MAX:
+ $ret['max'] = empty($res) ? null : max($res);
+ break;
+
+ case Horde_Imap_Client::SORT_RESULTS_MIN:
+ $ret['min'] = empty($res) ? null : min($res);
+ break;
+ }
+ }
+
+ return $ret;
+ }
+
+ /**
+ * Set the comparator to use for searching/sorting (RFC 5255).
+ *
+ * @param string $comparator The comparator string (see RFC 4790 [3.1] -
+ * "collation-id" - for format). The reserved
+ * string 'default' can be used to select
+ * the default comparator.
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _setComparator($comparator)
+ {
+ throw new Horde_Imap_Client_Exception('Search comparators not supported on POP3 server.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Get the comparator used for searching/sorting (RFC 5255).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getComparator()
+ {
+ throw new Horde_Imap_Client_Exception('Search comparators not supported on POP3 server.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Thread sort a given list of messages (RFC 5256).
+ *
+ * @param array $options Additional options.
+ *
+ * @return array See Horde_Imap_Client_Base::thread().
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _thread($options)
+ {
+ throw new Horde_Imap_Client_Exception('Server threading not supported on POP3 server.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Fetch message data.
+ *
+ * @param array $criteria The fetch criteria.
+ * @param array $options Additional options.
+ *
+ * @return array See self::fetch().
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _fetch($criteria, $options)
+ {
+ // Already guaranteed to be logged in here
+
+ // These options are not supported by this driver.
+ if (!empty($options['changedsince']) ||
+ !empty($options['vanished']) ||
+ (reset($options['ids']) == Horde_Imap_Client::USE_SEARCHRES)) {
+ throw new Horde_Imap_Client_Exception('Fetch options not supported on POP3 server.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ // Ignore 'sequence' - IDs will always be the message number.
+ $use_seq = !empty($options['sequence']);
+ $seq_ids = $this->_getSeqIds(empty($options['ids']) ? array() : $options['ids'], $use_seq);
+ if (empty($seq_ids)) {
+ return array();
+ }
+
+ $ret = array_combine($seq_ids, array_fill(0, count($seq_ids), array()));
+
+ foreach ($criteria as $type => $c_val) {
+ if (!is_array($c_val)) {
+ $c_val = array();
+ }
+
+ switch ($type) {
+ case Horde_Imap_Client::FETCH_FULLMSG:
+ foreach ($seq_ids as $id) {
+ if (($tmp = $this->_pop3Cache('msg', $id)) &&
+ isset($c_val['start']) &&
+ !empty($c_val['length'])) {
+ $ret[$id]['fullmsg'] = substr($tmp, $c_val['start'], $c_val['length']);
+ } else {
+ $ret[$id]['fullmsg'] = $tmp;
+ }
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_HEADERTEXT:
+ case Horde_Imap_Client::FETCH_BODYTEXT:
+ case Horde_Imap_Client::FETCH_MIMEHEADER:
+ case Horde_Imap_Client::FETCH_BODYPART:
+ foreach ($c_val as $val) {
+ switch ($type) {
+ case Horde_Imap_Client::FETCH_HEADERTEXT:
+ // Ignore 'peek' option
+ $label = 'headertext';
+ $rawtype = 'header';
+
+ if (empty($val['id'])) {
+ $val['id'] = 0;
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_BODYTEXT:
+ $label = 'bodytext';
+ $rawtype = 'body';
+
+ if (empty($val['id'])) {
+ $val['id'] = 0;
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_MIMEHEADER:
+ $label = 'mimeheader';
+ $rawtype = 'header';
+
+ if (empty($val['id'])) {
+ throw new Horde_Imap_Client_Exception('Need a MIME ID when retrieving a MIME header part.');
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_BODYPART:
+ // Ignore 'decode' parameter
+ $label = 'bodypart';
+ $rawtype = 'body';
+
+ if (empty($val['id'])) {
+ throw new Horde_Imap_Client_Exception('Need a MIME ID when retrieving a MIME body part.');
+ }
+ break;
+ }
+
+ foreach ($seq_ids as $id) {
+ if (!isset($ret[$id][$label])) {
+ $ret[$id][$label] = array();
+ }
+
+ try {
+ /* Special case: Message header can be retrieved
+ * via TOP, if the command is available. */
+ if (($val['id'] == 0) &&
+ ($type == Horde_Imap_Client::FETCH_HEADERTEXT)) {
+ $tmp = $this->_pop3Cache('hdr', $id);
+ } else {
+ $tmp = Horde_Mime_Part::getRawPartText($this->_pop3Cache('msg', $id), $rawtype, $val['id']);
+ }
+
+ if (isset($val['start']) && !empty($val['length'])) {
+ $tmp = substr($tmp, $val['start'], $val['length']);
+ }
+
+ if (!empty($val['parse']) &&
+ ($type == Horde_Imap_Client::FETCH_HEADERTEXT)) {
+ $tmp = Horde_Mime_Headers::parseHeaders($tmp);
+ }
+ } catch (Horde_Mime_Exception $e) {
+ $tmp = false;
+ }
+
+ $ret[$id][$label][$val['id']] = $tmp;
+ }
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_HEADERS:
+ // TODO
+ break;
+
+ case Horde_Imap_Client::FETCH_STRUCTURE:
+ foreach ($seq_ids as $id) {
+ if ($tmp = $this->_pop3Cache('msg', $id)) {
+ try {
+ $tmp = Horde_Mime_Part::parseMessage($tmp, array('structure' => empty($c_val['parse'])));
+ } catch (Horde_Exception $e) {
+ $tmp = false;
+ }
+ }
+ $ret[$id]['structure'] = $tmp;
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_ENVELOPE:
+ foreach ($seq_ids as $id) {
+ $tmp = $this->_pop3Cache('hdrob', $id);
+ $ret[$id]['envelope'] = array(
+ 'date' => $tmp->getValue('date'),
+ 'subject' => $tmp->getValue('subject'),
+ 'from' => $tmp->getOb('from'),
+ 'reply-to' => $tmp->getOb('reply-to'),
+ 'to' => $tmp->getOb('to'),
+ 'cc' => $tmp->getOb('cc'),
+ 'bcc' => $tmp->getOb('bcc'),
+ 'in-reply-to' => $tmp->getValue('in-reply-to'),
+ 'message-id' => $tmp->getValue('message-id')
+ );
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_FLAGS:
+ foreach ($seq_ids as $id) {
+ $ret[$id]['flags'] = array();
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_DATE:
+ foreach ($seq_ids as $id) {
+ $tmp = $this->_pop3Cache('hdrob', $id);
+ $ret[$id]['date'] = new DateTime($tmp->getValue('date'));
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_SIZE:
+ $sizelist = $this->_pop3Cache('size');
+ foreach ($seq_ids as $id) {
+ $ret[$id]['size'] = $sizelist[$id];
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_SEQ:
+ foreach ($seq_ids as $id) {
+ $ret[$id]['seq'] = $id;
+ }
+ break;
+
+ case Horde_Imap_Client::FETCH_UID:
+ $uidllist = $this->_pop3Cache('uidl');
+ foreach ($seq_ids as $id) {
+ $ret[$id]['uid'] = isset($uidllist[$id])
+ ? $uidllist[$id]
+ : false;
+ }
+ break;
+ }
+ }
+
+ if ($use_seq) {
+ return $ret;
+ }
+
+ $tmp = array();
+ $uidllist = $this->_pop3Cache('uidl');
+ foreach (array_keys($ret) as $key) {
+ $tmp[$uidllist[$key]] = $ret[$key];
+ }
+
+ return $tmp;
+ }
+
+ /**
+ * Retrieve locally cached message data.
+ *
+ * @param string $type Either 'hdr', 'hdrob', 'msg', 'size', 'stat',
+ * or 'uidl'.
+ * @param integer $index The message index.
+ *
+ * @return mixed The cached data.
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _pop3Cache($type, $index = null)
+ {
+ if (isset($this->_temp['pop3cache'][$index][$type])) {
+ return $this->_temp['pop3cache'][$index][$type];
+ }
+
+ switch ($type) {
+ case 'hdr':
+ try {
+ $resp = $this->_sendLine('TOP ' . $index . ' 0');
+ $data = $this->_getMultiline();
+ } catch (Horde_Imap_Client_Exception $e) {
+ $data = Horde_Mime_Part::getRawPartText($this->_pop3Cache('msg', $index), 'header', 0);
+ }
+ break;
+
+ case 'hdrob':
+ $data = Horde_Mime_Headers::parseHeaders($this->_pop3Cache('hdr', $index));
+ break;
+
+ case 'msg':
+ $resp = $this->_sendLine('RETR ' . $index);
+ $data = $this->_getMultiline();
+ break;
+
+ case 'size':
+ case 'uidl':
+ $data = array();
+ try {
+ $this->_sendLine(($type == 'size') ? 'LIST' : 'UIDL');
+ foreach ($this->_getMultiline(true) as $val) {
+ $resp_data = explode(' ', $val, 2);
+ $data[$resp_data[0]] = $resp_data[1];
+ }
+ } catch (Horde_Imap_Client_Exception $e) {}
+ break;
+
+ case 'stat':
+ $resp = $this->_sendLine('STAT');
+ $resp_data = explode(' ', $resp['line'], 2);
+ $data = array('msgs' => $resp_data[0], 'size' => $resp_data[1]);
+ break;
+ }
+
+ $this->_temp['pop3cache'][$index][$type] = $data;
+
+ return $data;
+ }
+
+ /**
+ * Store message flag data.
+ *
+ * @param array $options Additional options.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _store($options)
+ {
+ $delete = $reset = false;
+
+ /* Only support deleting/undeleting messages. */
+ if (isset($options['replace'])) {
+ $delete = (bool) (count(array_intersect($options['replace'], array('\\deleted'))));
+ $reset = !$delete;
+ } else {
+ if (!empty($options['add'])) {
+ $delete = (bool) (count(array_intersect($options['add'], array('\\deleted'))));
+ }
+
+ if (!empty($options['remove'])) {
+ $reset = !(bool) (count(array_intersect($options['remove'], array('\\deleted'))));
+ }
+ }
+
+ if ($reset) {
+ $this->_sendLine('RSET');
+ } elseif ($delete) {
+ $seq_ids = $this->_getSeqIds(empty($options['ids']) ? array() : $options['ids'], !empty($options['sequence']));
+ foreach ($seq_ids as $id) {
+ try {
+ $this->_sendLine('DELE ' . $id);
+ } catch (Horde_Imap_Client_Exception $e) {}
+ }
+ }
+ }
+
+ /**
+ * Copy messages to another mailbox.
+ *
+ * @param string $dest The destination mailbox (UTF7-IMAP).
+ * @param array $options Additional options.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _copy($dest, $options)
+ {
+ throw new Horde_Imap_Client_Exception('Copying messages not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Set quota limits.
+ *
+ * @param string $root The quota root (UTF7-IMAP).
+ * @param array $options Additional options.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _setQuota($root, $options)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP quotas not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Get quota limits.
+ *
+ * @param string $root The quota root (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getQuota($root)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP quotas not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Get quota limits for a mailbox.
+ *
+ * @param string $mailbox A mailbox (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getQuotaRoot($mailbox)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP quotas not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Set ACL rights for a given mailbox/identifier.
+ *
+ * @param string $mailbox A mailbox (UTF7-IMAP).
+ * @param string $identifier The identifier to alter (UTF7-IMAP).
+ * @param array $options Additional options.
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _setACL($mailbox, $identifier, $options)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP ACLs not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Get ACL rights for a given mailbox.
+ *
+ * @param string $mailbox A mailbox (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getACL($mailbox)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP ACLs not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Get ACL rights for a given mailbox/identifier.
+ *
+ * @param string $mailbox A mailbox (UTF7-IMAP).
+ * @param string $identifier The identifier (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _listACLRights($mailbox, $identifier)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP ACLs not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /**
+ * Get the ACL rights for the current user for a given mailbox.
+ *
+ * @param string $mailbox A mailbox (UTF7-IMAP).
+ *
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getMyACLRights($mailbox)
+ {
+ throw new Horde_Imap_Client_Exception('IMAP ACLs not supported on POP3 servers.', Horde_Imap_Client_Exception::POP3_NOTSUPPORTED);
+ }
+
+ /* Internal functions. */
+
+ /**
+ * Perform a command on the server. A connection to the server must have
+ * already been made.
+ *
+ * @param string $query The command to execute.
+ * @param array $options Additional options:
+ * <pre>
+ * 'debug' - (string) When debugging, send this string instead of the
+ * actual command/data sent.
+ * DEFAULT: Raw data output to debug stream.
+ * </pre>
+ */
+ protected function _sendLine($query, $options = array())
+ {
+ if ($this->_debug) {
+ fwrite($this->_debug, 'C (' . microtime(true) . '): ' . (empty($options['debug']) ? $query : $options['debug']) . "\n");
+ }
+
+ fwrite($this->_stream, $query . "\r\n");
+
+ return $this->_getLine();
+ }
+
+ /**
+ * Gets a line from the stream and parses it.
+ *
+ * @return array An array with the following keys:
+ * <pre>
+ * 'line' - (string) The server response text.
+ * 'response' - (string) Either 'OK', 'END', '+', or ''.
+ * </pre>
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getLine()
+ {
+ $ob = array('line' => '', 'response' => '');
+
+ if (feof($this->_stream)) {
+ $this->logout();
+ throw new Horde_Imap_Client_Exception('POP3 Server closed the connection unexpectedly.', Horde_Imap_Client_Exception::IMAP_DISCONNECT);
+ }
+
+ $read = rtrim(fgets($this->_stream));
+ if (empty($read)) {
+ return;
+ }
+
+ if ($this->_debug) {
+ fwrite($this->_debug, 'S (' . microtime(true) . '): ' . $read . "\n");
+ }
+
+ $prefix = explode(' ', $read, 2);
+
+ switch ($prefix[0]) {
+ case '+OK':
+ $ob['response'] = 'OK';
+ if (isset($prefix[1])) {
+ $ob['line'] = $prefix[1];
+ }
+ break;
+
+ case '-ERR':
+ throw new Horde_Imap_Client_Exception('POP3 Error: ' . isset($prefix[1]) ? $prefix[1] : 'no error message');
+
+ case '.':
+ $ob['response'] = 'END';
+ break;
+
+ case '+':
+ $ob['response'] = '+';
+ break;
+
+ default:
+ $ob['line'] = $read;
+ break;
+ }
+
+ return $ob;
+ }
+
+ /**
+ * Obtain multiline input.
+ *
+ * @param boolean $retarray Return an arrray?
+ *
+ * @return mixed An array if $retarray is true, a string otherwise.
+ * @throws Horde_Imap_Client_Exception
+ */
+ protected function _getMultiline($retarray = false)
+ {
+ $data = $retarray ? array() : '';
+
+ do {
+ $line = $this->_getLine();
+ if (empty($line['response'])) {
+ if (substr($line['line'], 0, 2) == '..') {
+ $line['line'] = substr($line['line'], 1);
+ }
+
+ if ($retarray) {
+ $data[] = $line['line'];
+ } else {
+ $data .= $line['line'] . "\r\n";
+ }
+ }
+ } while ($line['response'] != 'END');
+
+ return $retarray
+ ? $data
+ : substr($data, 0, -2);
+ }
+
+ /**
+ * Returns a list of sequence IDs.
+ *
+ * @param array $ids The ID list.
+ * @param boolean $seq Are the IDs sequence IDs?
+ *
+ * @return array A list of sequence IDs.
+ */
+ protected function _getSeqIds($ids, $seq)
+ {
+ if (empty($ids)) {
+ $status = $this->status($this->_selected, Horde_Imap_Client::STATUS_MESSAGES);
+ return range(1, $status['messages']);
+ } elseif ($seq) {
+ return $ids;
+ } else {
+ return array_keys(array_intersect($this->_pop3Cache('uidl'), $ids));
+ }
+ }
+
+}
projects / horde.git / commitdiff