From e063309a0f76b87ab9cef9241a50bf14444fa328 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Sun, 26 Jul 2015 15:59:49 +0200 Subject: [PATCH 1/7] Drop PHP4 support --- Net/SMTP.php | 435 ++++++++++++++++++++++---------------------------- composer.json | 2 +- package.xml | 2 +- 3 files changed, 194 insertions(+), 245 deletions(-) diff --git a/Net/SMTP.php b/Net/SMTP.php index eeda026..83a1e83 100644 --- a/Net/SMTP.php +++ b/Net/SMTP.php @@ -1,9 +1,9 @@ * @author Jon Parise * @author Damian Alejandro Fernandez Sosa * - * @example basic.php A basic implementation of the Net_SMTP package. + * @example basic.php A basic implementation of the Net_SMTP package. */ class Net_SMTP { /** * The server to connect to. * @var string - * @access public */ - var $host = 'localhost'; + public $host = 'localhost'; /** * The port to connect to. * @var int - * @access public */ - var $port = 25; + public $port = 25; /** * The value to give when sending EHLO or HELO. * @var string - * @access public */ - var $localhost = 'localhost'; + public $localhost = 'localhost'; /** * List of supported authentication methods, in preferential order. * @var array - * @access public */ - var $auth_methods = array(); + public $auth_methods = array(); /** * Use SMTP command pipelining (specified in RFC 2920) if the SMTP @@ -71,80 +67,69 @@ class Net_SMTP * SMTP server but return immediately. * * @var bool - * @access public */ - var $pipelining = false; + public $pipelining = false; /** * Number of pipelined commands. * @var int - * @access private */ - var $_pipelined_commands = 0; + protected $_pipelined_commands = 0; /** * Should debugging output be enabled? * @var boolean - * @access private */ - var $_debug = false; + protected $_debug = false; /** * Debug output handler. * @var callback - * @access private */ - var $_debug_handler = null; + protected $_debug_handler = null; /** * The socket resource being used to connect to the SMTP server. * @var resource - * @access private */ - var $_socket = null; + protected $_socket = null; /** * Array of socket options that will be passed to Net_Socket::connect(). * @see stream_context_create() * @var array - * @access private */ - var $_socket_options = null; + protected $_socket_options = null; /** * The socket I/O timeout value in seconds. * @var int - * @access private */ - var $_timeout = 0; + protected $_timeout = 0; /** * The most recent server response code. * @var int - * @access private */ - var $_code = -1; + protected $_code = -1; /** * The most recent server response arguments. * @var array - * @access private */ - var $_arguments = array(); + protected $_arguments = array(); /** * Stores the SMTP server's greeting string. * @var string - * @access private */ - var $_greeting = null; + protected $_greeting = null; /** * Stores detected features of the SMTP server. * @var array - * @access private */ - var $_esmtp = array(); + protected $_esmtp = array(); /** * Instantiates a new Net_SMTP object, overriding any defaults @@ -157,17 +142,16 @@ class Net_SMTP * $smtp = new Net_SMTP('ssl://mail.host.com', 465); * $smtp->connect(); * - * @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 - * @param integer $timeout Socket I/O timeout in seconds. + * @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 $pipelining Use SMTP command pipelining + * @param integer $timeout Socket I/O timeout in seconds. * @param array $socket_options Socket stream_context_create() options. * - * @access public - * @since 1.0 + * @since 1.0 */ - function Net_SMTP($host = null, $port = null, $localhost = null, + public function __construct($host = null, $port = null, $localhost = null, $pipelining = false, $timeout = 0, $socket_options = null) { if (isset($host)) { @@ -179,11 +163,11 @@ function Net_SMTP($host = null, $port = null, $localhost = null, if (isset($localhost)) { $this->localhost = $localhost; } - $this->pipelining = $pipelining; - $this->_socket = new Net_Socket(); + $this->pipelining = $pipelining; + $this->_socket = new Net_Socket(); $this->_socket_options = $socket_options; - $this->_timeout = $timeout; + $this->_timeout = $timeout; /* Include the Auth_SASL package. If the package is available, we * enable the authentication methods that depend upon it. */ @@ -200,39 +184,37 @@ function Net_SMTP($host = null, $port = null, $localhost = null, /** * Set the socket I/O timeout value in seconds plus microseconds. * - * @param integer $seconds Timeout value in seconds. - * @param integer $microseconds Additional value in microseconds. + * @param integer $seconds Timeout value in seconds. + * @param integer $microseconds Additional value in microseconds. * - * @access public - * @since 1.5.0 + * @since 1.5.0 */ - function setTimeout($seconds, $microseconds = 0) { + public function setTimeout($seconds, $microseconds = 0) + { return $this->_socket->setTimeout($seconds, $microseconds); } /** * Set the value of the debugging flag. * - * @param boolean $debug New value for the debugging flag. + * @param boolean $debug New value for the debugging flag. * - * @access public - * @since 1.1.0 + * @since 1.1.0 */ - function setDebug($debug, $handler = null) + public function setDebug($debug, $handler = null) { - $this->_debug = $debug; + $this->_debug = $debug; $this->_debug_handler = $handler; } /** * Write the given debug text to the current debug output handler. * - * @param string $message Debug mesage text. + * @param string $message Debug mesage text. * - * @access private - * @since 1.3.3 + * @since 1.3.3 */ - function _debug($message) + protected function _debug($message) { if ($this->_debug) { if ($this->_debug_handler) { @@ -247,15 +229,14 @@ function _debug($message) /** * Send the given string of data to the server. * - * @param string $data The string of data to send. + * @param string $data The string of data to send. * - * @return mixed The number of bytes that were actually written, - * or a PEAR_Error object on failure. + * @return mixed The number of bytes that were actually written, + * or a PEAR_Error object on failure. * - * @access private - * @since 1.1.0 + * @since 1.1.0 */ - function _send($data) + protected function _send($data) { $this->_debug("Send: $data"); @@ -277,16 +258,15 @@ function _send($data) * already contains any newline characters. Use _send() for * commands that must contain newlines. * - * @param string $command The SMTP command to send to the server. - * @param string $args A string of optional arguments to append - * to the command. + * @param string $command The SMTP command to send to the server. + * @param string $args A string of optional arguments to append + * to the command. * - * @return mixed The result of the _send() call. + * @return mixed The result of the _send() call. * - * @access private - * @since 1.1.0 + * @since 1.1.0 */ - function _put($command, $args = '') + protected function _put($command, $args = '') { if (!empty($args)) { $command .= ' ' . $args; @@ -304,24 +284,23 @@ function _put($command, $args = '') * Read a reply from the SMTP server. The reply consists of a response * code and a response message. * - * @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 + * @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. + * @return mixed True if the server returned a valid response code or + * a PEAR_Error object is an error condition is reached. * - * @access private - * @since 1.1.0 + * @since 1.1.0 * - * @see getResponse + * @see getResponse */ - function _parseResponse($valid, $later = false) + protected function _parseResponse($valid, $later = false) { - $this->_code = -1; + $this->_code = -1; $this->_arguments = array(); if ($later) { @@ -375,17 +354,16 @@ function _parseResponse($valid, $later = false) /** * Issue an SMTP command and verify its response. * - * @param string $command The SMTP command string or data. - * @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 string $command The SMTP command string or data. + * @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. * - * @return mixed True on success or a PEAR_Error object on failure. + * @return mixed True on success or a PEAR_Error object on failure. * - * @access public - * @since 1.6.0 + * @since 1.6.0 */ - function command($command, $valid) + public function command($command, $valid) { if (PEAR::isError($error = $this->_put($command))) { return $error; @@ -400,14 +378,13 @@ function command($command, $valid) /** * Return a 2-tuple containing the last response from the SMTP server. * - * @return array A two-element array: the first element contains the - * response code as an integer and the second element - * contains the response's arguments as a string. + * @return array A two-element array: the first element contains the + * response code as an integer and the second element + * contains the response's arguments as a string. * - * @access public - * @since 1.1.0 + * @since 1.1.0 */ - function getResponse() + public function getResponse() { return array($this->_code, join("\n", $this->_arguments)); } @@ -415,13 +392,12 @@ function getResponse() /** * Return the SMTP server's greeting string. * - * @return string A string containing the greeting string, or null if a - * greeting has not been received. + * @return string A string containing the greeting string, or null if a + * greeting has not been received. * - * @access public - * @since 1.3.3 + * @since 1.3.3 */ - function getGreeting() + public function getGreeting() { return $this->_greeting; } @@ -429,17 +405,16 @@ function getGreeting() /** * Attempt to connect to the SMTP server. * - * @param int $timeout The timeout value (in seconds) for the - * socket connection attempt. - * @param bool $persistent Should a persistent socket connection - * be used? + * @param int $timeout The timeout value (in seconds) for the + * socket connection attempt. + * @param bool $persistent Should a persistent socket connection + * be used? * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function connect($timeout = null, $persistent = false) + public function connect($timeout = null, $persistent = false) { $this->_greeting = null; $result = $this->_socket->connect($this->host, $this->port, @@ -481,10 +456,9 @@ function connect($timeout = null, $persistent = false) * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function disconnect() + public function disconnect() { if (PEAR::isError($error = $this->_put('QUIT'))) { return $error; @@ -507,10 +481,9 @@ function disconnect() * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. * - * @access private - * @since 1.1.0 + * @since 1.1.0 */ - function _negotiate() + protected function _negotiate() { if (PEAR::isError($error = $this->_put('EHLO', $this->localhost))) { return $error; @@ -547,13 +520,12 @@ function _negotiate() * Returns the name of the best authentication method that the server * has advertised. * - * @return mixed Returns a string containing the name of the best - * supported authentication method or a PEAR_Error object - * if a failure condition is encountered. - * @access private - * @since 1.1.0 + * @return mixed Returns a string containing the name of the best + * supported authentication method or a PEAR_Error object + * if a failure condition is encountered. + * @since 1.1.0 */ - function _getBestAuthMethod() + protected function _getBestAuthMethod() { $available_methods = explode(' ', $this->_esmtp['AUTH']); @@ -564,26 +536,25 @@ function _getBestAuthMethod() } return PEAR::raiseError('No supported authentication methods', - null, PEAR_ERROR_RETURN); + null, PEAR_ERROR_RETURN); } /** * Attempt to do SMTP authentication. * - * @param string The userid to authenticate as. - * @param string The password to authenticate with. - * @param string The requested authentication method. If none is - * specified, the best supported method will be used. - * @param bool Flag indicating whether or not TLS should be attempted. - * @param string An optional authorization identifier. If specified, this - * identifier will be used as the authorization proxy. + * @param string $uid The userid to authenticate as. + * @param string $pwd The password to authenticate with. + * @param string $method The requested authentication method. If none is + * specified, the best supported method will be used. + * @param bool $tls Flag indicating whether or not TLS should be attempted. + * @param string $authz An optional authorization identifier. If specified, this + * identifier will be used as the authorization proxy. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function auth($uid, $pwd , $method = '', $tls = true, $authz = '') + public function auth($uid, $pwd , $method = '', $tls = true, $authz = '') { /* We can only attempt a TLS connection if one has been requested, * we're running PHP 5.1.0 or later, have access to the OpenSSL @@ -656,19 +627,18 @@ function auth($uid, $pwd , $method = '', $tls = true, $authz = '') /** * Add a new authentication method. * - * @param string The authentication method name (e.g. 'PLAIN') - * @param mixed The authentication callback (given as the name of a - * function or as an (object, method name) array). - * @param bool Should the new method be prepended to the list of - * available methods? This is the default behavior, - * giving the new method the highest priority. + * @param string $name The authentication method name (e.g. 'PLAIN') + * @param mixed $callback The authentication callback (given as the name of a + * function or as an (object, method name) array). + * @param bool $prepend Should the new method be prepended to the list of + * available methods? This is the default behavior, + * giving the new method the highest priority. * - * @return mixed True on success or a PEAR_Error object on failure. + * @return mixed True on success or a PEAR_Error object on failure. * - * @access public - * @since 1.6.0 + * @since 1.6.0 */ - function setAuthMethod($name, $callback, $prepend = true) + public function setAuthMethod($name, $callback, $prepend = true) { if (!is_string($name)) { return PEAR::raiseError('Method name is not a string'); @@ -696,16 +666,15 @@ function setAuthMethod($name, $callback, $prepend = true) /** * Authenticates the user using the DIGEST-MD5 method. * - * @param string The userid to authenticate as. - * @param string The password to authenticate with. - * @param string The optional authorization proxy identifier. + * @param string $uid The userid to authenticate as. + * @param string $pwd The password to authenticate with. + * @param string $authz The optional authorization proxy identifier. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access private - * @since 1.1.0 + * @since 1.1.0 */ - function _authDigest_MD5($uid, $pwd, $authz = '') + protected function _authDigest_MD5($uid, $pwd, $authz = '') { if (PEAR::isError($error = $this->_put('AUTH', 'DIGEST-MD5'))) { return $error; @@ -720,8 +689,8 @@ function _authDigest_MD5($uid, $pwd, $authz = '') } $challenge = base64_decode($this->_arguments[0]); - $digest = &Auth_SASL::factory('digest-md5'); - $auth_str = base64_encode($digest->getResponse($uid, $pwd, $challenge, + $digest = Auth_SASL::factory('digest-md5'); + $auth_str = base64_encode($digest->getResponse($uid, $pwd, $challenge, $this->host, "smtp", $authz)); @@ -748,16 +717,15 @@ function _authDigest_MD5($uid, $pwd, $authz = '') /** * Authenticates the user using the CRAM-MD5 method. * - * @param string The userid to authenticate as. - * @param string The password to authenticate with. - * @param string The optional authorization proxy identifier. + * @param string $uid The userid to authenticate as. + * @param string $pwd The password to authenticate with. + * @param string $authz The optional authorization proxy identifier. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access private - * @since 1.1.0 + * @since 1.1.0 */ - function _authCRAM_MD5($uid, $pwd, $authz = '') + protected function _authCRAM_MD5($uid, $pwd, $authz = '') { if (PEAR::isError($error = $this->_put('AUTH', 'CRAM-MD5'))) { return $error; @@ -772,8 +740,8 @@ function _authCRAM_MD5($uid, $pwd, $authz = '') } $challenge = base64_decode($this->_arguments[0]); - $cram = &Auth_SASL::factory('cram-md5'); - $auth_str = base64_encode($cram->getResponse($uid, $pwd, $challenge)); + $cram = Auth_SASL::factory('cram-md5'); + $auth_str = base64_encode($cram->getResponse($uid, $pwd, $challenge)); if (PEAR::isError($error = $this->_put($auth_str))) { return $error; @@ -788,16 +756,15 @@ function _authCRAM_MD5($uid, $pwd, $authz = '') /** * Authenticates the user using the LOGIN method. * - * @param string The userid to authenticate as. - * @param string The password to authenticate with. - * @param string The optional authorization proxy identifier. + * @param string $uid The userid to authenticate as. + * @param string $pwd The password to authenticate with. + * @param string $authz The optional authorization proxy identifier. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access private - * @since 1.1.0 + * @since 1.1.0 */ - function _authLogin($uid, $pwd, $authz = '') + protected function _authLogin($uid, $pwd, $authz = '') { if (PEAR::isError($error = $this->_put('AUTH', 'LOGIN'))) { return $error; @@ -834,16 +801,15 @@ function _authLogin($uid, $pwd, $authz = '') /** * Authenticates the user using the PLAIN method. * - * @param string The userid to authenticate as. - * @param string The password to authenticate with. - * @param string The optional authorization proxy identifier. + * @param string $uid The userid to authenticate as. + * @param string $pwd The password to authenticate with. + * @param string $authz The optional authorization proxy identifier. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access private - * @since 1.1.0 + * @since 1.1.0 */ - function _authPlain($uid, $pwd, $authz = '') + protected function _authPlain($uid, $pwd, $authz = '') { if (PEAR::isError($error = $this->_put('AUTH', 'PLAIN'))) { return $error; @@ -874,14 +840,13 @@ function _authPlain($uid, $pwd, $authz = '') /** * Send the HELO command. * - * @param string The domain name to say we are. + * @param string $domain The domain name to say we are. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function helo($domain) + public function helo($domain) { if (PEAR::isError($error = $this->_put('HELO', $domain))) { return $error; @@ -897,10 +862,9 @@ function helo($domain) * 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() + public function getServiceExtensions() { return $this->_esmtp; } @@ -908,23 +872,22 @@ function getServiceExtensions() /** * Send the MAIL FROM: command. * - * @param string $sender The sender (reverse path) to set. - * @param string $params String containing additional MAIL parameters, - * such as the NOTIFY flags defined by RFC 1891 - * or the VERP protocol. + * @param string $sender The sender (reverse path) to set. + * @param string $params String containing additional MAIL parameters, + * such as the NOTIFY flags defined by RFC 1891 + * or the VERP protocol. * - * If $params is an array, only the 'verp' option - * is supported. If 'verp' is true, the XVERP - * parameter is appended to the MAIL command. If - * the 'verp' value is a string, the full - * XVERP=value parameter is appended. + * If $params is an array, only the 'verp' option + * is supported. If 'verp' is true, the XVERP + * parameter is appended to the MAIL command. + * If the 'verp' value is a string, the full + * XVERP=value parameter is appended. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function mailFrom($sender, $params = null) + public function mailFrom($sender, $params = null) { $args = "FROM:<$sender>"; @@ -962,10 +925,9 @@ function mailFrom($sender, $params = null) * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. * - * @access public - * @since 1.0 + * @since 1.0 */ - function rcptTo($recipient, $params = null) + public function rcptTo($recipient, $params = null) { $args = "TO:<$recipient>"; if (is_string($params)) { @@ -989,13 +951,12 @@ function rcptTo($recipient, $params = null) * easier overloading for the cases where it is desirable to * customize the quoting behavior. * - * @param string $data The message text to quote. The string must be passed + * @param string &$data The message text to quote. The string must be passed * by reference, and the text will be modified in place. * - * @access public - * @since 1.2 + * @since 1.2 */ - function quotedata(&$data) + public function quotedata(&$data) { /* Because a single leading period (.) signifies an end to the * data, legitimate leading periods need to be "doubled" ('..'). */ @@ -1008,17 +969,16 @@ function quotedata(&$data) /** * Send the DATA command. * - * @param mixed $data The message data, either as a string or an open + * @param mixed $data The message data, either as a string or an open * file resource. * @param string $headers The message headers. If $headers is provided, * $data is assumed to contain only body data. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function data($data, $headers = null) + public function data($data, $headers = null) { /* Verify that $data is a supported type. */ if (!is_string($data) && !is_resource($data)) { @@ -1139,14 +1099,13 @@ function data($data, $headers = null) /** * Send the SEND FROM: command. * - * @param string The reverse path to send. + * @param string $path The reverse path to send. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.2.6 + * @since 1.2.6 */ - function sendFrom($path) + public function sendFrom($path) { if (PEAR::isError($error = $this->_put('SEND', "FROM:<$path>"))) { return $error; @@ -1161,16 +1120,15 @@ function sendFrom($path) /** * Backwards-compatibility wrapper for sendFrom(). * - * @param string The reverse path to send. + * @param string $path The reverse path to send. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. * - * @access public - * @since 1.0 - * @deprecated 1.2.6 + * @since 1.0 + * @deprecated 1.2.6 */ - function send_from($path) + public function send_from($path) { return sendFrom($path); } @@ -1178,14 +1136,13 @@ function send_from($path) /** * Send the SOML FROM: command. * - * @param string The reverse path to send. + * @param string $path The reverse path to send. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.2.6 + * @since 1.2.6 */ - function somlFrom($path) + public function somlFrom($path) { if (PEAR::isError($error = $this->_put('SOML', "FROM:<$path>"))) { return $error; @@ -1200,16 +1157,15 @@ function somlFrom($path) /** * Backwards-compatibility wrapper for somlFrom(). * - * @param string The reverse path to send. + * @param string $path The reverse path to send. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. * - * @access public - * @since 1.0 - * @deprecated 1.2.6 + * @since 1.0 + * @deprecated 1.2.6 */ - function soml_from($path) + public function soml_from($path) { return somlFrom($path); } @@ -1217,14 +1173,13 @@ function soml_from($path) /** * Send the SAML FROM: command. * - * @param string The reverse path to send. + * @param string $path The reverse path to send. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.2.6 + * @since 1.2.6 */ - function samlFrom($path) + public function samlFrom($path) { if (PEAR::isError($error = $this->_put('SAML', "FROM:<$path>"))) { return $error; @@ -1239,16 +1194,15 @@ function samlFrom($path) /** * Backwards-compatibility wrapper for samlFrom(). * - * @param string The reverse path to send. + * @param string $path The reverse path to send. * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. * - * @access public - * @since 1.0 - * @deprecated 1.2.6 + * @since 1.0 + * @deprecated 1.2.6 */ - function saml_from($path) + public function saml_from($path) { return samlFrom($path); } @@ -1258,10 +1212,9 @@ function saml_from($path) * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public * @since 1.0 */ - function rset() + public function rset() { if (PEAR::isError($error = $this->_put('RSET'))) { return $error; @@ -1276,14 +1229,13 @@ function rset() /** * Send the VRFY command. * - * @param string The string to verify + * @param string $string The string to verify * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function vrfy($string) + public function vrfy($string) { /* Note: 251 is also a valid response code */ if (PEAR::isError($error = $this->_put('VRFY', $string))) { @@ -1301,10 +1253,9 @@ function vrfy($string) * * @return mixed Returns a PEAR_Error with an error message on any * kind of failure, or true on success. - * @access public - * @since 1.0 + * @since 1.0 */ - function noop() + public function noop() { if (PEAR::isError($error = $this->_put('NOOP'))) { return $error; @@ -1320,14 +1271,12 @@ function noop() * Backwards-compatibility method. identifySender()'s functionality is * now handled internally. * - * @return boolean This method always return true. + * @return boolean This method always return true. * - * @access public - * @since 1.0 + * @since 1.0 */ - function identifySender() + public function identifySender() { return true; } - } diff --git a/composer.json b/composer.json index 0d09897..ea00c35 100644 --- a/composer.json +++ b/composer.json @@ -35,7 +35,7 @@ }, "type": "library", "require": { - "pear/pear_exception": "*", + "pear/pear-core-minimal": "*", "pear/net_socket": "*" }, "require-dev": { diff --git a/package.xml b/package.xml index bc1a1d3..ee48336 100644 --- a/package.xml +++ b/package.xml @@ -52,7 +52,7 @@ - 4.0.5 + 5.0.0 1.4.3 From 37c58327045f4300db0e1fabbbde93e139767ba7 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Sun, 26 Jul 2015 16:00:29 +0200 Subject: [PATCH 2/7] Remove methods deprecated long time ago --- Net/SMTP.php | 48 ------------------------------------------------ 1 file changed, 48 deletions(-) diff --git a/Net/SMTP.php b/Net/SMTP.php index 83a1e83..9351203 100644 --- a/Net/SMTP.php +++ b/Net/SMTP.php @@ -1117,22 +1117,6 @@ public function sendFrom($path) return true; } - /** - * Backwards-compatibility wrapper for sendFrom(). - * - * @param string $path The reverse path to send. - * - * @return mixed Returns a PEAR_Error with an error message on any - * kind of failure, or true on success. - * - * @since 1.0 - * @deprecated 1.2.6 - */ - public function send_from($path) - { - return sendFrom($path); - } - /** * Send the SOML FROM: command. * @@ -1154,22 +1138,6 @@ public function somlFrom($path) return true; } - /** - * Backwards-compatibility wrapper for somlFrom(). - * - * @param string $path The reverse path to send. - * - * @return mixed Returns a PEAR_Error with an error message on any - * kind of failure, or true on success. - * - * @since 1.0 - * @deprecated 1.2.6 - */ - public function soml_from($path) - { - return somlFrom($path); - } - /** * Send the SAML FROM: command. * @@ -1191,22 +1159,6 @@ public function samlFrom($path) return true; } - /** - * Backwards-compatibility wrapper for samlFrom(). - * - * @param string $path The reverse path to send. - * - * @return mixed Returns a PEAR_Error with an error message on any - * kind of failure, or true on success. - * - * @since 1.0 - * @deprecated 1.2.6 - */ - public function saml_from($path) - { - return samlFrom($path); - } - /** * Send the RSET command. * From 100e3908cf29a8d5d84f3ff80704eb1d435de05a Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Sun, 26 Jul 2015 16:19:07 +0200 Subject: [PATCH 3/7] Fixed CS errors --- Net/SMTP.php | 368 ++++++++++++++++++++++++++------------------------- 1 file changed, 190 insertions(+), 178 deletions(-) diff --git a/Net/SMTP.php b/Net/SMTP.php index 9351203..a7fa3f4 100644 --- a/Net/SMTP.php +++ b/Net/SMTP.php @@ -74,62 +74,62 @@ class Net_SMTP * Number of pipelined commands. * @var int */ - protected $_pipelined_commands = 0; + protected $pipelined_commands = 0; /** * Should debugging output be enabled? * @var boolean */ - protected $_debug = false; + protected $debug = false; /** * Debug output handler. * @var callback */ - protected $_debug_handler = null; + protected $debug_handler = null; /** * The socket resource being used to connect to the SMTP server. * @var resource */ - protected $_socket = null; + protected $socket = null; /** * Array of socket options that will be passed to Net_Socket::connect(). * @see stream_context_create() * @var array */ - protected $_socket_options = null; + protected $socket_options = null; /** * The socket I/O timeout value in seconds. * @var int */ - protected $_timeout = 0; + protected $timeout = 0; /** * The most recent server response code. * @var int */ - protected $_code = -1; + protected $code = -1; /** * The most recent server response arguments. * @var array */ - protected $_arguments = array(); + protected $arguments = array(); /** * Stores the SMTP server's greeting string. * @var string */ - protected $_greeting = null; + protected $greeting = null; /** * Stores detected features of the SMTP server. * @var array */ - protected $_esmtp = array(); + protected $esmtp = array(); /** * Instantiates a new Net_SMTP object, overriding any defaults @@ -152,8 +152,8 @@ class Net_SMTP * @since 1.0 */ public function __construct($host = null, $port = null, $localhost = null, - $pipelining = false, $timeout = 0, $socket_options = null) - { + $pipelining = false, $timeout = 0, $socket_options = null + ) { if (isset($host)) { $this->host = $host; } @@ -165,20 +165,20 @@ public function __construct($host = null, $port = null, $localhost = null, } $this->pipelining = $pipelining; - $this->_socket = new Net_Socket(); - $this->_socket_options = $socket_options; - $this->_timeout = $timeout; + $this->socket = new Net_Socket(); + $this->socket_options = $socket_options; + $this->timeout = $timeout; /* Include the Auth_SASL package. If the package is available, we * enable the authentication methods that depend upon it. */ if (@include_once 'Auth/SASL.php') { - $this->setAuthMethod('CRAM-MD5', array($this, '_authCram_MD5')); - $this->setAuthMethod('DIGEST-MD5', array($this, '_authDigest_MD5')); + $this->setAuthMethod('CRAM-MD5', array($this, 'authCramMD5')); + $this->setAuthMethod('DIGEST-MD5', array($this, 'authDigestMD5')); } /* These standard authentication methods are always available. */ - $this->setAuthMethod('LOGIN', array($this, '_authLogin'), false); - $this->setAuthMethod('PLAIN', array($this, '_authPlain'), false); + $this->setAuthMethod('LOGIN', array($this, 'authLogin'), false); + $this->setAuthMethod('PLAIN', array($this, 'authPlain'), false); } /** @@ -191,20 +191,21 @@ public function __construct($host = null, $port = null, $localhost = null, */ public function setTimeout($seconds, $microseconds = 0) { - return $this->_socket->setTimeout($seconds, $microseconds); + return $this->socket->setTimeout($seconds, $microseconds); } /** * Set the value of the debugging flag. * - * @param boolean $debug New value for the debugging flag. + * @param boolean $debug New value for the debugging flag. + * @param callback $handler Debug handler callback * * @since 1.1.0 */ public function setDebug($debug, $handler = null) { - $this->_debug = $debug; - $this->_debug_handler = $handler; + $this->debug = $debug; + $this->debug_handler = $handler; } /** @@ -214,12 +215,13 @@ public function setDebug($debug, $handler = null) * * @since 1.3.3 */ - protected function _debug($message) + protected function debug($message) { - if ($this->_debug) { - if ($this->_debug_handler) { - call_user_func_array($this->_debug_handler, - array(&$this, $message)); + if ($this->debug) { + if ($this->debug_handler) { + call_user_func_array( + $this->debug_handler, array(&$this, $message) + ); } else { echo "DEBUG: $message\n"; } @@ -236,15 +238,16 @@ protected function _debug($message) * * @since 1.1.0 */ - protected function _send($data) + protected function send($data) { - $this->_debug("Send: $data"); + $this->debug("Send: $data"); - $result = $this->_socket->write($data); + $result = $this->socket->write($data); if (!$result || PEAR::isError($result)) { $msg = ($result) ? $result->getMessage() : "unknown error"; - return PEAR::raiseError("Failed to write to socket: $msg", - null, PEAR_ERROR_RETURN); + return PEAR::raiseError( + "Failed to write to socket: $msg", null, PEAR_ERROR_RETURN + ); } return $result; @@ -255,29 +258,30 @@ protected function _send($data) * arguments. A carriage return / linefeed (CRLF) sequence will * be appended to each command string before it is sent to the * SMTP server - an error will be thrown if the command string - * already contains any newline characters. Use _send() for + * already contains any newline characters. Use send() for * commands that must contain newlines. * * @param string $command The SMTP command to send to the server. * @param string $args A string of optional arguments to append * to the command. * - * @return mixed The result of the _send() call. + * @return mixed The result of the send() call. * * @since 1.1.0 */ - protected function _put($command, $args = '') + protected function put($command, $args = '') { if (!empty($args)) { $command .= ' ' . $args; } if (strcspn($command, "\r\n") !== strlen($command)) { - return PEAR::raiseError('Commands cannot contain newlines', - null, PEAR_ERROR_RETURN); + return PEAR::raiseError( + 'Commands cannot contain newlines', null, PEAR_ERROR_RETURN + ); } - return $this->_send($command . "\r\n"); + return $this->send($command . "\r\n"); } /** @@ -298,36 +302,37 @@ protected function _put($command, $args = '') * * @see getResponse */ - protected function _parseResponse($valid, $later = false) + protected function parseResponse($valid, $later = false) { - $this->_code = -1; - $this->_arguments = array(); + $this->code = -1; + $this->arguments = array(); if ($later) { - $this->_pipelined_commands++; + $this->pipelined_commands++; return true; } - for ($i = 0; $i <= $this->_pipelined_commands; $i++) { - while ($line = $this->_socket->readLine()) { - $this->_debug("Recv: $line"); + 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 was closed. */ if (empty($line)) { $this->disconnect(); - return PEAR::raiseError('Connection was closed', - null, PEAR_ERROR_RETURN); + return PEAR::raiseError( + 'Connection was closed', null, PEAR_ERROR_RETURN + ); } /* Read the code and store the rest in the arguments array. */ $code = substr($line, 0, 3); - $this->_arguments[] = trim(substr($line, 4)); + $this->arguments[] = trim(substr($line, 4)); /* Check the syntax of the response code. */ if (is_numeric($code)) { - $this->_code = (int)$code; + $this->code = (int)$code; } else { - $this->_code = -1; + $this->code = -1; break; } @@ -338,17 +343,18 @@ protected function _parseResponse($valid, $later = false) } } - $this->_pipelined_commands = 0; + $this->pipelined_commands = 0; /* Compare the server's response code with the valid code/codes. */ - if (is_int($valid) && ($this->_code === $valid)) { + if (is_int($valid) && ($this->code === $valid)) { return true; - } elseif (is_array($valid) && in_array($this->_code, $valid, true)) { + } elseif (is_array($valid) && in_array($this->code, $valid, true)) { return true; } - return PEAR::raiseError('Invalid response code received from server', - $this->_code, PEAR_ERROR_RETURN); + return PEAR::raiseError( + 'Invalid response code received from server', $this->code, PEAR_ERROR_RETURN + ); } /** @@ -365,10 +371,10 @@ protected function _parseResponse($valid, $later = false) */ public function command($command, $valid) { - if (PEAR::isError($error = $this->_put($command))) { + if (PEAR::isError($error = $this->put($command))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse($valid))) { + if (PEAR::isError($error = $this->parseResponse($valid))) { return $error; } @@ -386,20 +392,20 @@ public function command($command, $valid) */ public function getResponse() { - return array($this->_code, join("\n", $this->_arguments)); + return array($this->code, join("\n", $this->arguments)); } /** * Return the SMTP server's greeting string. * - * @return string A string containing the greeting string, or null if a - * greeting has not been received. + * @return string A string containing the greeting string, or null if + * a greeting has not been received. * * @since 1.3.3 */ public function getGreeting() { - return $this->_greeting; + return $this->greeting; } /** @@ -416,35 +422,38 @@ public function getGreeting() */ public function connect($timeout = null, $persistent = false) { - $this->_greeting = null; - $result = $this->_socket->connect($this->host, $this->port, - $persistent, $timeout, - $this->_socket_options); + $this->greeting = null; + + $result = $this->socket->connect( + $this->host, $this->port, $persistent, $timeout, $this->socket_options + ); + if (PEAR::isError($result)) { - return PEAR::raiseError('Failed to connect socket: ' . - $result->getMessage()); + return PEAR::raiseError( + 'Failed to connect socket: ' . $result->getMessage() + ); } /* - * Now that we're connected, reset the socket's timeout value for - * future I/O operations. This allows us to have different socket - * timeout values for the initial connection (our $timeout parameter) + * Now that we're connected, reset the socket's timeout value for + * future I/O operations. This allows us to have different socket + * timeout values for the initial connection (our $timeout parameter) * and all other socket operations. */ - if ($this->_timeout > 0) { - if (PEAR::isError($error = $this->setTimeout($this->_timeout))) { + if ($this->timeout > 0) { + if (PEAR::isError($error = $this->setTimeout($this->timeout))) { return $error; } } - if (PEAR::isError($error = $this->_parseResponse(220))) { + 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(); + list(, $this->greeting) = $this->getResponse(); - if (PEAR::isError($error = $this->_negotiate())) { + if (PEAR::isError($error = $this->negotiate())) { return $error; } @@ -460,15 +469,16 @@ public function connect($timeout = null, $persistent = false) */ public function disconnect() { - if (PEAR::isError($error = $this->_put('QUIT'))) { + if (PEAR::isError($error = $this->put('QUIT'))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(221))) { + if (PEAR::isError($error = $this->parseResponse(221))) { return $error; } - if (PEAR::isError($error = $this->_socket->disconnect())) { - return PEAR::raiseError('Failed to disconnect socket: ' . - $error->getMessage()); + if (PEAR::isError($error = $this->socket->disconnect())) { + return PEAR::raiseError( + 'Failed to disconnect socket: ' . $error->getMessage() + ); } return true; @@ -483,33 +493,34 @@ public function disconnect() * * @since 1.1.0 */ - protected function _negotiate() + protected function negotiate() { - if (PEAR::isError($error = $this->_put('EHLO', $this->localhost))) { + if (PEAR::isError($error = $this->put('EHLO', $this->localhost))) { return $error; } - if (PEAR::isError($this->_parseResponse(250))) { + if (PEAR::isError($this->parseResponse(250))) { /* If the EHLO failed, try the simpler HELO command. */ - if (PEAR::isError($error = $this->_put('HELO', $this->localhost))) { + if (PEAR::isError($error = $this->put('HELO', $this->localhost))) { return $error; } - if (PEAR::isError($this->_parseResponse(250))) { - return PEAR::raiseError('HELO was not accepted: ', $this->_code, - PEAR_ERROR_RETURN); + if (PEAR::isError($this->parseResponse(250))) { + return PEAR::raiseError( + 'HELO was not accepted: ', $this->code, PEAR_ERROR_RETURN + ); } return true; } - foreach ($this->_arguments as $argument) { - $verb = strtok($argument, ' '); - $arguments = substr($argument, strlen($verb) + 1, - strlen($argument) - strlen($verb) - 1); - $this->_esmtp[$verb] = $arguments; + foreach ($this->arguments as $argument) { + $verb = strtok($argument, ' '); + $len = strlen($verb); + $arguments = substr($argument, $len + 1, strlen($argument) - $len - 1); + $this->esmtp[$verb] = $arguments; } - if (!isset($this->_esmtp['PIPELINING'])) { + if (!isset($this->esmtp['PIPELINING'])) { $this->pipelining = false; } @@ -525,9 +536,9 @@ protected function _negotiate() * if a failure condition is encountered. * @since 1.1.0 */ - protected function _getBestAuthMethod() + protected function getBestAuthMethod() { - $available_methods = explode(' ', $this->_esmtp['AUTH']); + $available_methods = explode(' ', $this->esmtp['AUTH']); foreach ($this->auth_methods as $method => $callback) { if (in_array($method, $available_methods)) { @@ -535,8 +546,9 @@ protected function _getBestAuthMethod() } } - return PEAR::raiseError('No supported authentication methods', - null, PEAR_ERROR_RETURN); + return PEAR::raiseError( + 'No supported authentication methods', null, PEAR_ERROR_RETURN + ); } /** @@ -557,21 +569,22 @@ protected function _getBestAuthMethod() public function auth($uid, $pwd , $method = '', $tls = true, $authz = '') { /* We can only attempt a TLS connection if one has been requested, - * 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 + * 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. */ - if ($tls && version_compare(PHP_VERSION, '5.1.0', '>=') && - extension_loaded('openssl') && isset($this->_esmtp['STARTTLS']) && - strncasecmp($this->host, 'ssl://', 6) !== 0) { + if ($tls && version_compare(PHP_VERSION, '5.1.0', '>=') + && extension_loaded('openssl') && isset($this->esmtp['STARTTLS']) + && strncasecmp($this->host, 'ssl://', 6) !== 0 + ) { /* Start the TLS connection attempt. */ - if (PEAR::isError($result = $this->_put('STARTTLS'))) { + if (PEAR::isError($result = $this->put('STARTTLS'))) { return $result; } - if (PEAR::isError($result = $this->_parseResponse(220))) { + if (PEAR::isError($result = $this->parseResponse(220))) { return $result; } - if (PEAR::isError($result = $this->_socket->enableCrypto(true, STREAM_CRYPTO_METHOD_TLS_CLIENT))) { + if (PEAR::isError($result = $this->socket->enableCrypto(true, STREAM_CRYPTO_METHOD_TLS_CLIENT))) { return $result; } elseif ($result !== true) { return PEAR::raiseError('STARTTLS failed'); @@ -579,17 +592,17 @@ public function auth($uid, $pwd , $method = '', $tls = true, $authz = '') /* Send EHLO again to recieve the AUTH string from the * SMTP server. */ - $this->_negotiate(); + $this->negotiate(); } - if (empty($this->_esmtp['AUTH'])) { + 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 * supported method advertised by the SMTP server. */ if (empty($method)) { - if (PEAR::isError($method = $this->_getBestAuthMethod())) { + if (PEAR::isError($method = $this->getBestAuthMethod())) { /* Return the PEAR_Error object from _getBestAuthMethod(). */ return $method; } @@ -612,9 +625,9 @@ public function auth($uid, $pwd , $method = '', $tls = true, $authz = '') list($object, $method) = $this->auth_methods[$method]; $result = $object->{$method}($uid, $pwd, $authz, $this); } else { - $func = $this->auth_methods[$method]; + $func = $this->auth_methods[$method]; $result = $func($uid, $pwd, $authz, $this); - } + } /* If an error was encountered, return the PEAR_Error object. */ if (PEAR::isError($result)) { @@ -649,13 +662,15 @@ public function setAuthMethod($name, $callback, $prepend = true) } if (is_array($callback)) { - if (!is_object($callback[0]) || !is_string($callback[1])) + if (!is_object($callback[0]) || !is_string($callback[1])) { return PEAR::raiseError('Bad mMethod callback array'); + } } if ($prepend) { - $this->auth_methods = array_merge(array($name => $callback), - $this->auth_methods); + $this->auth_methods = array_merge( + array($name => $callback), $this->auth_methods + ); } else { $this->auth_methods[$name] = $callback; } @@ -674,42 +689,42 @@ public function setAuthMethod($name, $callback, $prepend = true) * kind of failure, or true on success. * @since 1.1.0 */ - protected function _authDigest_MD5($uid, $pwd, $authz = '') + protected function authDigestMD5($uid, $pwd, $authz = '') { - if (PEAR::isError($error = $this->_put('AUTH', 'DIGEST-MD5'))) { + if (PEAR::isError($error = $this->put('AUTH', 'DIGEST-MD5'))) { return $error; } /* 334: Continue authentication request */ - if (PEAR::isError($error = $this->_parseResponse(334))) { + if (PEAR::isError($error = $this->parseResponse(334))) { /* 503: Error: already authenticated */ - if ($this->_code === 503) { + if ($this->code === 503) { return true; } return $error; } - $challenge = base64_decode($this->_arguments[0]); $digest = Auth_SASL::factory('digest-md5'); - $auth_str = base64_encode($digest->getResponse($uid, $pwd, $challenge, - $this->host, "smtp", - $authz)); + $challenge = base64_decode($this->arguments[0]); + $auth_str = base64_encode( + $digest->getResponse($uid, $pwd, $challenge, $this->host, "smtp", $authz) + ); - if (PEAR::isError($error = $this->_put($auth_str))) { + if (PEAR::isError($error = $this->put($auth_str))) { return $error; } /* 334: Continue authentication request */ - if (PEAR::isError($error = $this->_parseResponse(334))) { + if (PEAR::isError($error = $this->parseResponse(334))) { return $error; } /* 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 */ - if (PEAR::isError($error = $this->_parseResponse(235))) { + if (PEAR::isError($error = $this->parseResponse(235))) { return $error; } } @@ -725,30 +740,30 @@ protected function _authDigest_MD5($uid, $pwd, $authz = '') * kind of failure, or true on success. * @since 1.1.0 */ - protected function _authCRAM_MD5($uid, $pwd, $authz = '') + protected function authCRAMMD5($uid, $pwd, $authz = '') { - if (PEAR::isError($error = $this->_put('AUTH', 'CRAM-MD5'))) { + if (PEAR::isError($error = $this->put('AUTH', 'CRAM-MD5'))) { return $error; } /* 334: Continue authentication request */ - if (PEAR::isError($error = $this->_parseResponse(334))) { + if (PEAR::isError($error = $this->parseResponse(334))) { /* 503: Error: already authenticated */ - if ($this->_code === 503) { + if ($this->code === 503) { return true; } return $error; } - $challenge = base64_decode($this->_arguments[0]); + $challenge = base64_decode($this->arguments[0]); $cram = Auth_SASL::factory('cram-md5'); $auth_str = base64_encode($cram->getResponse($uid, $pwd, $challenge)); - if (PEAR::isError($error = $this->_put($auth_str))) { + if (PEAR::isError($error = $this->put($auth_str))) { return $error; } /* 235: Authentication successful */ - if (PEAR::isError($error = $this->_parseResponse(235))) { + if (PEAR::isError($error = $this->parseResponse(235))) { return $error; } } @@ -764,34 +779,34 @@ protected function _authCRAM_MD5($uid, $pwd, $authz = '') * kind of failure, or true on success. * @since 1.1.0 */ - protected function _authLogin($uid, $pwd, $authz = '') + protected function authLogin($uid, $pwd, $authz = '') { - if (PEAR::isError($error = $this->_put('AUTH', 'LOGIN'))) { + if (PEAR::isError($error = $this->put('AUTH', 'LOGIN'))) { return $error; } /* 334: Continue authentication request */ - if (PEAR::isError($error = $this->_parseResponse(334))) { + if (PEAR::isError($error = $this->parseResponse(334))) { /* 503: Error: already authenticated */ - if ($this->_code === 503) { + if ($this->code === 503) { return true; } return $error; } - if (PEAR::isError($error = $this->_put(base64_encode($uid)))) { + if (PEAR::isError($error = $this->put(base64_encode($uid)))) { return $error; } /* 334: Continue authentication request */ - if (PEAR::isError($error = $this->_parseResponse(334))) { + if (PEAR::isError($error = $this->parseResponse(334))) { return $error; } - if (PEAR::isError($error = $this->_put(base64_encode($pwd)))) { + if (PEAR::isError($error = $this->put(base64_encode($pwd)))) { return $error; } /* 235: Authentication successful */ - if (PEAR::isError($error = $this->_parseResponse(235))) { + if (PEAR::isError($error = $this->parseResponse(235))) { return $error; } @@ -809,15 +824,15 @@ protected function _authLogin($uid, $pwd, $authz = '') * kind of failure, or true on success. * @since 1.1.0 */ - protected function _authPlain($uid, $pwd, $authz = '') + protected function authPlain($uid, $pwd, $authz = '') { - if (PEAR::isError($error = $this->_put('AUTH', 'PLAIN'))) { + if (PEAR::isError($error = $this->put('AUTH', 'PLAIN'))) { return $error; } /* 334: Continue authentication request */ - if (PEAR::isError($error = $this->_parseResponse(334))) { + if (PEAR::isError($error = $this->parseResponse(334))) { /* 503: Error: already authenticated */ - if ($this->_code === 503) { + if ($this->code === 503) { return true; } return $error; @@ -825,12 +840,12 @@ protected function _authPlain($uid, $pwd, $authz = '') $auth_str = base64_encode($authz . chr(0) . $uid . chr(0) . $pwd); - if (PEAR::isError($error = $this->_put($auth_str))) { + if (PEAR::isError($error = $this->put($auth_str))) { return $error; } /* 235: Authentication successful */ - if (PEAR::isError($error = $this->_parseResponse(235))) { + if (PEAR::isError($error = $this->parseResponse(235))) { return $error; } @@ -848,10 +863,10 @@ protected function _authPlain($uid, $pwd, $authz = '') */ public function helo($domain) { - if (PEAR::isError($error = $this->_put('HELO', $domain))) { + if (PEAR::isError($error = $this->put('HELO', $domain))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(250))) { + if (PEAR::isError($error = $this->parseResponse(250))) { return $error; } @@ -866,7 +881,7 @@ public function helo($domain) */ public function getServiceExtensions() { - return $this->_esmtp; + return $this->esmtp; } /** @@ -893,11 +908,8 @@ public function mailFrom($sender, $params = null) /* Support the deprecated array form of $params. */ if (is_array($params) && isset($params['verp'])) { - /* XVERP */ if ($params['verp'] === true) { $args .= ' XVERP'; - - /* XVERP=something */ } elseif (trim($params['verp'])) { $args .= ' XVERP=' . $params['verp']; } @@ -905,10 +917,10 @@ public function mailFrom($sender, $params = null) $args .= ' ' . $params; } - if (PEAR::isError($error = $this->_put('MAIL', $args))) { + if (PEAR::isError($error = $this->put('MAIL', $args))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) { + if (PEAR::isError($error = $this->parseResponse(250, $this->pipelining))) { return $error; } @@ -934,10 +946,10 @@ public function rcptTo($recipient, $params = null) $args .= ' ' . $params; } - if (PEAR::isError($error = $this->_put('RCPT', $args))) { + if (PEAR::isError($error = $this->put('RCPT', $args))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(array(250, 251), $this->pipelining))) { + if (PEAR::isError($error = $this->parseResponse(array(250, 251), $this->pipelining))) { return $error; } @@ -1004,24 +1016,24 @@ public function data($data, $headers = null) * that no fixed maximum message size is in force". Furthermore, it * says that if "the parameter is omitted no information is conveyed * about the server's fixed maximum message size". */ - $limit = (isset($this->_esmtp['SIZE'])) ? $this->_esmtp['SIZE'] : 0; + $limit = (isset($this->esmtp['SIZE'])) ? $this->esmtp['SIZE'] : 0; if ($limit > 0 && $size >= $limit) { $this->disconnect(); return PEAR::raiseError('Message size exceeds server limit'); } /* Initiate the DATA command. */ - if (PEAR::isError($error = $this->_put('DATA'))) { + if (PEAR::isError($error = $this->put('DATA'))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(354))) { + if (PEAR::isError($error = $this->parseResponse(354))) { return $error; } /* If we have a separate headers string, send it first. */ if (!is_null($headers)) { $this->quotedata($headers); - if (PEAR::isError($result = $this->_send($headers . "\r\n\r\n"))) { + if (PEAR::isError($result = $this->send($headers . "\r\n\r\n"))) { return $result; } } @@ -1042,7 +1054,7 @@ public function data($data, $headers = null) } } $this->quotedata($line); - if (PEAR::isError($result = $this->_send($line))) { + if (PEAR::isError($result = $this->send($line))) { return $result; } } @@ -1074,7 +1086,7 @@ public function data($data, $headers = null) $this->quotedata($chunk); /* If we run into a problem along the way, abort. */ - if (PEAR::isError($result = $this->_send($chunk))) { + if (PEAR::isError($result = $this->send($chunk))) { return $result; } @@ -1084,12 +1096,12 @@ public function data($data, $headers = null) } /* Finally, send the DATA terminator sequence. */ - if (PEAR::isError($result = $this->_send("\r\n.\r\n"))) { + if (PEAR::isError($result = $this->send("\r\n.\r\n"))) { return $result; } /* Verify that the data was successfully received by the server. */ - if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) { + if (PEAR::isError($error = $this->parseResponse(250, $this->pipelining))) { return $error; } @@ -1107,10 +1119,10 @@ public function data($data, $headers = null) */ public function sendFrom($path) { - if (PEAR::isError($error = $this->_put('SEND', "FROM:<$path>"))) { + if (PEAR::isError($error = $this->put('SEND', "FROM:<$path>"))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) { + if (PEAR::isError($error = $this->parseResponse(250, $this->pipelining))) { return $error; } @@ -1128,10 +1140,10 @@ public function sendFrom($path) */ public function somlFrom($path) { - if (PEAR::isError($error = $this->_put('SOML', "FROM:<$path>"))) { + if (PEAR::isError($error = $this->put('SOML', "FROM:<$path>"))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) { + if (PEAR::isError($error = $this->parseResponse(250, $this->pipelining))) { return $error; } @@ -1149,10 +1161,10 @@ public function somlFrom($path) */ public function samlFrom($path) { - if (PEAR::isError($error = $this->_put('SAML', "FROM:<$path>"))) { + if (PEAR::isError($error = $this->put('SAML', "FROM:<$path>"))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) { + if (PEAR::isError($error = $this->parseResponse(250, $this->pipelining))) { return $error; } @@ -1168,10 +1180,10 @@ public function samlFrom($path) */ public function rset() { - if (PEAR::isError($error = $this->_put('RSET'))) { + if (PEAR::isError($error = $this->put('RSET'))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(250, $this->pipelining))) { + if (PEAR::isError($error = $this->parseResponse(250, $this->pipelining))) { return $error; } @@ -1190,10 +1202,10 @@ public function rset() public function vrfy($string) { /* Note: 251 is also a valid response code */ - if (PEAR::isError($error = $this->_put('VRFY', $string))) { + if (PEAR::isError($error = $this->put('VRFY', $string))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(array(250, 252)))) { + if (PEAR::isError($error = $this->parseResponse(array(250, 252)))) { return $error; } @@ -1209,10 +1221,10 @@ public function vrfy($string) */ public function noop() { - if (PEAR::isError($error = $this->_put('NOOP'))) { + if (PEAR::isError($error = $this->put('NOOP'))) { return $error; } - if (PEAR::isError($error = $this->_parseResponse(250))) { + if (PEAR::isError($error = $this->parseResponse(250))) { return $error; } From 1a1174e905bf47a7f147ee96b15877e1b3748e58 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Sun, 26 Jul 2015 16:36:11 +0200 Subject: [PATCH 4/7] Use default error mode in raiseError() --- Net/SMTP.php | 26 +++++++------------------- 1 file changed, 7 insertions(+), 19 deletions(-) diff --git a/Net/SMTP.php b/Net/SMTP.php index a7fa3f4..d7a83c7 100644 --- a/Net/SMTP.php +++ b/Net/SMTP.php @@ -244,10 +244,8 @@ protected function send($data) $result = $this->socket->write($data); if (!$result || PEAR::isError($result)) { - $msg = ($result) ? $result->getMessage() : "unknown error"; - return PEAR::raiseError( - "Failed to write to socket: $msg", null, PEAR_ERROR_RETURN - ); + $msg = $result ? $result->getMessage() : "unknown error"; + return PEAR::raiseError("Failed to write to socket: $msg"); } return $result; @@ -276,9 +274,7 @@ protected function put($command, $args = '') } if (strcspn($command, "\r\n") !== strlen($command)) { - return PEAR::raiseError( - 'Commands cannot contain newlines', null, PEAR_ERROR_RETURN - ); + return PEAR::raiseError('Commands cannot contain newlines'); } return $this->send($command . "\r\n"); @@ -319,9 +315,7 @@ protected function parseResponse($valid, $later = false) /* If we receive an empty line, the connection was closed. */ if (empty($line)) { $this->disconnect(); - return PEAR::raiseError( - 'Connection was closed', null, PEAR_ERROR_RETURN - ); + return PEAR::raiseError('Connection was closed'); } /* Read the code and store the rest in the arguments array. */ @@ -352,9 +346,7 @@ protected function parseResponse($valid, $later = false) return true; } - return PEAR::raiseError( - 'Invalid response code received from server', $this->code, PEAR_ERROR_RETURN - ); + return PEAR::raiseError('Invalid response code received from server', $this->code); } /** @@ -505,9 +497,7 @@ protected function negotiate() return $error; } if (PEAR::isError($this->parseResponse(250))) { - return PEAR::raiseError( - 'HELO was not accepted: ', $this->code, PEAR_ERROR_RETURN - ); + return PEAR::raiseError('HELO was not accepted', $this->code); } return true; @@ -546,9 +536,7 @@ protected function getBestAuthMethod() } } - return PEAR::raiseError( - 'No supported authentication methods', null, PEAR_ERROR_RETURN - ); + return PEAR::raiseError('No supported authentication methods'); } /** From 9aad74496eaf4ff0cc460a187fd49abb170d6b65 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Tue, 28 Jul 2015 09:55:00 +0200 Subject: [PATCH 5/7] Fix redundant CRLF sequence when it's already in the message stream --- Net/SMTP.php | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Net/SMTP.php b/Net/SMTP.php index d7a83c7..7eee40f 100644 --- a/Net/SMTP.php +++ b/Net/SMTP.php @@ -1046,6 +1046,8 @@ public function data($data, $headers = null) return $result; } } + + $last = $line; } else { /* * Break up the data by sending one chunk (up to 512k) at a time. @@ -1081,10 +1083,15 @@ public function data($data, $headers = null) /* Advance the offset to the end of this chunk. */ $offset = $end; } + + $last = $chunk; } + // Don't add another CRLF sequence if it's already in the data + $nl = substr($last, -2) == "\r\n" ? '' : "\r\n"; + /* Finally, send the DATA terminator sequence. */ - if (PEAR::isError($result = $this->send("\r\n.\r\n"))) { + if (PEAR::isError($result = $this->send("$nl.\r\n"))) { return $result; } From 870736a8ee4bea4d361eb748c00bd9e762c46e7d Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Tue, 28 Jul 2015 09:58:57 +0200 Subject: [PATCH 6/7] Revert "Fix redundant CRLF sequence when it's already in the message stream" This reverts commit 9aad74496eaf4ff0cc460a187fd49abb170d6b65. --- Net/SMTP.php | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/Net/SMTP.php b/Net/SMTP.php index 7eee40f..d7a83c7 100644 --- a/Net/SMTP.php +++ b/Net/SMTP.php @@ -1046,8 +1046,6 @@ public function data($data, $headers = null) return $result; } } - - $last = $line; } else { /* * Break up the data by sending one chunk (up to 512k) at a time. @@ -1083,15 +1081,10 @@ public function data($data, $headers = null) /* Advance the offset to the end of this chunk. */ $offset = $end; } - - $last = $chunk; } - // Don't add another CRLF sequence if it's already in the data - $nl = substr($last, -2) == "\r\n" ? '' : "\r\n"; - /* Finally, send the DATA terminator sequence. */ - if (PEAR::isError($result = $this->send("$nl.\r\n"))) { + if (PEAR::isError($result = $this->send("\r\n.\r\n"))) { return $result; } From 97c95165abf779392d0febf2700ba03bf6ff1281 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Tue, 16 Aug 2016 13:23:09 +0200 Subject: [PATCH 7/7] Workaround E_DEPRECATED warning on Auth_SASL::factory() call https://pear.php.net/bugs/bug.php?id=21033 --- Net/SMTP.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Net/SMTP.php b/Net/SMTP.php index dd822a5..c410dec 100644 --- a/Net/SMTP.php +++ b/Net/SMTP.php @@ -701,7 +701,8 @@ protected function authDigestMD5($uid, $pwd, $authz = '') return $error; } - $digest = Auth_SASL::factory('digest-md5'); + $auth_sasl = new Auth_SASL; + $digest = $auth_sasl->factory('digest-md5'); $challenge = base64_decode($this->arguments[0]); $auth_str = base64_encode( $digest->getResponse($uid, $pwd, $challenge, $this->host, "smtp", $authz)