Author: artdaw Date: 2008-11-17 07:50:00 -0500 (Mon, 17 Nov 2008) New Revision: 11188 Added: trunk/docs/migrationguide/en/src/main/resources/script/swift_lib/Swift/Authenticator/PopB4Smtp/Pop3Connection.php Log: https://jira.jboss.org/jira/browse/RF-4644 - feedback was fixed Added: trunk/docs/migrationguide/en/src/main/resources/script/swift_lib/Swift/Authenticator/PopB4Smtp/Pop3Connection.php =================================================================== --- trunk/docs/migrationguide/en/src/main/resources/script/swift_lib/Swift/Authenticator/PopB4Smtp/Pop3Connection.php (rev 0) +++ trunk/docs/migrationguide/en/src/main/resources/script/swift_lib/Swift/Authenticator/PopB4Smtp/Pop3Connection.php 2008-11-17 12:50:00 UTC (rev 11188) @@ -0,0 +1,176 @@ +<?php + +/** + * Swift Mailer PopB4Smtp Pop3 Connection component + * Please read the LICENSE file + * @author Chris Corbyn <chris(a)w3style.co.uk&gt; + * @package Swift_Authenticator + * @license GNU Lesser General Public License + */ + +require_once dirname(__FILE__) . "/../../ClassLoader.php"; + +/** + * Swift PopB4Smtp Authenticator Connection Component for the POP3 server + * Provides a I/O wrapper for the POP3 connection + * @package Swift_Authenticator + * @author Chris Corbyn <chris(a)w3style.co.uk&gt; + */ +class Swift_Authenticator_PopB4Smtp_Pop3Connection +{ + /** + * Constant for no encyption + */ + const ENC_OFF = 0; + /** + * Constant for SSL encryption + */ + const ENC_SSL = 1; + /** + * The server to connect to (IP or FQDN) + * @var string + */ + protected $server = null; + /** + * The port to connect to + * @var int + */ + protected $port = null; + /** + * The open connection resource from fsockopen() + * @var resource + */ + protected $handle = null; + + /** + * Constructor + * @param string The name of the POP3 server + * @param int The port for the POP3 service + * @param int The level of encryption to use + */ + public function __construct($server="localhost", $port=110, $encryption=0) + { + $this->setServer($server); + $this->setPort($port); + $this->setEncryption($encryption); + } + /** + * Set the server name + * @param string The IP or FQDN of the POP3 server + */ + public function setServer($server) + { + $this->server = (string) $server; + } + /** + * Set the port number for the POP3 server + * @param int + */ + public function setPort($port) + { + $this->port = (int) $port; + } + /** + * Get the server name + * @return string + */ + public function getServer() + { + return $this->server; + } + /** + * Get the remote port number + * @return int + */ + public function getPort() + { + return $this->port; + } + /** + * Set the level of enryption to use (see ENC_OFF or ENC_SSL) + * @param int The constant for the encryption level + */ + public function setEncryption($enc) + { + $this->encryption = (int) $enc; + } + /** + * Get the current encryption level set (corresponds to ENC_SSL or ENC_OFF) + * @return int + */ + public function getEncryption() + { + return $this->encryption; + } + /** + * Check if the response is a +OK response + * @throws Swift_ConnectionException Upon bad response + */ + public function assertOk($line) + { + if (substr($line, 0, 3) != "+OK") + { + Swift_ClassLoader::load("Swift_ConnectionException"); + throw new Swift_ConnectionException("The POP3 server did not suitably respond with a +OK response. " . + "[" . $line . "]"); + } + } + /** + * Try to open the connection + * @throws Swift_ConnectionException If the connection will not start + */ + public function start() + { + $url = $this->getServer(); + if ($this->getEncryption() == self::ENC_SSL) $url = "ssl://" . $url; + + if ((false === $this->handle = fsockopen($url, $this->getPort(), $errno, $errstr, $timeout))) + { + Swift_ClassLoader::load("Swift_ConnectionException"); + throw new Swift_ConnectionException("The POP3 connection failed to start. The error string returned from fsockopen() is [" . $errstr . "] #" . $errno); + } + } + /** + * Try to close the connection + * @throws Swift_ConnectionException If the connection won't close + */ + public function stop() + { + if ($this->handle !== null) + { + if (false === fclose($this->handle)) + { + Swift_ClassLoader::load("Swift_ConnectionException"); + throw new Swift_ConnectionException("The POP3 connection did not close successfully."); + } + } + $this->handle = null; + } + /** + * Return the unread buffer contents + * @return string + * @throws Swift_ConnectionException If the connection will not allow data to be read + */ + public function read() + { + if (false === $response = fgets($this->handle)) + { + Swift_ClassLoader::load("Swift_ConnectionException"); + throw new Swift_ConnectionException("Data could not be read from the POP3 connection."); + } + return trim($response); + } + /** + * Write a command to the remote socket + * @param string the command to send (without CRLF) + * @throws Swift_ConnectionException If the command cannot be written + */ + public function write($command) + { + if (false !== fwrite($this->handle, $command . "\r\n")) + { + Swift_ClassLoader::load("Swift_ConnectionException"); + throw new Swift_ConnectionException("Data could not be written to the POP3 connection."); + } + } +} Property changes on: trunk/docs/migrationguide/en/src/main/resources/script/swift_lib/Swift/Authenticator/PopB4Smtp/Pop3Connection.php ___________________________________________________________________ Name: svn:executable + *