WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / class-smtp.php
1 <?php
2 /**
3  * PHPMailer RFC821 SMTP email transport class.
4  * PHP Version 5
5  * @package PHPMailer
6  * @link https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project
7  * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
8  * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
9  * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
10  * @author Brent R. Matzelle (original founder)
11  * @copyright 2014 Marcus Bointon
12  * @copyright 2010 - 2012 Jim Jagielski
13  * @copyright 2004 - 2009 Andy Prevost
14  * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
15  * @note This program is distributed in the hope that it will be useful - WITHOUT
16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17  * FITNESS FOR A PARTICULAR PURPOSE.
18  */
19
20 /**
21  * PHPMailer RFC821 SMTP email transport class.
22  * Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.
23  * @package PHPMailer
24  * @author Chris Ryan
25  * @author Marcus Bointon <phpmailer@synchromedia.co.uk>
26  */
27 class SMTP
28 {
29     /**
30      * The PHPMailer SMTP version number.
31      * @type string
32      */
33     const VERSION = '5.2.10';
34
35     /**
36      * SMTP line break constant.
37      * @type string
38      */
39     const CRLF = "\r\n";
40
41     /**
42      * The SMTP port to use if one is not specified.
43      * @type integer
44      */
45     const DEFAULT_SMTP_PORT = 25;
46
47     /**
48      * The maximum line length allowed by RFC 2822 section 2.1.1
49      * @type integer
50      */
51     const MAX_LINE_LENGTH = 998;
52
53     /**
54      * Debug level for no output
55      */
56     const DEBUG_OFF = 0;
57
58     /**
59      * Debug level to show client -> server messages
60      */
61     const DEBUG_CLIENT = 1;
62
63     /**
64      * Debug level to show client -> server and server -> client messages
65      */
66     const DEBUG_SERVER = 2;
67
68     /**
69      * Debug level to show connection status, client -> server and server -> client messages
70      */
71     const DEBUG_CONNECTION = 3;
72
73     /**
74      * Debug level to show all messages
75      */
76     const DEBUG_LOWLEVEL = 4;
77
78     /**
79      * The PHPMailer SMTP Version number.
80      * @type string
81      * @deprecated Use the `VERSION` constant instead
82      * @see SMTP::VERSION
83      */
84     public $Version = '5.2.10';
85
86     /**
87      * SMTP server port number.
88      * @type integer
89      * @deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead
90      * @see SMTP::DEFAULT_SMTP_PORT
91      */
92     public $SMTP_PORT = 25;
93
94     /**
95      * SMTP reply line ending.
96      * @type string
97      * @deprecated Use the `CRLF` constant instead
98      * @see SMTP::CRLF
99      */
100     public $CRLF = "\r\n";
101
102     /**
103      * Debug output level.
104      * Options:
105      * * self::DEBUG_OFF (`0`) No debug output, default
106      * * self::DEBUG_CLIENT (`1`) Client commands
107      * * self::DEBUG_SERVER (`2`) Client commands and server responses
108      * * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status
109      * * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages
110      * @type integer
111      */
112     public $do_debug = self::DEBUG_OFF;
113
114     /**
115      * How to handle debug output.
116      * Options:
117      * * `echo` Output plain-text as-is, appropriate for CLI
118      * * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output
119      * * `error_log` Output to error log as configured in php.ini
120      *
121      * Alternatively, you can provide a callable expecting two params: a message string and the debug level:
122      * <code>
123      * $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
124      * </code>
125      * @type string|callable
126      */
127     public $Debugoutput = 'echo';
128
129     /**
130      * Whether to use VERP.
131      * @link http://en.wikipedia.org/wiki/Variable_envelope_return_path
132      * @link http://www.postfix.org/VERP_README.html Info on VERP
133      * @type boolean
134      */
135     public $do_verp = false;
136
137     /**
138      * The timeout value for connection, in seconds.
139      * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
140      * This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.
141      * @link http://tools.ietf.org/html/rfc2821#section-4.5.3.2
142      * @type integer
143      */
144     public $Timeout = 300;
145
146     /**
147      * How long to wait for commands to complete, in seconds.
148      * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
149      * @type integer
150      */
151     public $Timelimit = 300;
152
153     /**
154      * The socket for the server connection.
155      * @type resource
156      */
157     protected $smtp_conn;
158
159     /**
160      * Error information, if any, for the last SMTP command.
161      * @type array
162      */
163     protected $error = array(
164         'error' => '',
165         'detail' => '',
166         'smtp_code' => '',
167         'smtp_code_ex' => ''
168     );
169
170     /**
171      * The reply the server sent to us for HELO.
172      * If null, no HELO string has yet been received.
173      * @type string|null
174      */
175     protected $helo_rply = null;
176
177     /**
178      * The set of SMTP extensions sent in reply to EHLO command.
179      * Indexes of the array are extension names.
180      * Value at index 'HELO' or 'EHLO' (according to command that was sent)
181      * represents the server name. In case of HELO it is the only element of the array.
182      * Other values can be boolean TRUE or an array containing extension options.
183      * If null, no HELO/EHLO string has yet been received.
184      * @type array|null
185      */
186     protected $server_caps = null;
187
188     /**
189      * The most recent reply received from the server.
190      * @type string
191      */
192     protected $last_reply = '';
193
194     /**
195      * Output debugging info via a user-selected method.
196      * @see SMTP::$Debugoutput
197      * @see SMTP::$do_debug
198      * @param string $str Debug string to output
199      * @param integer $level The debug level of this message; see DEBUG_* constants
200      * @return void
201      */
202     protected function edebug($str, $level = 0)
203     {
204         if ($level > $this->do_debug) {
205             return;
206         }
207         //Avoid clash with built-in function names
208         if (!in_array($this->Debugoutput, array('error_log', 'html', 'echo')) and is_callable($this->Debugoutput)) {
209             call_user_func($this->Debugoutput, $str, $this->do_debug);
210             return;
211         }
212         switch ($this->Debugoutput) {
213             case 'error_log':
214                 //Don't output, just log
215                 error_log($str);
216                 break;
217             case 'html':
218                 //Cleans up output a bit for a better looking, HTML-safe output
219                 echo htmlentities(
220                     preg_replace('/[\r\n]+/', '', $str),
221                     ENT_QUOTES,
222                     'UTF-8'
223                 )
224                 . "<br>\n";
225                 break;
226             case 'echo':
227             default:
228                 //Normalize line breaks
229                 $str = preg_replace('/(\r\n|\r|\n)/ms', "\n", $str);
230                 echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
231                     "\n",
232                     "\n                   \t                  ",
233                     trim($str)
234                 )."\n";
235         }
236     }
237
238     /**
239      * Connect to an SMTP server.
240      * @param string $host SMTP server IP or host name
241      * @param integer $port The port number to connect to
242      * @param integer $timeout How long to wait for the connection to open
243      * @param array $options An array of options for stream_context_create()
244      * @access public
245      * @return boolean
246      */
247     public function connect($host, $port = null, $timeout = 30, $options = array())
248     {
249         static $streamok;
250         //This is enabled by default since 5.0.0 but some providers disable it
251         //Check this once and cache the result
252         if (is_null($streamok)) {
253             $streamok = function_exists('stream_socket_client');
254         }
255         // Clear errors to avoid confusion
256         $this->setError('');
257         // Make sure we are __not__ connected
258         if ($this->connected()) {
259             // Already connected, generate error
260             $this->setError('Already connected to a server');
261             return false;
262         }
263         if (empty($port)) {
264             $port = self::DEFAULT_SMTP_PORT;
265         }
266         // Connect to the SMTP server
267         $this->edebug(
268             "Connection: opening to $host:$port, timeout=$timeout, options=".var_export($options, true),
269             self::DEBUG_CONNECTION
270         );
271         $errno = 0;
272         $errstr = '';
273         if ($streamok) {
274             $socket_context = stream_context_create($options);
275             //Suppress errors; connection failures are handled at a higher level
276             $this->smtp_conn = @stream_socket_client(
277                 $host . ":" . $port,
278                 $errno,
279                 $errstr,
280                 $timeout,
281                 STREAM_CLIENT_CONNECT,
282                 $socket_context
283             );
284         } else {
285             //Fall back to fsockopen which should work in more places, but is missing some features
286             $this->edebug(
287                 "Connection: stream_socket_client not available, falling back to fsockopen",
288                 self::DEBUG_CONNECTION
289             );
290             $this->smtp_conn = fsockopen(
291                 $host,
292                 $port,
293                 $errno,
294                 $errstr,
295                 $timeout
296             );
297         }
298         // Verify we connected properly
299         if (!is_resource($this->smtp_conn)) {
300             $this->setError(
301                 'Failed to connect to server',
302                 $errno,
303                 $errstr
304             );
305             $this->edebug(
306                 'SMTP ERROR: ' . $this->error['error']
307                 . ": $errstr ($errno)",
308                 self::DEBUG_CLIENT
309             );
310             return false;
311         }
312         $this->edebug('Connection: opened', self::DEBUG_CONNECTION);
313         // SMTP server can take longer to respond, give longer timeout for first read
314         // Windows does not have support for this timeout function
315         if (substr(PHP_OS, 0, 3) != 'WIN') {
316             $max = ini_get('max_execution_time');
317             // Don't bother if unlimited
318             if ($max != 0 && $timeout > $max) {
319                 @set_time_limit($timeout);
320             }
321             stream_set_timeout($this->smtp_conn, $timeout, 0);
322         }
323         // Get any announcement
324         $announce = $this->get_lines();
325         $this->edebug('SERVER -> CLIENT: ' . $announce, self::DEBUG_SERVER);
326         return true;
327     }
328
329     /**
330      * Initiate a TLS (encrypted) session.
331      * @access public
332      * @return boolean
333      */
334     public function startTLS()
335     {
336         if (!$this->sendCommand('STARTTLS', 'STARTTLS', 220)) {
337             return false;
338         }
339         // Begin encrypted connection
340         if (!stream_socket_enable_crypto(
341             $this->smtp_conn,
342             true,
343             STREAM_CRYPTO_METHOD_TLS_CLIENT
344         )) {
345             return false;
346         }
347         return true;
348     }
349
350     /**
351      * Perform SMTP authentication.
352      * Must be run after hello().
353      * @see hello()
354      * @param string $username    The user name
355      * @param string $password    The password
356      * @param string $authtype    The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5)
357      * @param string $realm       The auth realm for NTLM
358      * @param string $workstation The auth workstation for NTLM
359      * @access public
360      * @return boolean True if successfully authenticated.
361      */
362     public function authenticate(
363         $username,
364         $password,
365         $authtype = null,
366         $realm = '',
367         $workstation = ''
368     ) {
369         if (!$this->server_caps) {
370             $this->setError('Authentication is not allowed before HELO/EHLO');
371             return false;
372         }
373
374         if (array_key_exists('EHLO', $this->server_caps)) {
375         // SMTP extensions are available. Let's try to find a proper authentication method
376
377             if (!array_key_exists('AUTH', $this->server_caps)) {
378                 $this->setError('Authentication is not allowed at this stage');
379                 // 'at this stage' means that auth may be allowed after the stage changes
380                 // e.g. after STARTTLS
381                 return false;
382             }
383
384             self::edebug('Auth method requested: ' . ($authtype ? $authtype : 'UNKNOWN'), self::DEBUG_LOWLEVEL);
385             self::edebug(
386                 'Auth methods available on the server: ' . implode(',', $this->server_caps['AUTH']),
387                 self::DEBUG_LOWLEVEL
388             );
389
390             if (empty($authtype)) {
391                 foreach (array('LOGIN', 'CRAM-MD5', 'PLAIN') as $method) {
392                     if (in_array($method, $this->server_caps['AUTH'])) {
393                         $authtype = $method;
394                         break;
395                     }
396                 }
397                 if (empty($authtype)) {
398                     $this->setError('No supported authentication methods found');
399                     return false;
400                 }
401                 self::edebug('Auth method selected: '.$authtype, self::DEBUG_LOWLEVEL);
402             }
403
404             if (!in_array($authtype, $this->server_caps['AUTH'])) {
405                 $this->setError("The requested authentication method \"$authtype\" is not supported by the server");
406                 return false;
407             }
408         } elseif (empty($authtype)) {
409             $authtype = 'LOGIN';
410         }
411         switch ($authtype) {
412             case 'PLAIN':
413                 // Start authentication
414                 if (!$this->sendCommand('AUTH', 'AUTH PLAIN', 334)) {
415                     return false;
416                 }
417                 // Send encoded username and password
418                 if (!$this->sendCommand(
419                     'User & Password',
420                     base64_encode("\0" . $username . "\0" . $password),
421                     235
422                 )
423                 ) {
424                     return false;
425                 }
426                 break;
427             case 'LOGIN':
428                 // Start authentication
429                 if (!$this->sendCommand('AUTH', 'AUTH LOGIN', 334)) {
430                     return false;
431                 }
432                 if (!$this->sendCommand("Username", base64_encode($username), 334)) {
433                     return false;
434                 }
435                 if (!$this->sendCommand("Password", base64_encode($password), 235)) {
436                     return false;
437                 }
438                 break;
439             case 'CRAM-MD5':
440                 // Start authentication
441                 if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) {
442                     return false;
443                 }
444                 // Get the challenge
445                 $challenge = base64_decode(substr($this->last_reply, 4));
446
447                 // Build the response
448                 $response = $username . ' ' . $this->hmac($challenge, $password);
449
450                 // send encoded credentials
451                 return $this->sendCommand('Username', base64_encode($response), 235);
452             default:
453                 $this->setError("Authentication method \"$authtype\" is not supported");
454                 return false;
455         }
456         return true;
457     }
458
459     /**
460      * Calculate an MD5 HMAC hash.
461      * Works like hash_hmac('md5', $data, $key)
462      * in case that function is not available
463      * @param string $data The data to hash
464      * @param string $key  The key to hash with
465      * @access protected
466      * @return string
467      */
468     protected function hmac($data, $key)
469     {
470         if (function_exists('hash_hmac')) {
471             return hash_hmac('md5', $data, $key);
472         }
473
474         // The following borrowed from
475         // http://php.net/manual/en/function.mhash.php#27225
476
477         // RFC 2104 HMAC implementation for php.
478         // Creates an md5 HMAC.
479         // Eliminates the need to install mhash to compute a HMAC
480         // by Lance Rushing
481
482         $bytelen = 64; // byte length for md5
483         if (strlen($key) > $bytelen) {
484             $key = pack('H*', md5($key));
485         }
486         $key = str_pad($key, $bytelen, chr(0x00));
487         $ipad = str_pad('', $bytelen, chr(0x36));
488         $opad = str_pad('', $bytelen, chr(0x5c));
489         $k_ipad = $key ^ $ipad;
490         $k_opad = $key ^ $opad;
491
492         return md5($k_opad . pack('H*', md5($k_ipad . $data)));
493     }
494
495     /**
496      * Check connection state.
497      * @access public
498      * @return boolean True if connected.
499      */
500     public function connected()
501     {
502         if (is_resource($this->smtp_conn)) {
503             $sock_status = stream_get_meta_data($this->smtp_conn);
504             if ($sock_status['eof']) {
505                 // The socket is valid but we are not connected
506                 $this->edebug(
507                     'SMTP NOTICE: EOF caught while checking if connected',
508                     self::DEBUG_CLIENT
509                 );
510                 $this->close();
511                 return false;
512             }
513             return true; // everything looks good
514         }
515         return false;
516     }
517
518     /**
519      * Close the socket and clean up the state of the class.
520      * Don't use this function without first trying to use QUIT.
521      * @see quit()
522      * @access public
523      * @return void
524      */
525     public function close()
526     {
527         $this->setError('');
528         $this->server_caps = null;
529         $this->helo_rply = null;
530         if (is_resource($this->smtp_conn)) {
531             // close the connection and cleanup
532             fclose($this->smtp_conn);
533             $this->smtp_conn = null; //Makes for cleaner serialization
534             $this->edebug('Connection: closed', self::DEBUG_CONNECTION);
535         }
536     }
537
538     /**
539      * Send an SMTP DATA command.
540      * Issues a data command and sends the msg_data to the server,
541      * finializing the mail transaction. $msg_data is the message
542      * that is to be send with the headers. Each header needs to be
543      * on a single line followed by a <CRLF> with the message headers
544      * and the message body being separated by and additional <CRLF>.
545      * Implements rfc 821: DATA <CRLF>
546      * @param string $msg_data Message data to send
547      * @access public
548      * @return boolean
549      */
550     public function data($msg_data)
551     {
552         //This will use the standard timelimit
553         if (!$this->sendCommand('DATA', 'DATA', 354)) {
554             return false;
555         }
556
557         /* The server is ready to accept data!
558          * According to rfc821 we should not send more than 1000 characters on a single line (including the CRLF)
559          * so we will break the data up into lines by \r and/or \n then if needed we will break each of those into
560          * smaller lines to fit within the limit.
561          * We will also look for lines that start with a '.' and prepend an additional '.'.
562          * NOTE: this does not count towards line-length limit.
563          */
564
565         // Normalize line breaks before exploding
566         $lines = explode("\n", str_replace(array("\r\n", "\r"), "\n", $msg_data));
567
568         /* To distinguish between a complete RFC822 message and a plain message body, we check if the first field
569          * of the first line (':' separated) does not contain a space then it _should_ be a header and we will
570          * process all lines before a blank line as headers.
571          */
572
573         $field = substr($lines[0], 0, strpos($lines[0], ':'));
574         $in_headers = false;
575         if (!empty($field) && strpos($field, ' ') === false) {
576             $in_headers = true;
577         }
578
579         foreach ($lines as $line) {
580             $lines_out = array();
581             if ($in_headers and $line == '') {
582                 $in_headers = false;
583             }
584             //Break this line up into several smaller lines if it's too long
585             //Micro-optimisation: isset($str[$len]) is faster than (strlen($str) > $len),
586             while (isset($line[self::MAX_LINE_LENGTH])) {
587                 //Working backwards, try to find a space within the last MAX_LINE_LENGTH chars of the line to break on
588                 //so as to avoid breaking in the middle of a word
589                 $pos = strrpos(substr($line, 0, self::MAX_LINE_LENGTH), ' ');
590                 //Deliberately matches both false and 0
591                 if (!$pos) {
592                     //No nice break found, add a hard break
593                     $pos = self::MAX_LINE_LENGTH - 1;
594                     $lines_out[] = substr($line, 0, $pos);
595                     $line = substr($line, $pos);
596                 } else {
597                     //Break at the found point
598                     $lines_out[] = substr($line, 0, $pos);
599                     //Move along by the amount we dealt with
600                     $line = substr($line, $pos + 1);
601                 }
602                 //If processing headers add a LWSP-char to the front of new line RFC822 section 3.1.1
603                 if ($in_headers) {
604                     $line = "\t" . $line;
605                 }
606             }
607             $lines_out[] = $line;
608
609             //Send the lines to the server
610             foreach ($lines_out as $line_out) {
611                 //RFC2821 section 4.5.2
612                 if (!empty($line_out) and $line_out[0] == '.') {
613                     $line_out = '.' . $line_out;
614                 }
615                 $this->client_send($line_out . self::CRLF);
616             }
617         }
618
619         //Message data has been sent, complete the command
620         //Increase timelimit for end of DATA command
621         $savetimelimit = $this->Timelimit;
622         $this->Timelimit = $this->Timelimit * 2;
623         $result = $this->sendCommand('DATA END', '.', 250);
624         //Restore timelimit
625         $this->Timelimit = $savetimelimit;
626         return $result;
627     }
628
629     /**
630      * Send an SMTP HELO or EHLO command.
631      * Used to identify the sending server to the receiving server.
632      * This makes sure that client and server are in a known state.
633      * Implements RFC 821: HELO <SP> <domain> <CRLF>
634      * and RFC 2821 EHLO.
635      * @param string $host The host name or IP to connect to
636      * @access public
637      * @return boolean
638      */
639     public function hello($host = '')
640     {
641         //Try extended hello first (RFC 2821)
642         return (boolean)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host));
643     }
644
645     /**
646      * Send an SMTP HELO or EHLO command.
647      * Low-level implementation used by hello()
648      * @see hello()
649      * @param string $hello The HELO string
650      * @param string $host The hostname to say we are
651      * @access protected
652      * @return boolean
653      */
654     protected function sendHello($hello, $host)
655     {
656         $noerror = $this->sendCommand($hello, $hello . ' ' . $host, 250);
657         $this->helo_rply = $this->last_reply;
658         if ($noerror) {
659             $this->parseHelloFields($hello);
660         } else {
661             $this->server_caps = null;
662         }
663         return $noerror;
664     }
665
666     /**
667      * Parse a reply to HELO/EHLO command to discover server extensions.
668      * In case of HELO, the only parameter that can be discovered is a server name.
669      * @access protected
670      * @param string $type - 'HELO' or 'EHLO'
671      */
672     protected function parseHelloFields($type)
673     {
674         $this->server_caps = array();
675         $lines = explode("\n", $this->last_reply);
676         foreach ($lines as $n => $s) {
677             $s = trim(substr($s, 4));
678             if (!$s) {
679                 continue;
680             }
681             $fields = explode(' ', $s);
682             if (!empty($fields)) {
683                 if (!$n) {
684                     $name = $type;
685                     $fields = $fields[0];
686                 } else {
687                     $name = array_shift($fields);
688                     if ($name == 'SIZE') {
689                         $fields = ($fields) ? $fields[0] : 0;
690                     }
691                 }
692                 $this->server_caps[$name] = ($fields ? $fields : true);
693             }
694         }
695     }
696
697     /**
698      * Send an SMTP MAIL command.
699      * Starts a mail transaction from the email address specified in
700      * $from. Returns true if successful or false otherwise. If True
701      * the mail transaction is started and then one or more recipient
702      * commands may be called followed by a data command.
703      * Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
704      * @param string $from Source address of this message
705      * @access public
706      * @return boolean
707      */
708     public function mail($from)
709     {
710         $useVerp = ($this->do_verp ? ' XVERP' : '');
711         return $this->sendCommand(
712             'MAIL FROM',
713             'MAIL FROM:<' . $from . '>' . $useVerp,
714             250
715         );
716     }
717
718     /**
719      * Send an SMTP QUIT command.
720      * Closes the socket if there is no error or the $close_on_error argument is true.
721      * Implements from rfc 821: QUIT <CRLF>
722      * @param boolean $close_on_error Should the connection close if an error occurs?
723      * @access public
724      * @return boolean
725      */
726     public function quit($close_on_error = true)
727     {
728         $noerror = $this->sendCommand('QUIT', 'QUIT', 221);
729         $err = $this->error; //Save any error
730         if ($noerror or $close_on_error) {
731             $this->close();
732             $this->error = $err; //Restore any error from the quit command
733         }
734         return $noerror;
735     }
736
737     /**
738      * Send an SMTP RCPT command.
739      * Sets the TO argument to $toaddr.
740      * Returns true if the recipient was accepted false if it was rejected.
741      * Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
742      * @param string $toaddr The address the message is being sent to
743      * @access public
744      * @return boolean
745      */
746     public function recipient($toaddr)
747     {
748         return $this->sendCommand(
749             'RCPT TO',
750             'RCPT TO:<' . $toaddr . '>',
751             array(250, 251)
752         );
753     }
754
755     /**
756      * Send an SMTP RSET command.
757      * Abort any transaction that is currently in progress.
758      * Implements rfc 821: RSET <CRLF>
759      * @access public
760      * @return boolean True on success.
761      */
762     public function reset()
763     {
764         return $this->sendCommand('RSET', 'RSET', 250);
765     }
766
767     /**
768      * Send a command to an SMTP server and check its return code.
769      * @param string $command       The command name - not sent to the server
770      * @param string $commandstring The actual command to send
771      * @param integer|array $expect     One or more expected integer success codes
772      * @access protected
773      * @return boolean True on success.
774      */
775     protected function sendCommand($command, $commandstring, $expect)
776     {
777         if (!$this->connected()) {
778             $this->setError("Called $command without being connected");
779             return false;
780         }
781         $this->client_send($commandstring . self::CRLF);
782
783         $this->last_reply = $this->get_lines();
784         // Fetch SMTP code and possible error code explanation
785         $matches = array();
786         if (preg_match("/^([0-9]{3})[ -](?:([0-9]\\.[0-9]\\.[0-9]) )?/", $this->last_reply, $matches)) {
787             $code = $matches[1];
788             $code_ex = (count($matches) > 2 ? $matches[2] : null);
789             // Cut off error code from each response line
790             $detail = preg_replace(
791                 "/{$code}[ -]".($code_ex ? str_replace('.', '\\.', $code_ex).' ' : '')."/m",
792                 '',
793                 $this->last_reply
794             );
795         } else {
796             // Fall back to simple parsing if regex fails
797             $code = substr($this->last_reply, 0, 3);
798             $code_ex = null;
799             $detail = substr($this->last_reply, 4);
800         }
801
802         $this->edebug('SERVER -> CLIENT: ' . $this->last_reply, self::DEBUG_SERVER);
803
804         if (!in_array($code, (array)$expect)) {
805             $this->setError(
806                 "$command command failed",
807                 $detail,
808                 $code,
809                 $code_ex
810             );
811             $this->edebug(
812                 'SMTP ERROR: ' . $this->error['error'] . ': ' . $this->last_reply,
813                 self::DEBUG_CLIENT
814             );
815             return false;
816         }
817
818         $this->setError('');
819         return true;
820     }
821
822     /**
823      * Send an SMTP SAML command.
824      * Starts a mail transaction from the email address specified in $from.
825      * Returns true if successful or false otherwise. If True
826      * the mail transaction is started and then one or more recipient
827      * commands may be called followed by a data command. This command
828      * will send the message to the users terminal if they are logged
829      * in and send them an email.
830      * Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
831      * @param string $from The address the message is from
832      * @access public
833      * @return boolean
834      */
835     public function sendAndMail($from)
836     {
837         return $this->sendCommand('SAML', "SAML FROM:$from", 250);
838     }
839
840     /**
841      * Send an SMTP VRFY command.
842      * @param string $name The name to verify
843      * @access public
844      * @return boolean
845      */
846     public function verify($name)
847     {
848         return $this->sendCommand('VRFY', "VRFY $name", array(250, 251));
849     }
850
851     /**
852      * Send an SMTP NOOP command.
853      * Used to keep keep-alives alive, doesn't actually do anything
854      * @access public
855      * @return boolean
856      */
857     public function noop()
858     {
859         return $this->sendCommand('NOOP', 'NOOP', 250);
860     }
861
862     /**
863      * Send an SMTP TURN command.
864      * This is an optional command for SMTP that this class does not support.
865      * This method is here to make the RFC821 Definition complete for this class
866      * and _may_ be implemented in future
867      * Implements from rfc 821: TURN <CRLF>
868      * @access public
869      * @return boolean
870      */
871     public function turn()
872     {
873         $this->setError('The SMTP TURN command is not implemented');
874         $this->edebug('SMTP NOTICE: ' . $this->error['error'], self::DEBUG_CLIENT);
875         return false;
876     }
877
878     /**
879      * Send raw data to the server.
880      * @param string $data The data to send
881      * @access public
882      * @return integer|boolean The number of bytes sent to the server or false on error
883      */
884     public function client_send($data)
885     {
886         $this->edebug("CLIENT -> SERVER: $data", self::DEBUG_CLIENT);
887         return fwrite($this->smtp_conn, $data);
888     }
889
890     /**
891      * Get the latest error.
892      * @access public
893      * @return array
894      */
895     public function getError()
896     {
897         return $this->error;
898     }
899
900     /**
901      * Get SMTP extensions available on the server
902      * @access public
903      * @return array|null
904      */
905     public function getServerExtList()
906     {
907         return $this->server_caps;
908     }
909
910     /**
911      * A multipurpose method
912      * The method works in three ways, dependent on argument value and current state
913      *   1. HELO/EHLO was not sent - returns null and set up $this->error
914      *   2. HELO was sent
915      *     $name = 'HELO': returns server name
916      *     $name = 'EHLO': returns boolean false
917      *     $name = any string: returns null and set up $this->error
918      *   3. EHLO was sent
919      *     $name = 'HELO'|'EHLO': returns server name
920      *     $name = any string: if extension $name exists, returns boolean True
921      *       or its options. Otherwise returns boolean False
922      * In other words, one can use this method to detect 3 conditions:
923      *  - null returned: handshake was not or we don't know about ext (refer to $this->error)
924      *  - false returned: the requested feature exactly not exists
925      *  - positive value returned: the requested feature exists
926      * @param string $name Name of SMTP extension or 'HELO'|'EHLO'
927      * @return mixed
928      */
929     public function getServerExt($name)
930     {
931         if (!$this->server_caps) {
932             $this->setError('No HELO/EHLO was sent');
933             return null;
934         }
935
936         // the tight logic knot ;)
937         if (!array_key_exists($name, $this->server_caps)) {
938             if ($name == 'HELO') {
939                 return $this->server_caps['EHLO'];
940             }
941             if ($name == 'EHLO' || array_key_exists('EHLO', $this->server_caps)) {
942                 return false;
943             }
944             $this->setError('HELO handshake was used. Client knows nothing about server extensions');
945             return null;
946         }
947
948         return $this->server_caps[$name];
949     }
950
951     /**
952      * Get the last reply from the server.
953      * @access public
954      * @return string
955      */
956     public function getLastReply()
957     {
958         return $this->last_reply;
959     }
960
961     /**
962      * Read the SMTP server's response.
963      * Either before eof or socket timeout occurs on the operation.
964      * With SMTP we can tell if we have more lines to read if the
965      * 4th character is '-' symbol. If it is a space then we don't
966      * need to read anything else.
967      * @access protected
968      * @return string
969      */
970     protected function get_lines()
971     {
972         // If the connection is bad, give up straight away
973         if (!is_resource($this->smtp_conn)) {
974             return '';
975         }
976         $data = '';
977         $endtime = 0;
978         stream_set_timeout($this->smtp_conn, $this->Timeout);
979         if ($this->Timelimit > 0) {
980             $endtime = time() + $this->Timelimit;
981         }
982         while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {
983             $str = @fgets($this->smtp_conn, 515);
984             $this->edebug("SMTP -> get_lines(): \$data was \"$data\"", self::DEBUG_LOWLEVEL);
985             $this->edebug("SMTP -> get_lines(): \$str is \"$str\"", self::DEBUG_LOWLEVEL);
986             $data .= $str;
987             $this->edebug("SMTP -> get_lines(): \$data is \"$data\"", self::DEBUG_LOWLEVEL);
988             // If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen
989             if ((isset($str[3]) and $str[3] == ' ')) {
990                 break;
991             }
992             // Timed-out? Log and break
993             $info = stream_get_meta_data($this->smtp_conn);
994             if ($info['timed_out']) {
995                 $this->edebug(
996                     'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)',
997                     self::DEBUG_LOWLEVEL
998                 );
999                 break;
1000             }
1001             // Now check if reads took too long
1002             if ($endtime and time() > $endtime) {
1003                 $this->edebug(
1004                     'SMTP -> get_lines(): timelimit reached ('.
1005                     $this->Timelimit . ' sec)',
1006                     self::DEBUG_LOWLEVEL
1007                 );
1008                 break;
1009             }
1010         }
1011         return $data;
1012     }
1013
1014     /**
1015      * Enable or disable VERP address generation.
1016      * @param boolean $enabled
1017      */
1018     public function setVerp($enabled = false)
1019     {
1020         $this->do_verp = $enabled;
1021     }
1022
1023     /**
1024      * Get VERP address generation mode.
1025      * @return boolean
1026      */
1027     public function getVerp()
1028     {
1029         return $this->do_verp;
1030     }
1031
1032     /**
1033      * Set error messages and codes.
1034      * @param string $message The error message
1035      * @param string $detail Further detail on the error
1036      * @param string $smtp_code An associated SMTP error code
1037      * @param string $smtp_code_ex Extended SMTP code
1038      */
1039     protected function setError($message, $detail = '', $smtp_code = '', $smtp_code_ex = '')
1040     {
1041         $this->error = array(
1042             'error' => $message,
1043             'detail' => $detail,
1044             'smtp_code' => $smtp_code,
1045             'smtp_code_ex' => $smtp_code_ex
1046         );
1047     }
1048
1049     /**
1050      * Set debug output method.
1051      * @param string|callable $method The name of the mechanism to use for debugging output, or a callable to handle it.
1052      */
1053     public function setDebugOutput($method = 'echo')
1054     {
1055         $this->Debugoutput = $method;
1056     }
1057
1058     /**
1059      * Get debug output method.
1060      * @return string
1061      */
1062     public function getDebugOutput()
1063     {
1064         return $this->Debugoutput;
1065     }
1066
1067     /**
1068      * Set debug output level.
1069      * @param integer $level
1070      */
1071     public function setDebugLevel($level = 0)
1072     {
1073         $this->do_debug = $level;
1074     }
1075
1076     /**
1077      * Get debug output level.
1078      * @return integer
1079      */
1080     public function getDebugLevel()
1081     {
1082         return $this->do_debug;
1083     }
1084
1085     /**
1086      * Set SMTP timeout.
1087      * @param integer $timeout
1088      */
1089     public function setTimeout($timeout = 0)
1090     {
1091         $this->Timeout = $timeout;
1092     }
1093
1094     /**
1095      * Get SMTP timeout.
1096      * @return integer
1097      */
1098     public function getTimeout()
1099     {
1100         return $this->Timeout;
1101     }
1102 }