Skip to content

Q
question2answer
Commit 739ba5dc by Scott
Options

Upgrade PHPMailer to 5.2.13

parent c6a3629c
Showing with 443 additions and 199 deletions
qa-include/vendor/PHPMailer/PHPMailerAutoload.php
<?php <?php
/** /**
* PHPMailer SPL autoloader. * PHPMailer SPL autoloader.
* PHP Version 5.0.0 * PHP Version 5
* @package PHPMailer * @package PHPMailer
* @link https://github.com/PHPMailer/PHPMailer/ * @link https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project
* @author Marcus Bointon (coolbru) <phpmailer@synchromedia.co.uk> * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
* @author Jim Jagielski (jimjag) <jimjag@gmail.com> * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
* @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net> * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
* @author Brent R. Matzelle (original founder) * @author Brent R. Matzelle (original founder)
* @copyright 2013 Marcus Bointon * @copyright 2012 - 2014 Marcus Bointon
* @copyright 2010 - 2012 Jim Jagielski * @copyright 2010 - 2012 Jim Jagielski
* @copyright 2004 - 2009 Andy Prevost * @copyright 2004 - 2009 Andy Prevost
* @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
......
qa-include/vendor/PHPMailer/class.phpmailer.php
This source diff could not be displayed because it is too large. You can view the blob instead.
qa-include/vendor/PHPMailer/class.smtp.php
<?php <?php
/** /**
* PHPMailer RFC821 SMTP email transport class. * PHPMailer RFC821 SMTP email transport class.
* Version 5.2.7 * PHP Version 5
* PHP version 5.0.0
* @category PHP
* @package PHPMailer * @package PHPMailer
* @link https://github.com/PHPMailer/PHPMailer/ * @link https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project
* @author Marcus Bointon (coolbru) <phpmailer@synchromedia.co.uk> * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
* @author Jim Jagielski (jimjag) <jimjag@gmail.com> * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
* @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net> * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
* @copyright 2013 Marcus Bointon * @author Brent R. Matzelle (original founder)
* @copyright 2004 - 2008 Andy Prevost * @copyright 2014 Marcus Bointon
* @copyright 2010 - 2012 Jim Jagielski * @copyright 2010 - 2012 Jim Jagielski
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL) * @copyright 2004 - 2009 Andy Prevost
* @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
* @note This program is distributed in the hope that it will be useful - WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE.
*/ */
/** /**
* PHPMailer RFC821 SMTP email transport class. * PHPMailer RFC821 SMTP email transport class.
* * Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.
* Implements RFC 821 SMTP commands
* and provides some utility methods for sending mail to an SMTP server.
*
* PHP Version 5.0.0
*
* @category PHP
* @package PHPMailer * @package PHPMailer
* @link https://github.com/PHPMailer/PHPMailer/blob/master/class.smtp.php * @author Chris Ryan
* @author Chris Ryan <unknown@example.com>
* @author Marcus Bointon <phpmailer@synchromedia.co.uk> * @author Marcus Bointon <phpmailer@synchromedia.co.uk>
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
*/ */
class SMTP class SMTP
{ {
/** /**
* The PHPMailer SMTP Version number. * The PHPMailer SMTP version number.
* @type string
*/ */
const VERSION = '5.2.7'; const VERSION = '5.2.13';
/** /**
* SMTP line break constant. * SMTP line break constant.
* @type string
*/ */
const CRLF = "\r\n"; const CRLF = "\r\n";
/** /**
* The SMTP port to use if one is not specified. * The SMTP port to use if one is not specified.
* @type integer
*/ */
const DEFAULT_SMTP_PORT = 25; const DEFAULT_SMTP_PORT = 25;
/** /**
* The maximum line length allowed by RFC 2822 section 2.1.1 * The maximum line length allowed by RFC 2822 section 2.1.1
* @type integer
*/ */
const MAX_LINE_LENGTH = 998; const MAX_LINE_LENGTH = 998;
/** /**
* Debug level for no output
*/
const DEBUG_OFF = 0;
/**
* Debug level to show client -> server messages
*/
const DEBUG_CLIENT = 1;
/**
* Debug level to show client -> server and server -> client messages
*/
const DEBUG_SERVER = 2;
/**
* Debug level to show connection status, client -> server and server -> client messages
*/
const DEBUG_CONNECTION = 3;
/**
* Debug level to show all messages
*/
const DEBUG_LOWLEVEL = 4;
/**
* The PHPMailer SMTP Version number. * The PHPMailer SMTP Version number.
* @type string * @type string
* @deprecated This should be a constant * @deprecated Use the `VERSION` constant instead
* @see SMTP::VERSION * @see SMTP::VERSION
*/ */
public $Version = '5.2.7'; public $Version = '5.2.13';
/** /**
* SMTP server port number. * SMTP server port number.
* @type int * @type integer
* @deprecated This is only ever ued as default value, so should be a constant * @deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead
* @see SMTP::DEFAULT_SMTP_PORT * @see SMTP::DEFAULT_SMTP_PORT
*/ */
public $SMTP_PORT = 25; public $SMTP_PORT = 25;
/** /**
* SMTP reply line ending * SMTP reply line ending.
* @type string * @type string
* @deprecated Use the class constant instead * @deprecated Use the `CRLF` constant instead
* @see SMTP::CRLF * @see SMTP::CRLF
*/ */
public $CRLF = "\r\n"; public $CRLF = "\r\n";
...@@ -80,40 +102,53 @@ class SMTP ...@@ -80,40 +102,53 @@ class SMTP
/** /**
* Debug output level. * Debug output level.
* Options: * Options:
* 0: no output * * self::DEBUG_OFF (`0`) No debug output, default
* 1: commands * * self::DEBUG_CLIENT (`1`) Client commands
* 2: data and commands * * self::DEBUG_SERVER (`2`) Client commands and server responses
* 3: as 2 plus connection status * * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status
* 4: low level data output * * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages
* @type int * @type integer
*/ */
public $do_debug = 0; public $do_debug = self::DEBUG_OFF;
/** /**
* The function/method to use for debugging output. * How to handle debug output.
* Options: 'echo', 'html' or 'error_log' * Options:
* @type string * * `echo` Output plain-text as-is, appropriate for CLI
* * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output
* * `error_log` Output to error log as configured in php.ini
*
* Alternatively, you can provide a callable expecting two params: a message string and the debug level:
* <code>
* $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
* </code>
* @type string|callable
*/ */
public $Debugoutput = 'echo'; public $Debugoutput = 'echo';
/** /**
* Whether to use VERP. * Whether to use VERP.
* @type bool * @link http://en.wikipedia.org/wiki/Variable_envelope_return_path
* @link http://www.postfix.org/VERP_README.html Info on VERP
* @type boolean
*/ */
public $do_verp = false; public $do_verp = false;
/** /**
* The timeout value for connection, in seconds. * The timeout value for connection, in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2 * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
* @type int * This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.
* @link http://tools.ietf.org/html/rfc2821#section-4.5.3.2
* @type integer
*/ */
public $Timeout = 300; public $Timeout = 300;
/** /**
* The SMTP timelimit value for reads, in seconds. * How long to wait for commands to complete, in seconds.
* @type int * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
* @type integer
*/ */
public $Timelimit = 30; public $Timelimit = 300;
/** /**
* The socket for the server connection. * The socket for the server connection.
...@@ -122,43 +157,58 @@ class SMTP ...@@ -122,43 +157,58 @@ class SMTP
protected $smtp_conn; protected $smtp_conn;
/** /**
* Error message, if any, for the last call. * Error information, if any, for the last SMTP command.
* @type string * @type array
*/ */
protected $error = ''; protected $error = array(
'error' => '',
'detail' => '',
'smtp_code' => '',
'smtp_code_ex' => ''
);
/** /**
* The reply the server sent to us for HELO. * The reply the server sent to us for HELO.
* @type string * If null, no HELO string has yet been received.
* @type string|null
*/ */
protected $helo_rply = ''; protected $helo_rply = null;
/** /**
* The most recent reply received from the server. * The set of SMTP extensions sent in reply to EHLO command.
* @type string * Indexes of the array are extension names.
* Value at index 'HELO' or 'EHLO' (according to command that was sent)
* represents the server name. In case of HELO it is the only element of the array.
* Other values can be boolean TRUE or an array containing extension options.
* If null, no HELO/EHLO string has yet been received.
* @type array|null
*/ */
protected $last_reply = ''; protected $server_caps = null;
/** /**
* Constructor. * The most recent reply received from the server.
* @access public * @type string
*/ */
public function __construct() protected $last_reply = '';
{
$this->smtp_conn = 0;
$this->error = null;
$this->helo_rply = null;
$this->do_debug = 0;
}
/** /**
* Output debugging info via a user-selected method. * Output debugging info via a user-selected method.
* @see SMTP::$Debugoutput
* @see SMTP::$do_debug
* @param string $str Debug string to output * @param string $str Debug string to output
* @param integer $level The debug level of this message; see DEBUG_* constants
* @return void * @return void
*/ */
protected function edebug($str) protected function edebug($str, $level = 0)
{ {
if ($level > $this->do_debug) {
return;
}
//Avoid clash with built-in function names
if (!in_array($this->Debugoutput, array('error_log', 'html', 'echo')) and is_callable($this->Debugoutput)) {
call_user_func($this->Debugoutput, $str, $this->do_debug);
return;
}
switch ($this->Debugoutput) { switch ($this->Debugoutput) {
case 'error_log': case 'error_log':
//Don't output, just log //Don't output, just log
...@@ -175,38 +225,52 @@ class SMTP ...@@ -175,38 +225,52 @@ class SMTP
break; break;
case 'echo': case 'echo':
default: default:
echo gmdate('Y-m-d H:i:s')."\t".trim($str)."\n"; //Normalize line breaks
$str = preg_replace('/(\r\n|\r|\n)/ms', "\n", $str);
echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
"\n",
"\n \t ",
trim($str)
)."\n";
} }
} }
/** /**
* Connect to an SMTP server. * Connect to an SMTP server.
* @param string $host SMTP server IP or host name * @param string $host SMTP server IP or host name
* @param int $port The port number to connect to * @param integer $port The port number to connect to
* @param int $timeout How long to wait for the connection to open * @param integer $timeout How long to wait for the connection to open
* @param array $options An array of options for stream_context_create() * @param array $options An array of options for stream_context_create()
* @access public * @access public
* @return bool * @return boolean
*/ */
public function connect($host, $port = null, $timeout = 30, $options = array()) public function connect($host, $port = null, $timeout = 30, $options = array())
{ {
static $streamok;
//This is enabled by default since 5.0.0 but some providers disable it
//Check this once and cache the result
if (is_null($streamok)) {
$streamok = function_exists('stream_socket_client');
}
// Clear errors to avoid confusion // Clear errors to avoid confusion
$this->error = null; $this->setError('');
// Make sure we are __not__ connected // Make sure we are __not__ connected
if ($this->connected()) { if ($this->connected()) {
// Already connected, generate error // Already connected, generate error
$this->error = array('error' => 'Already connected to a server'); $this->setError('Already connected to a server');
return false; return false;
} }
if (empty($port)) { if (empty($port)) {
$port = self::DEFAULT_SMTP_PORT; $port = self::DEFAULT_SMTP_PORT;
} }
// Connect to the SMTP server // Connect to the SMTP server
if ($this->do_debug >= 3) { $this->edebug(
$this->edebug('Connection: opening'); "Connection: opening to $host:$port, timeout=$timeout, options=".var_export($options, true),
} self::DEBUG_CONNECTION
);
$errno = 0; $errno = 0;
$errstr = ''; $errstr = '';
if ($streamok) {
$socket_context = stream_context_create($options); $socket_context = stream_context_create($options);
//Suppress errors; connection failures are handled at a higher level //Suppress errors; connection failures are handled at a higher level
$this->smtp_conn = @stream_socket_client( $this->smtp_conn = @stream_socket_client(
...@@ -217,45 +281,55 @@ class SMTP ...@@ -217,45 +281,55 @@ class SMTP
STREAM_CLIENT_CONNECT, STREAM_CLIENT_CONNECT,
$socket_context $socket_context
); );
} else {
//Fall back to fsockopen which should work in more places, but is missing some features
$this->edebug(
"Connection: stream_socket_client not available, falling back to fsockopen",
self::DEBUG_CONNECTION
);
$this->smtp_conn = fsockopen(
$host,
$port,
$errno,
$errstr,
$timeout
);
}
// Verify we connected properly // Verify we connected properly
if (empty($this->smtp_conn)) { if (!is_resource($this->smtp_conn)) {
$this->error = array( $this->setError(
'error' => 'Failed to connect to server', 'Failed to connect to server',
'errno' => $errno, $errno,
'errstr' => $errstr $errstr
); );
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'SMTP ERROR: ' . $this->error['error'] 'SMTP ERROR: ' . $this->error['error']
. ": $errstr ($errno)" . ": $errstr ($errno)",
self::DEBUG_CLIENT
); );
}
return false; return false;
} }
if ($this->do_debug >= 3) { $this->edebug('Connection: opened', self::DEBUG_CONNECTION);
$this->edebug('Connection: opened');
}
// SMTP server can take longer to respond, give longer timeout for first read // SMTP server can take longer to respond, give longer timeout for first read
// Windows does not have support for this timeout function // Windows does not have support for this timeout function
if (substr(PHP_OS, 0, 3) != 'WIN') { if (substr(PHP_OS, 0, 3) != 'WIN') {
$max = ini_get('max_execution_time'); $max = ini_get('max_execution_time');
if ($max != 0 && $timeout > $max) { // Don't bother if unlimited // Don't bother if unlimited
if ($max != 0 && $timeout > $max) {
@set_time_limit($timeout); @set_time_limit($timeout);
} }
stream_set_timeout($this->smtp_conn, $timeout, 0); stream_set_timeout($this->smtp_conn, $timeout, 0);
} }
// Get any announcement // Get any announcement
$announce = $this->get_lines(); $announce = $this->get_lines();
if ($this->do_debug >= 2) { $this->edebug('SERVER -> CLIENT: ' . $announce, self::DEBUG_SERVER);
$this->edebug('SERVER -> CLIENT: ' . $announce);
}
return true; return true;
} }
/** /**
* Initiate a TLS (encrypted) session. * Initiate a TLS (encrypted) session.
* @access public * @access public
* @return bool * @return boolean
*/ */
public function startTLS() public function startTLS()
{ {
...@@ -279,20 +353,60 @@ class SMTP ...@@ -279,20 +353,60 @@ class SMTP
* @see hello() * @see hello()
* @param string $username The user name * @param string $username The user name
* @param string $password The password * @param string $password The password
* @param string $authtype The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5) * @param string $authtype The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5, XOAUTH2)
* @param string $realm The auth realm for NTLM * @param string $realm The auth realm for NTLM
* @param string $workstation The auth workstation for NTLM * @param string $workstation The auth workstation for NTLM
* @access public * @param null|OAuth $OAuth An optional OAuth instance (@see PHPMailerOAuth)
* @return bool True if successfully authenticated. * @return bool True if successfully authenticated.* @access public
*/ */
public function authenticate( public function authenticate(
$username, $username,
$password, $password,
$authtype = 'LOGIN', $authtype = null,
$realm = '', $realm = '',
$workstation = '' $workstation = '',
$OAuth = null
) { ) {
if (!$this->server_caps) {
$this->setError('Authentication is not allowed before HELO/EHLO');
return false;
}
if (array_key_exists('EHLO', $this->server_caps)) {
// SMTP extensions are available. Let's try to find a proper authentication method
if (!array_key_exists('AUTH', $this->server_caps)) {
$this->setError('Authentication is not allowed at this stage');
// 'at this stage' means that auth may be allowed after the stage changes
// e.g. after STARTTLS
return false;
}
self::edebug('Auth method requested: ' . ($authtype ? $authtype : 'UNKNOWN'), self::DEBUG_LOWLEVEL);
self::edebug(
'Auth methods available on the server: ' . implode(',', $this->server_caps['AUTH']),
self::DEBUG_LOWLEVEL
);
if (empty($authtype)) {
foreach (array('LOGIN', 'CRAM-MD5', 'NTLM', 'PLAIN', 'XOAUTH2') as $method) {
if (in_array($method, $this->server_caps['AUTH'])) {
$authtype = $method;
break;
}
}
if (empty($authtype)) { if (empty($authtype)) {
$this->setError('No supported authentication methods found');
return false;
}
self::edebug('Auth method selected: '.$authtype, self::DEBUG_LOWLEVEL);
}
if (!in_array($authtype, $this->server_caps['AUTH'])) {
$this->setError("The requested authentication method \"$authtype\" is not supported by the server");
return false;
}
} elseif (empty($authtype)) {
$authtype = 'LOGIN'; $authtype = 'LOGIN';
} }
switch ($authtype) { switch ($authtype) {
...@@ -323,6 +437,19 @@ class SMTP ...@@ -323,6 +437,19 @@ class SMTP
return false; return false;
} }
break; break;
case 'XOAUTH2':
//If the OAuth Instance is not set. Can be a case when PHPMailer is used
//instead of PHPMailerOAuth
if (is_null($OAuth)) {
return false;
}
$oauth = $OAuth->getOauth64();
// Start authentication
if (!$this->sendCommand('AUTH', 'AUTH XOAUTH2 ' . $oauth, 235)) {
return false;
}
break;
case 'NTLM': case 'NTLM':
/* /*
* ntlm_sasl_client.php * ntlm_sasl_client.php
...@@ -333,17 +460,16 @@ class SMTP ...@@ -333,17 +460,16 @@ class SMTP
* PROTOCOL Docs http://curl.haxx.se/rfc/ntlm.html#ntlmSmtpAuthentication * PROTOCOL Docs http://curl.haxx.se/rfc/ntlm.html#ntlmSmtpAuthentication
*/ */
require_once 'extras/ntlm_sasl_client.php'; require_once 'extras/ntlm_sasl_client.php';
$temp = new stdClass(); $temp = new stdClass;
$ntlm_client = new ntlm_sasl_client_class; $ntlm_client = new ntlm_sasl_client_class;
//Check that functions are available //Check that functions are available
if (!$ntlm_client->Initialize($temp)) { if (!$ntlm_client->Initialize($temp)) {
$this->error = array('error' => $temp->error); $this->setError($temp->error);
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'You need to enable some modules in your php.ini file: ' 'You need to enable some modules in your php.ini file: '
. $this->error['error'] . $this->error['error'],
self::DEBUG_CLIENT
); );
}
return false; return false;
} }
//msg1 //msg1
...@@ -374,7 +500,6 @@ class SMTP ...@@ -374,7 +500,6 @@ class SMTP
); );
// send encoded username // send encoded username
return $this->sendCommand('Username', base64_encode($msg3), 235); return $this->sendCommand('Username', base64_encode($msg3), 235);
break;
case 'CRAM-MD5': case 'CRAM-MD5':
// Start authentication // Start authentication
if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) { if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) {
...@@ -388,7 +513,9 @@ class SMTP ...@@ -388,7 +513,9 @@ class SMTP
// send encoded credentials // send encoded credentials
return $this->sendCommand('Username', base64_encode($response), 235); return $this->sendCommand('Username', base64_encode($response), 235);
break; default:
$this->setError("Authentication method \"$authtype\" is not supported");
return false;
} }
return true; return true;
} }
...@@ -414,15 +541,15 @@ class SMTP ...@@ -414,15 +541,15 @@ class SMTP
// RFC 2104 HMAC implementation for php. // RFC 2104 HMAC implementation for php.
// Creates an md5 HMAC. // Creates an md5 HMAC.
// Eliminates the need to install mhash to compute a HMAC // Eliminates the need to install mhash to compute a HMAC
// Hacked by Lance Rushing // by Lance Rushing
$b = 64; // byte length for md5 $bytelen = 64; // byte length for md5
if (strlen($key) > $b) { if (strlen($key) > $bytelen) {
$key = pack('H*', md5($key)); $key = pack('H*', md5($key));
} }
$key = str_pad($key, $b, chr(0x00)); $key = str_pad($key, $bytelen, chr(0x00));
$ipad = str_pad('', $b, chr(0x36)); $ipad = str_pad('', $bytelen, chr(0x36));
$opad = str_pad('', $b, chr(0x5c)); $opad = str_pad('', $bytelen, chr(0x5c));
$k_ipad = $key ^ $ipad; $k_ipad = $key ^ $ipad;
$k_opad = $key ^ $opad; $k_opad = $key ^ $opad;
...@@ -432,19 +559,18 @@ class SMTP ...@@ -432,19 +559,18 @@ class SMTP
/** /**
* Check connection state. * Check connection state.
* @access public * @access public
* @return bool True if connected. * @return boolean True if connected.
*/ */
public function connected() public function connected()
{ {
if (!empty($this->smtp_conn)) { if (is_resource($this->smtp_conn)) {
$sock_status = stream_get_meta_data($this->smtp_conn); $sock_status = stream_get_meta_data($this->smtp_conn);
if ($sock_status['eof']) { if ($sock_status['eof']) {
// the socket is valid but we are not connected // The socket is valid but we are not connected
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'SMTP NOTICE: EOF caught while checking if connected' 'SMTP NOTICE: EOF caught while checking if connected',
self::DEBUG_CLIENT
); );
}
$this->close(); $this->close();
return false; return false;
} }
...@@ -462,15 +588,14 @@ class SMTP ...@@ -462,15 +588,14 @@ class SMTP
*/ */
public function close() public function close()
{ {
$this->error = null; // so there is no confusion $this->setError('');
$this->server_caps = null;
$this->helo_rply = null; $this->helo_rply = null;
if (!empty($this->smtp_conn)) { if (is_resource($this->smtp_conn)) {
// close the connection and cleanup // close the connection and cleanup
fclose($this->smtp_conn); fclose($this->smtp_conn);
if ($this->do_debug >= 3) { $this->smtp_conn = null; //Makes for cleaner serialization
$this->edebug('Connection: closed'); $this->edebug('Connection: closed', self::DEBUG_CONNECTION);
}
$this->smtp_conn = 0;
} }
} }
...@@ -484,13 +609,15 @@ class SMTP ...@@ -484,13 +609,15 @@ class SMTP
* Implements rfc 821: DATA <CRLF> * Implements rfc 821: DATA <CRLF>
* @param string $msg_data Message data to send * @param string $msg_data Message data to send
* @access public * @access public
* @return bool * @return boolean
*/ */
public function data($msg_data) public function data($msg_data)
{ {
//This will use the standard timelimit
if (!$this->sendCommand('DATA', 'DATA', 354)) { if (!$this->sendCommand('DATA', 'DATA', 354)) {
return false; return false;
} }
/* The server is ready to accept data! /* The server is ready to accept data!
* According to rfc821 we should not send more than 1000 characters on a single line (including the CRLF) * According to rfc821 we should not send more than 1000 characters on a single line (including the CRLF)
* so we will break the data up into lines by \r and/or \n then if needed we will break each of those into * so we will break the data up into lines by \r and/or \n then if needed we will break each of those into
...@@ -518,13 +645,14 @@ class SMTP ...@@ -518,13 +645,14 @@ class SMTP
if ($in_headers and $line == '') { if ($in_headers and $line == '') {
$in_headers = false; $in_headers = false;
} }
// ok we need to break this line up into several smaller lines //Break this line up into several smaller lines if it's too long
//This is a small micro-optimisation: isset($str[$len]) is equivalent to (strlen($str) > $len) //Micro-optimisation: isset($str[$len]) is faster than (strlen($str) > $len),
while (isset($line[self::MAX_LINE_LENGTH])) { while (isset($line[self::MAX_LINE_LENGTH])) {
//Working backwards, try to find a space within the last MAX_LINE_LENGTH chars of the line to break on //Working backwards, try to find a space within the last MAX_LINE_LENGTH chars of the line to break on
//so as to avoid breaking in the middle of a word //so as to avoid breaking in the middle of a word
$pos = strrpos(substr($line, 0, self::MAX_LINE_LENGTH), ' '); $pos = strrpos(substr($line, 0, self::MAX_LINE_LENGTH), ' ');
if (!$pos) { //Deliberately matches both false and 0 //Deliberately matches both false and 0
if (!$pos) {
//No nice break found, add a hard break //No nice break found, add a hard break
$pos = self::MAX_LINE_LENGTH - 1; $pos = self::MAX_LINE_LENGTH - 1;
$lines_out[] = substr($line, 0, $pos); $lines_out[] = substr($line, 0, $pos);
...@@ -535,16 +663,14 @@ class SMTP ...@@ -535,16 +663,14 @@ class SMTP
//Move along by the amount we dealt with //Move along by the amount we dealt with
$line = substr($line, $pos + 1); $line = substr($line, $pos + 1);
} }
/* If processing headers add a LWSP-char to the front of new line //If processing headers add a LWSP-char to the front of new line RFC822 section 3.1.1
* RFC822 section 3.1.1
*/
if ($in_headers) { if ($in_headers) {
$line = "\t" . $line; $line = "\t" . $line;
} }
} }
$lines_out[] = $line; $lines_out[] = $line;
// Send the lines to the server //Send the lines to the server
foreach ($lines_out as $line_out) { foreach ($lines_out as $line_out) {
//RFC2821 section 4.5.2 //RFC2821 section 4.5.2
if (!empty($line_out) and $line_out[0] == '.') { if (!empty($line_out) and $line_out[0] == '.') {
...@@ -554,8 +680,14 @@ class SMTP ...@@ -554,8 +680,14 @@ class SMTP
} }
} }
// Message data has been sent, complete the command //Message data has been sent, complete the command
return $this->sendCommand('DATA END', '.', 250); //Increase timelimit for end of DATA command
$savetimelimit = $this->Timelimit;
$this->Timelimit = $this->Timelimit * 2;
$result = $this->sendCommand('DATA END', '.', 250);
//Restore timelimit
$this->Timelimit = $savetimelimit;
return $result;
} }
/** /**
...@@ -566,12 +698,12 @@ class SMTP ...@@ -566,12 +698,12 @@ class SMTP
* and RFC 2821 EHLO. * and RFC 2821 EHLO.
* @param string $host The host name or IP to connect to * @param string $host The host name or IP to connect to
* @access public * @access public
* @return bool * @return boolean
*/ */
public function hello($host = '') public function hello($host = '')
{ {
// Try extended hello first (RFC 2821) //Try extended hello first (RFC 2821)
return (bool)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host)); return (boolean)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host));
} }
/** /**
...@@ -581,16 +713,63 @@ class SMTP ...@@ -581,16 +713,63 @@ class SMTP
* @param string $hello The HELO string * @param string $hello The HELO string
* @param string $host The hostname to say we are * @param string $host The hostname to say we are
* @access protected * @access protected
* @return bool * @return boolean
*/ */
protected function sendHello($hello, $host) protected function sendHello($hello, $host)
{ {
$noerror = $this->sendCommand($hello, $hello . ' ' . $host, 250); $noerror = $this->sendCommand($hello, $hello . ' ' . $host, 250);
$this->helo_rply = $this->last_reply; $this->helo_rply = $this->last_reply;
if ($noerror) {
$this->parseHelloFields($hello);
} else {
$this->server_caps = null;
}
return $noerror; return $noerror;
} }
/** /**
* Parse a reply to HELO/EHLO command to discover server extensions.
* In case of HELO, the only parameter that can be discovered is a server name.
* @access protected
* @param string $type - 'HELO' or 'EHLO'
*/
protected function parseHelloFields($type)
{
$this->server_caps = array();
$lines = explode("\n", $this->last_reply);
foreach ($lines as $n => $s) {
//First 4 chars contain response code followed by - or space
$s = trim(substr($s, 4));
if (empty($s)) {
continue;
}
$fields = explode(' ', $s);
if (!empty($fields)) {
if (!$n) {
$name = $type;
$fields = $fields[0];
} else {
$name = array_shift($fields);
switch ($name) {
case 'SIZE':
$fields = ($fields ? $fields[0] : 0);
break;
case 'AUTH':
if (!is_array($fields)) {
$fields = array();
}
break;
default:
$fields = true;
}
}
$this->server_caps[$name] = $fields;
}
}
}
/**
* Send an SMTP MAIL command. * Send an SMTP MAIL command.
* Starts a mail transaction from the email address specified in * Starts a mail transaction from the email address specified in
* $from. Returns true if successful or false otherwise. If True * $from. Returns true if successful or false otherwise. If True
...@@ -599,7 +778,7 @@ class SMTP ...@@ -599,7 +778,7 @@ class SMTP
* Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF> * Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
* @param string $from Source address of this message * @param string $from Source address of this message
* @access public * @access public
* @return bool * @return boolean
*/ */
public function mail($from) public function mail($from)
{ {
...@@ -615,35 +794,35 @@ class SMTP ...@@ -615,35 +794,35 @@ class SMTP
* Send an SMTP QUIT command. * Send an SMTP QUIT command.
* Closes the socket if there is no error or the $close_on_error argument is true. * Closes the socket if there is no error or the $close_on_error argument is true.
* Implements from rfc 821: QUIT <CRLF> * Implements from rfc 821: QUIT <CRLF>
* @param bool $close_on_error Should the connection close if an error occurs? * @param boolean $close_on_error Should the connection close if an error occurs?
* @access public * @access public
* @return bool * @return boolean
*/ */
public function quit($close_on_error = true) public function quit($close_on_error = true)
{ {
$noerror = $this->sendCommand('QUIT', 'QUIT', 221); $noerror = $this->sendCommand('QUIT', 'QUIT', 221);
$e = $this->error; //Save any error $err = $this->error; //Save any error
if ($noerror or $close_on_error) { if ($noerror or $close_on_error) {
$this->close(); $this->close();
$this->error = $e; //Restore any error from the quit command $this->error = $err; //Restore any error from the quit command
} }
return $noerror; return $noerror;
} }
/** /**
* Send an SMTP RCPT command. * Send an SMTP RCPT command.
* Sets the TO argument to $to. * Sets the TO argument to $toaddr.
* Returns true if the recipient was accepted false if it was rejected. * Returns true if the recipient was accepted false if it was rejected.
* Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF> * Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
* @param string $to The address the message is being sent to * @param string $toaddr The address the message is being sent to
* @access public * @access public
* @return bool * @return boolean
*/ */
public function recipient($to) public function recipient($toaddr)
{ {
return $this->sendCommand( return $this->sendCommand(
'RCPT TO', 'RCPT TO',
'RCPT TO:<' . $to . '>', 'RCPT TO:<' . $toaddr . '>',
array(250, 251) array(250, 251)
); );
} }
...@@ -653,7 +832,7 @@ class SMTP ...@@ -653,7 +832,7 @@ class SMTP
* Abort any transaction that is currently in progress. * Abort any transaction that is currently in progress.
* Implements rfc 821: RSET <CRLF> * Implements rfc 821: RSET <CRLF>
* @access public * @access public
* @return bool True on success. * @return boolean True on success.
*/ */
public function reset() public function reset()
{ {
...@@ -664,44 +843,54 @@ class SMTP ...@@ -664,44 +843,54 @@ class SMTP
* Send a command to an SMTP server and check its return code. * Send a command to an SMTP server and check its return code.
* @param string $command The command name - not sent to the server * @param string $command The command name - not sent to the server
* @param string $commandstring The actual command to send * @param string $commandstring The actual command to send
* @param int|array $expect One or more expected integer success codes * @param integer|array $expect One or more expected integer success codes
* @access protected * @access protected
* @return bool True on success. * @return boolean True on success.
*/ */
protected function sendCommand($command, $commandstring, $expect) protected function sendCommand($command, $commandstring, $expect)
{ {
if (!$this->connected()) { if (!$this->connected()) {
$this->error = array( $this->setError("Called $command without being connected");
'error' => "Called $command without being connected"
);
return false; return false;
} }
$this->client_send($commandstring . self::CRLF); $this->client_send($commandstring . self::CRLF);
$reply = $this->get_lines(); $this->last_reply = $this->get_lines();
$code = substr($reply, 0, 3); // Fetch SMTP code and possible error code explanation
$matches = array();
if ($this->do_debug >= 2) { if (preg_match("/^([0-9]{3})[ -](?:([0-9]\\.[0-9]\\.[0-9]) )?/", $this->last_reply, $matches)) {
$this->edebug('SERVER -> CLIENT: ' . $reply); $code = $matches[1];
$code_ex = (count($matches) > 2 ? $matches[2] : null);
// Cut off error code from each response line
$detail = preg_replace(
"/{$code}[ -]".($code_ex ? str_replace('.', '\\.', $code_ex).' ' : '')."/m",
'',
$this->last_reply
);
} else {
// Fall back to simple parsing if regex fails
$code = substr($this->last_reply, 0, 3);
$code_ex = null;
$detail = substr($this->last_reply, 4);
} }
$this->edebug('SERVER -> CLIENT: ' . $this->last_reply, self::DEBUG_SERVER);
if (!in_array($code, (array)$expect)) { if (!in_array($code, (array)$expect)) {
$this->last_reply = null; $this->setError(
$this->error = array( "$command command failed",
'error' => "$command command failed", $detail,
'smtp_code' => $code, $code,
'detail' => substr($reply, 4) $code_ex
); );
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'SMTP ERROR: ' . $this->error['error'] . ': ' . $reply 'SMTP ERROR: ' . $this->error['error'] . ': ' . $this->last_reply,
self::DEBUG_CLIENT
); );
}
return false; return false;
} }
$this->last_reply = $reply; $this->setError('');
$this->error = null;
return true; return true;
} }
...@@ -716,7 +905,7 @@ class SMTP ...@@ -716,7 +905,7 @@ class SMTP
* Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF> * Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
* @param string $from The address the message is from * @param string $from The address the message is from
* @access public * @access public
* @return bool * @return boolean
*/ */
public function sendAndMail($from) public function sendAndMail($from)
{ {
...@@ -727,7 +916,7 @@ class SMTP ...@@ -727,7 +916,7 @@ class SMTP
* Send an SMTP VRFY command. * Send an SMTP VRFY command.
* @param string $name The name to verify * @param string $name The name to verify
* @access public * @access public
* @return bool * @return boolean
*/ */
public function verify($name) public function verify($name)
{ {
...@@ -738,7 +927,7 @@ class SMTP ...@@ -738,7 +927,7 @@ class SMTP
* Send an SMTP NOOP command. * Send an SMTP NOOP command.
* Used to keep keep-alives alive, doesn't actually do anything * Used to keep keep-alives alive, doesn't actually do anything
* @access public * @access public
* @return bool * @return boolean
*/ */
public function noop() public function noop()
{ {
...@@ -752,16 +941,12 @@ class SMTP ...@@ -752,16 +941,12 @@ class SMTP
* and _may_ be implemented in future * and _may_ be implemented in future
* Implements from rfc 821: TURN <CRLF> * Implements from rfc 821: TURN <CRLF>
* @access public * @access public
* @return bool * @return boolean
*/ */
public function turn() public function turn()
{ {
$this->error = array( $this->setError('The SMTP TURN command is not implemented');
'error' => 'The SMTP TURN command is not implemented' $this->edebug('SMTP NOTICE: ' . $this->error['error'], self::DEBUG_CLIENT);
);
if ($this->do_debug >= 1) {
$this->edebug('SMTP NOTICE: ' . $this->error['error']);
}
return false; return false;
} }
...@@ -769,13 +954,11 @@ class SMTP ...@@ -769,13 +954,11 @@ class SMTP
* Send raw data to the server. * Send raw data to the server.
* @param string $data The data to send * @param string $data The data to send
* @access public * @access public
* @return int|bool The number of bytes sent to the server or false on error * @return integer|boolean The number of bytes sent to the server or false on error
*/ */
public function client_send($data) public function client_send($data)
{ {
if ($this->do_debug >= 1) { $this->edebug("CLIENT -> SERVER: $data", self::DEBUG_CLIENT);
$this->edebug("CLIENT -> SERVER: $data");
}
return fwrite($this->smtp_conn, $data); return fwrite($this->smtp_conn, $data);
} }
...@@ -790,6 +973,57 @@ class SMTP ...@@ -790,6 +973,57 @@ class SMTP
} }
/** /**
* Get SMTP extensions available on the server
* @access public
* @return array|null
*/
public function getServerExtList()
{
return $this->server_caps;
}
/**
* A multipurpose method
* The method works in three ways, dependent on argument value and current state
* 1. HELO/EHLO was not sent - returns null and set up $this->error
* 2. HELO was sent
* $name = 'HELO': returns server name
* $name = 'EHLO': returns boolean false
* $name = any string: returns null and set up $this->error
* 3. EHLO was sent
* $name = 'HELO'|'EHLO': returns server name
* $name = any string: if extension $name exists, returns boolean True
* or its options. Otherwise returns boolean False
* In other words, one can use this method to detect 3 conditions:
* - null returned: handshake was not or we don't know about ext (refer to $this->error)
* - false returned: the requested feature exactly not exists
* - positive value returned: the requested feature exists
* @param string $name Name of SMTP extension or 'HELO'|'EHLO'
* @return mixed
*/
public function getServerExt($name)
{
if (!$this->server_caps) {
$this->setError('No HELO/EHLO was sent');
return null;
}
// the tight logic knot ;)
if (!array_key_exists($name, $this->server_caps)) {
if ($name == 'HELO') {
return $this->server_caps['EHLO'];
}
if ($name == 'EHLO' || array_key_exists('EHLO', $this->server_caps)) {
return false;
}
$this->setError('HELO handshake was used. Client knows nothing about server extensions');
return null;
}
return $this->server_caps[$name];
}
/**
* Get the last reply from the server. * Get the last reply from the server.
* @access public * @access public
* @return string * @return string
...@@ -822,14 +1056,9 @@ class SMTP ...@@ -822,14 +1056,9 @@ class SMTP
} }
while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) { while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {
$str = @fgets($this->smtp_conn, 515); $str = @fgets($this->smtp_conn, 515);
if ($this->do_debug >= 4) { $this->edebug("SMTP -> get_lines(): \$data is \"$data\"", self::DEBUG_LOWLEVEL);
$this->edebug("SMTP -> get_lines(): \$data was \"$data\""); $this->edebug("SMTP -> get_lines(): \$str is \"$str\"", self::DEBUG_LOWLEVEL);
$this->edebug("SMTP -> get_lines(): \$str is \"$str\"");
}
$data .= $str; $data .= $str;
if ($this->do_debug >= 4) {
$this->edebug("SMTP -> get_lines(): \$data is \"$data\"");
}
// If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen // If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen
if ((isset($str[3]) and $str[3] == ' ')) { if ((isset($str[3]) and $str[3] == ' ')) {
break; break;
...@@ -837,21 +1066,19 @@ class SMTP ...@@ -837,21 +1066,19 @@ class SMTP
// Timed-out? Log and break // Timed-out? Log and break
$info = stream_get_meta_data($this->smtp_conn); $info = stream_get_meta_data($this->smtp_conn);
if ($info['timed_out']) { if ($info['timed_out']) {
if ($this->do_debug >= 4) {
$this->edebug( $this->edebug(
'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)' 'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)',
self::DEBUG_LOWLEVEL
); );
}
break; break;
} }
// Now check if reads took too long // Now check if reads took too long
if ($endtime and time() > $endtime) { if ($endtime and time() > $endtime) {
if ($this->do_debug >= 4) {
$this->edebug( $this->edebug(
'SMTP -> get_lines(): timelimit reached ('. 'SMTP -> get_lines(): timelimit reached ('.
$this->Timelimit . ' sec)' $this->Timelimit . ' sec)',
self::DEBUG_LOWLEVEL
); );
}
break; break;
} }
} }
...@@ -860,7 +1087,7 @@ class SMTP ...@@ -860,7 +1087,7 @@ class SMTP
/** /**
* Enable or disable VERP address generation. * Enable or disable VERP address generation.
* @param bool $enabled * @param boolean $enabled
*/ */
public function setVerp($enabled = false) public function setVerp($enabled = false)
{ {
...@@ -869,7 +1096,7 @@ class SMTP ...@@ -869,7 +1096,7 @@ class SMTP
/** /**
* Get VERP address generation mode. * Get VERP address generation mode.
* @return bool * @return boolean
*/ */
public function getVerp() public function getVerp()
{ {
...@@ -877,8 +1104,25 @@ class SMTP ...@@ -877,8 +1104,25 @@ class SMTP
} }
/** /**
* Set error messages and codes.
* @param string $message The error message
* @param string $detail Further detail on the error
* @param string $smtp_code An associated SMTP error code
* @param string $smtp_code_ex Extended SMTP code
*/
protected function setError($message, $detail = '', $smtp_code = '', $smtp_code_ex = '')
{
$this->error = array(
'error' => $message,
'detail' => $detail,
'smtp_code' => $smtp_code,
'smtp_code_ex' => $smtp_code_ex
);
}
/**
* Set debug output method. * Set debug output method.
* @param string $method The function/method to use for debugging output. * @param string|callable $method The name of the mechanism to use for debugging output, or a callable to handle it.
*/ */
public function setDebugOutput($method = 'echo') public function setDebugOutput($method = 'echo')
{ {
...@@ -896,7 +1140,7 @@ class SMTP ...@@ -896,7 +1140,7 @@ class SMTP
/** /**
* Set debug output level. * Set debug output level.
* @param int $level * @param integer $level
*/ */
public function setDebugLevel($level = 0) public function setDebugLevel($level = 0)
{ {
...@@ -905,7 +1149,7 @@ class SMTP ...@@ -905,7 +1149,7 @@ class SMTP
/** /**
* Get debug output level. * Get debug output level.
* @return int * @return integer
*/ */
public function getDebugLevel() public function getDebugLevel()
{ {
...@@ -914,7 +1158,7 @@ class SMTP ...@@ -914,7 +1158,7 @@ class SMTP
/** /**
* Set SMTP timeout. * Set SMTP timeout.
* @param int $timeout * @param integer $timeout
*/ */
public function setTimeout($timeout = 0) public function setTimeout($timeout = 0)
{ {
...@@ -923,7 +1167,7 @@ class SMTP ...@@ -923,7 +1167,7 @@ class SMTP
/** /**
* Get SMTP timeout. * Get SMTP timeout.
* @return int * @return integer
*/ */
public function getTimeout() public function getTimeout()
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment