From df3c3570cda2b4099a2d9f9f501e8babc952f652 Mon Sep 17 00:00:00 2001
From: till <till@php.net>
Date: Tue, 14 Jul 2009 10:31:27 -0400
Subject: [PATCH]
---
program/lib/Net/SMTP.php | 261 ++++++++++++++++++++++++++++++++++++----------------
1 files changed, 180 insertions(+), 81 deletions(-)
diff --git a/program/lib/Net/SMTP.php b/program/lib/Net/SMTP.php
index 005691d..9b835d7 100644
--- a/program/lib/Net/SMTP.php
+++ b/program/lib/Net/SMTP.php
@@ -65,11 +65,38 @@
var $auth_methods = array('DIGEST-MD5', 'CRAM-MD5', 'LOGIN', 'PLAIN');
/**
+ * Use SMTP command pipelining (specified in RFC 2920) if the SMTP
+ * server supports it.
+ *
+ * When pipeling is enabled, rcptTo(), mailFrom(), sendFrom(),
+ * somlFrom() and samlFrom() do not wait for a response from the
+ * SMTP server but return immediately.
+ *
+ * @var bool
+ * @access public
+ */
+ var $pipelining = false;
+
+ /**
+ * Number of pipelined commands.
+ * @var int
+ * @access private
+ */
+ var $_pipelined_commands = 0;
+
+ /**
* Should debugging output be enabled?
* @var boolean
* @access private
*/
var $_debug = false;
+
+ /**
+ * Debug output handler.
+ * @var callback
+ * @access private
+ */
+ var $_debug_handler = null;
/**
* The socket resource being used to connect to the SMTP server.
@@ -93,6 +120,13 @@
var $_arguments = array();
/**
+ * Stores the SMTP server's greeting string.
+ * @var string
+ * @access private
+ */
+ var $_greeting = null;
+
+ /**
* Stores detected features of the SMTP server.
* @var array
* @access private
@@ -113,22 +147,29 @@
* @param string $host The server to connect to.
* @param integer $port The port to connect to.
* @param string $localhost The value to give when sending EHLO or HELO.
+ * @param boolean $pipeling Use SMTP command pipelining
*
* @access public
* @since 1.0
*/
- function Net_SMTP($host = null, $port = null, $localhost = null)
+ function Net_SMTP($host = null, $port = null, $localhost = null, $pipelining = false)
{
- if (isset($host)) $this->host = $host;
- if (isset($port)) $this->port = $port;
- if (isset($localhost)) $this->localhost = $localhost;
+ if (isset($host)) {
+ $this->host = $host;
+ }
+ if (isset($port)) {
+ $this->port = $port;
+ }
+ if (isset($localhost)) {
+ $this->localhost = $localhost;
+ }
+ $this->pipelining = $pipelining;
$this->_socket = new Net_Socket();
- /*
- * Include the Auth_SASL package. If the package is not available,
- * we disable the authentication methods that depend upon it.
- */
+ /* Include the Auth_SASL package. If the package is not
+ * available, we disable the authentication methods that
+ * depend upon it. */
if ((@include_once 'Auth/SASL.php') === false) {
$pos = array_search('DIGEST-MD5', $this->auth_methods);
unset($this->auth_methods[$pos]);
@@ -145,9 +186,30 @@
* @access public
* @since 1.1.0
*/
- function setDebug($debug)
+ function setDebug($debug, $handler = null)
{
$this->_debug = $debug;
+ $this->_debug_handler = $handler;
+ }
+
+ /**
+ * Write the given debug text to the current debug output handler.
+ *
+ * @param string $message Debug mesage text.
+ *
+ * @access private
+ * @since 1.3.3
+ */
+ function _debug($message)
+ {
+ if ($this->_debug) {
+ if ($this->_debug_handler) {
+ call_user_func_array($this->_debug_handler,
+ array(&$this, $message));
+ } else {
+ echo "DEBUG: $message\n";
+ }
+ }
}
/**
@@ -162,9 +224,7 @@
*/
function _send($data)
{
- if ($this->_debug) {
- echo "DEBUG: Send: $data\n";
- }
+ $this->_debug("Send: $data");
if (PEAR::isError($error = $this->_socket->write($data))) {
return PEAR::raiseError('Failed to write to socket: ' .
@@ -211,6 +271,9 @@
* @param mixed $valid The set of valid response codes. These
* may be specified as an array of integer
* values or as a single integer value.
+ * @param bool $later Do not parse the response now, but wait
+ * until the last command in the pipelined
+ * command group
*
* @return mixed True if the server returned a valid response code or
* a PEAR_Error object is an error condition is reached.
@@ -220,52 +283,52 @@
*
* @see getResponse
*/
- function _parseResponse($valid)
+ function _parseResponse($valid, $later = false)
{
$this->_code = -1;
$this->_arguments = array();
- while ($line = $this->_socket->readLine()) {
- if ($this->_debug) {
- echo "DEBUG: Recv: $line\n";
- }
-
- /* If we receive an empty line, the connection has been closed. */
- if (empty($line)) {
- $this->disconnect();
- return PEAR::raiseError('Connection was unexpectedly closed');
- }
-
- /* Read the code and store the rest in the arguments array. */
- $code = substr($line, 0, 3);
- $this->_arguments[] = trim(substr($line, 4));
-
- /* Check the syntax of the response code. */
- if (is_numeric($code)) {
- $this->_code = (int)$code;
- } else {
- $this->_code = -1;
- break;
- }
-
- /* If this is not a multiline response, we're done. */
- if (substr($line, 3, 1) != '-') {
- break;
- }
- }
-
- /* Compare the server's response code with the valid code. */
- if (is_int($valid) && ($this->_code === $valid)) {
+ if ($later) {
+ $this->_pipelined_commands++;
return true;
}
- /* If we were given an array of valid response codes, check each one. */
- if (is_array($valid)) {
- foreach ($valid as $valid_code) {
- if ($this->_code === $valid_code) {
- return true;
+ for ($i = 0; $i <= $this->_pipelined_commands; $i++) {
+ while ($line = $this->_socket->readLine()) {
+ $this->_debug("Recv: $line");
+
+ /* If we receive an empty line, the connection has been closed. */
+ if (empty($line)) {
+ $this->disconnect();
+ return PEAR::raiseError('Connection was unexpectedly closed');
+ }
+
+ /* Read the code and store the rest in the arguments array. */
+ $code = substr($line, 0, 3);
+ $this->_arguments[] = trim(substr($line, 4));
+
+ /* Check the syntax of the response code. */
+ if (is_numeric($code)) {
+ $this->_code = (int)$code;
+ } else {
+ $this->_code = -1;
+ break;
+ }
+
+ /* If this is not a multiline response, we're done. */
+ if (substr($line, 3, 1) != '-') {
+ break;
}
}
+ }
+
+ $this->_pipelined_commands = 0;
+
+ /* Compare the server's response code with the valid code/codes. */
+ if (is_int($valid) && ($this->_code === $valid)) {
+ return true;
+ } elseif (is_array($valid) && in_array($this->_code, $valid, true)) {
+ return true;
}
return PEAR::raiseError('Invalid response code received from server',
@@ -288,6 +351,20 @@
}
/**
+ * Return the SMTP server's greeting string.
+ *
+ * @return string A string containing the greeting string, or null if a
+ * greeting has not been received.
+ *
+ * @access public
+ * @since 1.3.3
+ */
+ function getGreeting()
+ {
+ return $this->_greeting;
+ }
+
+ /**
* Attempt to connect to the SMTP server.
*
* @param int $timeout The timeout value (in seconds) for the
@@ -302,6 +379,7 @@
*/
function connect($timeout = null, $persistent = false)
{
+ $this->_greeting = null;
$result = $this->_socket->connect($this->host, $this->port,
$persistent, $timeout);
if (PEAR::isError($result)) {
@@ -312,6 +390,10 @@
if (PEAR::isError($error = $this->_parseResponse(220))) {
return $error;
}
+
+ /* Extract and store a copy of the server's greeting string. */
+ list(, $this->_greeting) = $this->getResponse();
+
if (PEAR::isError($error = $this->_negotiate())) {
return $error;
}
@@ -383,6 +465,10 @@
$this->_esmtp[$verb] = $arguments;
}
+ if (!isset($this->_esmtp['PIPELINING'])) {
+ $this->pipelining = false;
+ }
+
return true;
}
@@ -424,32 +510,33 @@
*/
function auth($uid, $pwd , $method = '')
{
- if (empty($this->_esmtp['AUTH'])) {
- if (version_compare(PHP_VERSION, '5.1.0', '>=')) {
- if (!isset($this->_esmtp['STARTTLS'])) {
- return PEAR::raiseError('SMTP server does not support authentication');
- }
- if (PEAR::isError($result = $this->_put('STARTTLS'))) {
- return $result;
- }
- if (PEAR::isError($result = $this->_parseResponse(220))) {
- return $result;
- }
- if (PEAR::isError($result = $this->_socket->enableCrypto(true, STREAM_CRYPTO_METHOD_TLS_CLIENT))) {
- return $result;
- } elseif ($result !== true) {
- return PEAR::raiseError('STARTTLS failed');
- }
+ /* We can only attempt a TLS connection if we're running PHP 5.1.0 or
+ * later, have access to the OpenSSL extension, are connected to an
+ * SMTP server which supports the STARTTLS extension, and aren't
+ * already connected over a secure (SSL) socket connection. */
+ $tls = version_compare(PHP_VERSION, '5.1.0', '>=') && extension_loaded('openssl') &&
+ isset($this->_esmtp['STARTTLS']) && strncasecmp($this->host, 'ssl://', 6) != 0;
- /* Send EHLO again to recieve the AUTH string from the
- * SMTP server. */
- $this->_negotiate();
- if (empty($this->_esmtp['AUTH'])) {
- return PEAR::raiseError('SMTP server does not support authentication');
- }
- } else {
- return PEAR::raiseError('SMTP server does not support authentication');
+ if ($tls) {
+ if (PEAR::isError($result = $this->_put('STARTTLS'))) {
+ return $result;
}
+ if (PEAR::isError($result = $this->_parseResponse(220))) {
+ return $result;
+ }
+ if (PEAR::isError($result = $this->_socket->enableCrypto(true, STREAM_CRYPTO_METHOD_TLS_CLIENT))) {
+ return $result;
+ } elseif ($result !== true) {
+ return PEAR::raiseError('STARTTLS failed');
+ }
+
+ /* Send EHLO again to recieve the AUTH string from the
+ * SMTP server. */
+ $this->_negotiate();
+ }
+
+ if (empty($this->_esmtp['AUTH'])) {
+ return PEAR::raiseError('SMTP server does not support authentication');
}
/* If no method has been specified, get the name of the best
@@ -537,7 +624,7 @@
/* We don't use the protocol's third step because SMTP doesn't
* allow subsequent authentication, so we just silently ignore
* it. */
- if (PEAR::isError($error = $this->_put(' '))) {
+ if (PEAR::isError($error = $this->_put(''))) {
return $error;
}
/* 235: Authentication successful */
@@ -692,6 +779,18 @@
}
/**
+ * Return the list of SMTP service extensions advertised by the server.
+ *
+ * @return array The list of SMTP service extensions.
+ * @access public
+ * @since 1.3
+ */
+ function getServiceExtensions()
+ {
+ return $this->_esmtp;
+ }
+
+ /**
* Send the MAIL FROM: command.
*
* @param string $sender The sender (reverse path) to set.
@@ -731,7 +830,7 @@
if (PEAR::isError($error = $this->_put('MAIL', $args))) {
return $error;
}
- if (PEAR::isError($error = $this->_parseResponse(250))) {
+ if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) {
return $error;
}
@@ -761,7 +860,7 @@
if (PEAR::isError($error = $this->_put('RCPT', $args))) {
return $error;
}
- if (PEAR::isError($error = $this->_parseResponse(array(250, 251)))) {
+ if (PEAR::isError($error = $this->_parseResponse(array(250, 251), $this->pipelining))) {
return $error;
}
@@ -830,7 +929,7 @@
if (PEAR::isError($result = $this->_send($data . "\r\n.\r\n"))) {
return $result;
}
- if (PEAR::isError($error = $this->_parseResponse(250))) {
+ if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) {
return $error;
}
@@ -852,7 +951,7 @@
if (PEAR::isError($error = $this->_put('SEND', "FROM:<$path>"))) {
return $error;
}
- if (PEAR::isError($error = $this->_parseResponse(250))) {
+ if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) {
return $error;
}
@@ -891,7 +990,7 @@
if (PEAR::isError($error = $this->_put('SOML', "FROM:<$path>"))) {
return $error;
}
- if (PEAR::isError($error = $this->_parseResponse(250))) {
+ if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) {
return $error;
}
@@ -930,7 +1029,7 @@
if (PEAR::isError($error = $this->_put('SAML', "FROM:<$path>"))) {
return $error;
}
- if (PEAR::isError($error = $this->_parseResponse(250))) {
+ if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) {
return $error;
}
@@ -967,7 +1066,7 @@
if (PEAR::isError($error = $this->_put('RSET'))) {
return $error;
}
- if (PEAR::isError($error = $this->_parseResponse(250))) {
+ if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) {
return $error;
}
--
Gitblit v1.9.1