WB 2.11.0

<?php

/**

 * PHPMailer RFC821 SMTP email transport class.

 * PHP Version 5

 * @package PHPMailer

 * @link https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project

 * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>

 * @author Jim Jagielski (jimjag) <jimjag@gmail.com>

 * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>

 * @author Brent R. Matzelle (original founder)

 * @copyright 2014 Marcus Bointon

 * @copyright 2010 - 2012 Jim Jagielski

 * @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.

 * Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.

 * @package PHPMailer

 * @author Chris Ryan

 * @author Marcus Bointon <phpmailer@synchromedia.co.uk>

 */

class SMTP

{

    /**

     * The PHPMailer SMTP version number.

     * @var string

     */

    const VERSION = '5.2.22';

    /**

     * SMTP line break constant.

     * @var string

     */

    const CRLF = "\r\n";

    /**

     * The SMTP port to use if one is not specified.

     * @var integer

     */

    const DEFAULT_SMTP_PORT = 25;

    /**

     * The maximum line length allowed by RFC 2822 section 2.1.1

     * @var integer

     */

    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.

     * @var string

     * @deprecated Use the `VERSION` constant instead

     * @see SMTP::VERSION

     */

    public $Version = '5.2.22';

    /**

     * SMTP server port number.

     * @var integer

     * @deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead

     * @see SMTP::DEFAULT_SMTP_PORT

     */

    public $SMTP_PORT = 25;

    /**

     * SMTP reply line ending.

     * @var string

     * @deprecated Use the `CRLF` constant instead

     * @see SMTP::CRLF

     */

    public $CRLF = "\r\n";

    /**

     * Debug output level.

     * Options:

     * * self::DEBUG_OFF (`0`) No debug output, default

     * * self::DEBUG_CLIENT (`1`) Client commands

     * * self::DEBUG_SERVER (`2`) Client commands and server responses

     * * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status

     * * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages

     * @var integer

     */

    public $do_debug = self::DEBUG_OFF;

    /**

     * How to handle debug output.

     * Options:

     * * `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>

     * @var string|callable

     */

    public $Debugoutput = 'echo';

    /**

     * Whether to use VERP.

     * @link http://en.wikipedia.org/wiki/Variable_envelope_return_path

     * @link http://www.postfix.org/VERP_README.html Info on VERP

     * @var boolean

     */

    public $do_verp = false;

    /**

     * The timeout value for connection, in seconds.

     * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2

     * 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

     * @var integer

     */

    public $Timeout = 300;

    /**

     * How long to wait for commands to complete, in seconds.

     * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2

     * @var integer

     */

    public $Timelimit = 300;

	/**

	 * @var array patterns to extract smtp transaction id from smtp reply

	 * Only first capture group will be use, use non-capturing group to deal with it

	 * Extend this class to override this property to fulfil your needs.

	 */

	protected $smtp_transaction_id_patterns = array(

		'exim' => '/[0-9]{3} OK id=(.*)/',

		'sendmail' => '/[0-9]{3} 2.0.0 (.*) Message/',

		'postfix' => '/[0-9]{3} 2.0.0 Ok: queued as (.*)/'

	);

    /**

     * The socket for the server connection.

     * @var resource

     */

    protected $smtp_conn;

    /**

     * Error information, if any, for the last SMTP command.

     * @var array

     */

    protected $error = array(

        'error' => '',

        'detail' => '',

        'smtp_code' => '',

        'smtp_code_ex' => ''

    );

    /**

     * The reply the server sent to us for HELO.

     * If null, no HELO string has yet been received.

     * @var string|null

     */

    protected $helo_rply = null;

    /**

     * The set of SMTP extensions sent in reply to EHLO command.

     * 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.

     * @var array|null

     */

    protected $server_caps = null;

    /**

     * The most recent reply received from the server.

     * @var string

     */

    protected $last_reply = '';

    /**

     * Output debugging info via a user-selected method.

     * @see SMTP::$Debugoutput

     * @see SMTP::$do_debug

     * @param string $str Debug string to output

     * @param integer $level The debug level of this message; see DEBUG_* constants

     * @return void

     */

    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, $level);

            return;

        }

        switch ($this->Debugoutput) {

            case 'error_log':

                //Don't output, just log

                error_log($str);

                break;

            case 'html':

                //Cleans up output a bit for a better looking, HTML-safe output

                echo htmlentities(

                    preg_replace('/[\r\n]+/', '', $str),

                    ENT_QUOTES,

                    'UTF-8'

                )

                . "<br>\n";

                break;

            case 'echo':

            default:

                //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.

     * @param string $host SMTP server IP or host name

     * @param integer $port The port number to connect to

     * @param integer $timeout How long to wait for the connection to open

     * @param array $options An array of options for stream_context_create()

     * @access public

     * @return boolean

     */

    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

        $this->setError('');

        // Make sure we are __not__ connected

        if ($this->connected()) {

            // Already connected, generate error

            $this->setError('Already connected to a server');

            return false;

        }

        if (empty($port)) {

            $port = self::DEFAULT_SMTP_PORT;

        }

        // Connect to the SMTP server

        $this->edebug(

            "Connection: opening to $host:$port, timeout=$timeout, options=".var_export($options, true),

            self::DEBUG_CONNECTION

        );

        $errno = 0;

        $errstr = '';

        if ($streamok) {

            $socket_context = stream_context_create($options);

            set_error_handler(array($this, 'errorHandler'));

            $this->smtp_conn = stream_socket_client(

                $host . ":" . $port,

                $errno,

                $errstr,

                $timeout,

                STREAM_CLIENT_CONNECT,

                $socket_context

            );

            restore_error_handler();

        } 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

            );

            set_error_handler(array($this, 'errorHandler'));

            $this->smtp_conn = fsockopen(

                $host,

                $port,

                $errno,

                $errstr,

                $timeout

            );

            restore_error_handler();

        }

        // Verify we connected properly

        if (!is_resource($this->smtp_conn)) {

            $this->setError(

                'Failed to connect to server',

                $errno,

                $errstr

            );

            $this->edebug(

                'SMTP ERROR: ' . $this->error['error']

                . ": $errstr ($errno)",

                self::DEBUG_CLIENT

            );

            return false;

        }

        $this->edebug('Connection: opened', self::DEBUG_CONNECTION);

        // SMTP server can take longer to respond, give longer timeout for first read

        // Windows does not have support for this timeout function

        if (substr(PHP_OS, 0, 3) != 'WIN') {

            $max = ini_get('max_execution_time');

            // Don't bother if unlimited

            if ($max != 0 && $timeout > $max) {

                @set_time_limit($timeout);

            }

            stream_set_timeout($this->smtp_conn, $timeout, 0);

        }

        // Get any announcement

        $announce = $this->get_lines();

        $this->edebug('SERVER -> CLIENT: ' . $announce, self::DEBUG_SERVER);

        return true;

    }

    /**

     * Initiate a TLS (encrypted) session.

     * @access public

     * @return boolean

     */

    public function startTLS()

    {

        if (!$this->sendCommand('STARTTLS', 'STARTTLS', 220)) {

            return false;

        }

        //Allow the best TLS version(s) we can

        $crypto_method = STREAM_CRYPTO_METHOD_TLS_CLIENT;

        //PHP 5.6.7 dropped inclusion of TLS 1.1 and 1.2 in STREAM_CRYPTO_METHOD_TLS_CLIENT

        //so add them back in manually if we can

        if (defined('STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT')) {

            $crypto_method |= STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT;

            $crypto_method |= STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT;

        }

        // Begin encrypted connection

        if (!stream_socket_enable_crypto(

            $this->smtp_conn,

            true,

            $crypto_method

        )) {

            return false;

        }

        return true;

    }

    /**

     * Perform SMTP authentication.

     * Must be run after hello().

     * @see hello()

     * @param string $username The user name

     * @param string $password The password

     * @param string $authtype The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5, XOAUTH2)

     * @param string $realm The auth realm for NTLM

     * @param string $workstation The auth workstation for NTLM

     * @param null|OAuth $OAuth An optional OAuth instance (@see PHPMailerOAuth)

     * @return bool True if successfully authenticated.* @access public

     */

    public function authenticate(

        $username,

        $password,

        $authtype = null,

        $realm = '',

        $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('CRAM-MD5', 'LOGIN', 'PLAIN', 'NTLM', 'XOAUTH2') as $method) {

                    if (in_array($method, $this->server_caps['AUTH'])) {

                        $authtype = $method;

                        break;

                    }

                }

                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';

        }

        switch ($authtype) {

            case 'PLAIN':

                // Start authentication

                if (!$this->sendCommand('AUTH', 'AUTH PLAIN', 334)) {

                    return false;

                }

                // Send encoded username and password

                if (!$this->sendCommand(

                    'User & Password',

                    base64_encode("\0" . $username . "\0" . $password),

                    235

                )

                ) {

                    return false;

                }

                break;

            case 'LOGIN':

                // Start authentication

                if (!$this->sendCommand('AUTH', 'AUTH LOGIN', 334)) {

                    return false;

                }

                if (!$this->sendCommand("Username", base64_encode($username), 334)) {

                    return false;

                }

                if (!$this->sendCommand("Password", base64_encode($password), 235)) {

                    return false;

                }

                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':

                /*

                 * ntlm_sasl_client.php

                 * Bundled with Permission

                 *

                 * How to telnet in windows:

                 * http://technet.microsoft.com/en-us/library/aa995718%28EXCHG.65%29.aspx

                 * PROTOCOL Docs http://curl.haxx.se/rfc/ntlm.html#ntlmSmtpAuthentication

                 */

                require_once 'extras/ntlm_sasl_client.php';

                $temp = new stdClass;

                $ntlm_client = new ntlm_sasl_client_class;

                //Check that functions are available

                if (!$ntlm_client->initialize($temp)) {

                    $this->setError($temp->error);

                    $this->edebug(

                        'You need to enable some modules in your php.ini file: '

                        . $this->error['error'],

                        self::DEBUG_CLIENT

                    );

                    return false;

                }

                //msg1

                $msg1 = $ntlm_client->typeMsg1($realm, $workstation); //msg1

                if (!$this->sendCommand(

                    'AUTH NTLM',

                    'AUTH NTLM ' . base64_encode($msg1),

                    334

                )

                ) {

                    return false;

                }

                //Though 0 based, there is a white space after the 3 digit number

                //msg2

                $challenge = substr($this->last_reply, 3);

                $challenge = base64_decode($challenge);

                $ntlm_res = $ntlm_client->NTLMResponse(

                    substr($challenge, 24, 8),

                    $password

                );

                //msg3

                $msg3 = $ntlm_client->typeMsg3(

                    $ntlm_res,

                    $username,

                    $realm,

                    $workstation

                );

                // send encoded username

                return $this->sendCommand('Username', base64_encode($msg3), 235);

            case 'CRAM-MD5':

                // Start authentication

                if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) {

                    return false;

                }

                // Get the challenge

                $challenge = base64_decode(substr($this->last_reply, 4));

                // Build the response

                $response = $username . ' ' . $this->hmac($challenge, $password);

                // send encoded credentials

                return $this->sendCommand('Username', base64_encode($response), 235);

            default:

                $this->setError("Authentication method \"$authtype\" is not supported");

                return false;

        }

        return true;

    }

    /**

     * Calculate an MD5 HMAC hash.

     * Works like hash_hmac('md5', $data, $key)

     * in case that function is not available

     * @param string $data The data to hash

     * @param string $key  The key to hash with

     * @access protected

     * @return string

     */

    protected function hmac($data, $key)

    {

        if (function_exists('hash_hmac')) {

            return hash_hmac('md5', $data, $key);

        }

        // The following borrowed from

        // http://php.net/manual/en/function.mhash.php#27225

        // RFC 2104 HMAC implementation for php.

        // Creates an md5 HMAC.

        // Eliminates the need to install mhash to compute a HMAC

        // by Lance Rushing

        $bytelen = 64; // byte length for md5

        if (strlen($key) > $bytelen) {

            $key = pack('H*', md5($key));

        }

        $key = str_pad($key, $bytelen, chr(0x00));

        $ipad = str_pad('', $bytelen, chr(0x36));

        $opad = str_pad('', $bytelen, chr(0x5c));

        $k_ipad = $key ^ $ipad;

        $k_opad = $key ^ $opad;

        return md5($k_opad . pack('H*', md5($k_ipad . $data)));

    }

    /**

     * Check connection state.

     * @access public

     * @return boolean True if connected.

     */

    public function connected()

    {

        if (is_resource($this->smtp_conn)) {

            $sock_status = stream_get_meta_data($this->smtp_conn);

            if ($sock_status['eof']) {

                // The socket is valid but we are not connected

                $this->edebug(

                    'SMTP NOTICE: EOF caught while checking if connected',

                    self::DEBUG_CLIENT

                );

                $this->close();

                return false;

            }

            return true; // everything looks good

        }

        return false;

    }

    /**

     * Close the socket and clean up the state of the class.

     * Don't use this function without first trying to use QUIT.

     * @see quit()

     * @access public

     * @return void

     */

    public function close()

    {

        $this->setError('');

        $this->server_caps = null;

        $this->helo_rply = null;

        if (is_resource($this->smtp_conn)) {

            // close the connection and cleanup

            fclose($this->smtp_conn);

            $this->smtp_conn = null; //Makes for cleaner serialization

            $this->edebug('Connection: closed', self::DEBUG_CONNECTION);

        }

    }

    /**

     * Send an SMTP DATA command.

     * Issues a data command and sends the msg_data to the server,

     * finializing the mail transaction. $msg_data is the message

     * that is to be send with the headers. Each header needs to be

     * on a single line followed by a <CRLF> with the message headers

     * and the message body being separated by and additional <CRLF>.

     * Implements rfc 821: DATA <CRLF>

     * @param string $msg_data Message data to send

     * @access public

     * @return boolean

     */

    public function data($msg_data)

    {

        //This will use the standard timelimit

        if (!$this->sendCommand('DATA', 'DATA', 354)) {

            return false;

        }

        /* 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)

         * so we will break the data up into lines by \r and/or \n then if needed we will break each of those into

         * smaller lines to fit within the limit.

         * We will also look for lines that start with a '.' and prepend an additional '.'.

         * NOTE: this does not count towards line-length limit.

         */

        // Normalize line breaks before exploding

        $lines = explode("\n", str_replace(array("\r\n", "\r"), "\n", $msg_data));

        /* To distinguish between a complete RFC822 message and a plain message body, we check if the first field

         * of the first line (':' separated) does not contain a space then it _should_ be a header and we will

         * process all lines before a blank line as headers.

         */

        $field = substr($lines[0], 0, strpos($lines[0], ':'));

        $in_headers = false;

        if (!empty($field) && strpos($field, ' ') === false) {

            $in_headers = true;

        }

        foreach ($lines as $line) {

            $lines_out = array();

            if ($in_headers and $line == '') {

                $in_headers = false;

            }

            //Break this line up into several smaller lines if it's too long

            //Micro-optimisation: isset($str[$len]) is faster than (strlen($str) > $len),

            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

                //so as to avoid breaking in the middle of a word

                $pos = strrpos(substr($line, 0, self::MAX_LINE_LENGTH), ' ');

                //Deliberately matches both false and 0

                if (!$pos) {

                    //No nice break found, add a hard break

                    $pos = self::MAX_LINE_LENGTH - 1;

                    $lines_out[] = substr($line, 0, $pos);

                    $line = substr($line, $pos);

                } else {

                    //Break at the found point

                    $lines_out[] = substr($line, 0, $pos);

                    //Move along by the amount we dealt with

                    $line = substr($line, $pos + 1);

                }

                //If processing headers add a LWSP-char to the front of new line RFC822 section 3.1.1

                if ($in_headers) {

                    $line = "\t" . $line;

                }

            }

            $lines_out[] = $line;

            //Send the lines to the server

            foreach ($lines_out as $line_out) {

                //RFC2821 section 4.5.2

                if (!empty($line_out) and $line_out[0] == '.') {

                    $line_out = '.' . $line_out;

                }

                $this->client_send($line_out . self::CRLF);

            }

        }

        //Message data has been sent, complete the command

        //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;

    }

    /**

     * Send an SMTP HELO or EHLO command.

     * Used to identify the sending server to the receiving server.

     * This makes sure that client and server are in a known state.

     * Implements RFC 821: HELO <SP> <domain> <CRLF>

     * and RFC 2821 EHLO.

     * @param string $host The host name or IP to connect to

     * @access public

     * @return boolean

     */

    public function hello($host = '')

    {

        //Try extended hello first (RFC 2821)

        return (boolean)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host));

    }

    /**

     * Send an SMTP HELO or EHLO command.

     * Low-level implementation used by hello()

     * @see hello()

     * @param string $hello The HELO string

     * @param string $host The hostname to say we are

     * @access protected

     * @return boolean

     */

    protected function sendHello($hello, $host)

    {

        $noerror = $this->sendCommand($hello, $hello . ' ' . $host, 250);

        $this->helo_rply = $this->last_reply;

        if ($noerror) {

            $this->parseHelloFields($hello);

        } else {

            $this->server_caps = null;

        }

        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->helo_rply);

        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: