WordPress 4.4.1
[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      * @var string
32      */
33     const VERSION = '5.2.14';
34
35     /**
36      * SMTP line break constant.
37      * @var string
38      */
39     const CRLF = "\r\n";
40
41     /**
42      * The SMTP port to use if one is not specified.
43      * @var integer
44      */
45     const DEFAULT_SMTP_PORT = 25;
46
47     /**
48      * The maximum line length allowed by RFC 2822 section 2.1.1
49      * @var 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      * @var string
81      * @deprecated Use the `VERSION` constant instead
82      * @see SMTP::VERSION
83      */
84     public $Version = '5.2.14';
85
86     /**
87      * SMTP server port number.
88      * @var 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      * @var 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      * @var 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      * @var 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      * @var 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      * @var 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      * @var integer
150      */
151     public $Timelimit = 300;
152
153     /**
154      * The socket for the server connection.
155      * @var resource
156      */
157     protected $smtp_conn;
158
159     /**
160      * Error information, if any, for the last SMTP command.
161      * @var 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      * @var 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      * @var array|null
185      */
186     protected $server_caps = null;
187
188     /**
189      * The most recent reply received from the server.
190      * @var 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, XOAUTH2)
357      * @param string $realm The auth realm for NTLM
358      * @param string $workstation The auth workstation for NTLM
359      * @param null|OAuth $OAuth An optional OAuth instance (@see PHPMailerOAuth)
360      * @return bool True if successfully authenticated.* @access public
361      */
362     public function authenticate(
363         $username,
364         $password,
365         $authtype = null,
366         $realm = '',
367         $workstation = '',
368         $OAuth = null
369     ) {
370         if (!$this->server_caps) {
371             $this->setError('Authentication is not allowed before HELO/EHLO');
372             return false;
373         }
374
375         if (array_key_exists('EHLO', $this->server_caps)) {
376         // SMTP extensions are available. Let's try to find a proper authentication method
377
378             if (!array_key_exists('AUTH', $this->server_caps)) {
379                 $this->setError('Authentication is not allowed at this stage');
380                 // 'at this stage' means that auth may be allowed after the stage changes
381                 // e.g. after STARTTLS
382                 return false;
383             }
384
385             self::edebug('Auth method requested: ' . ($authtype ? $authtype : 'UNKNOWN'), self::DEBUG_LOWLEVEL);
386             self::edebug(
387                 'Auth methods available on the server: ' . implode(',', $this->server_caps['AUTH']),
388                 self::DEBUG_LOWLEVEL
389             );
390
391             if (empty($authtype)) {
392                 foreach (array('LOGIN', 'CRAM-MD5', 'PLAIN') as $method) {
393                     if (in_array($method, $this->server_caps['AUTH'])) {
394                         $authtype = $method;
395                         break;
396                     }
397                 }
398                 if (empty($authtype)) {
399                     $this->setError('No supported authentication methods found');
400                     return false;
401                 }
402                 self::edebug('Auth method selected: '.$authtype, self::DEBUG_LOWLEVEL);
403             }
404
405             if (!in_array($authtype, $this->server_caps['AUTH'])) {
406                 $this->setError("The requested authentication method \"$authtype\" is not supported by the server");
407                 return false;
408             }
409         } elseif (empty($authtype)) {
410             $authtype = 'LOGIN';
411         }
412         switch ($authtype) {
413             case 'PLAIN':
414                 // Start authentication
415                 if (!$this->sendCommand('AUTH', 'AUTH PLAIN', 334)) {
416                     return false;
417                 }
418                 // Send encoded username and password
419                 if (!$this->sendCommand(
420                     'User & Password',
421                     base64_encode("\0" . $username . "\0" . $password),
422                     235
423                 )
424                 ) {
425                     return false;
426                 }
427                 break;
428             case 'LOGIN':
429                 // Start authentication
430                 if (!$this->sendCommand('AUTH', 'AUTH LOGIN', 334)) {
431                     return false;
432                 }
433                 if (!$this->sendCommand("Username", base64_encode($username), 334)) {
434                     return false;
435                 }
436                 if (!$this->sendCommand("Password", base64_encode($password), 235)) {
437                     return false;
438                 }
439                 break;
440             case 'CRAM-MD5':
441                 // Start authentication
442                 if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) {
443                     return false;
444                 }
445                 // Get the challenge
446                 $challenge = base64_decode(substr($this->last_reply, 4));
447
448                 // Build the response
449                 $response = $username . ' ' . $this->hmac($challenge, $password);
450
451                 // send encoded credentials
452                 return $this->sendCommand('Username', base64_encode($response), 235);
453             default:
454                 $this->setError("Authentication method \"$authtype\" is not supported");
455                 return false;
456         }
457         return true;
458     }
459
460     /**
461      * Calculate an MD5 HMAC hash.
462      * Works like hash_hmac('md5', $data, $key)
463      * in case that function is not available
464      * @param string $data The data to hash
465      * @param string $key  The key to hash with
466      * @access protected
467      * @return string
468      */
469     protected function hmac($data, $key)
470     {
471         if (function_exists('hash_hmac')) {
472             return hash_hmac('md5', $data, $key);
473         }
474
475         // The following borrowed from
476         // http://php.net/manual/en/function.mhash.php#27225
477
478         // RFC 2104 HMAC implementation for php.
479         // Creates an md5 HMAC.
480         // Eliminates the need to install mhash to compute a HMAC
481         // by Lance Rushing
482
483         $bytelen = 64; // byte length for md5
484         if (strlen($key) > $bytelen) {
485             $key = pack('H*', md5($key));
486         }
487         $key = str_pad($key, $bytelen, chr(0x00));
488         $ipad = str_pad('', $bytelen, chr(0x36));
489         $opad = str_pad('', $bytelen, chr(0x5c));
490         $k_ipad = $key ^ $ipad;
491         $k_opad = $key ^ $opad;
492
493         return md5($k_opad . pack('H*', md5($k_ipad . $data)));
494     }
495
496     /**
497      * Check connection state.
498      * @access public
499      * @return boolean True if connected.
500      */
501     public function connected()
502     {
503         if (is_resource($this->smtp_conn)) {
504             $sock_status = stream_get_meta_data($this->smtp_conn);
505             if ($sock_status['eof']) {
506                 // The socket is valid but we are not connected
507                 $this->edebug(
508                     'SMTP NOTICE: EOF caught while checking if connected',
509                     self::DEBUG_CLIENT
510                 );
511                 $this->close();
512                 return false;
513             }
514             return true; // everything looks good
515         }
516         return false;
517     }
518
519     /**
520      * Close the socket and clean up the state of the class.
521      * Don't use this function without first trying to use QUIT.
522      * @see quit()
523      * @access public
524      * @return void
525      */
526     public function close()
527     {
528         $this->setError('');
529         $this->server_caps = null;
530         $this->helo_rply = null;
531         if (is_resource($this->smtp_conn)) {
532             // close the connection and cleanup
533             fclose($this->smtp_conn);
534             $this->smtp_conn = null; //Makes for cleaner serialization
535             $this->edebug('Connection: closed', self::DEBUG_CONNECTION);
536         }
537     }
538
539     /**
540      * Send an SMTP DATA command.
541      * Issues a data command and sends the msg_data to the server,
542      * finializing the mail transaction. $msg_data is the message
543      * that is to be send with the headers. Each header needs to be
544      * on a single line followed by a <CRLF> with the message headers
545      * and the message body being separated by and additional <CRLF>.
546      * Implements rfc 821: DATA <CRLF>
547      * @param string $msg_data Message data to send
548      * @access public
549      * @return boolean
550      */
551     public function data($msg_data)
552     {
553         //This will use the standard timelimit
554         if (!$this->sendCommand('DATA', 'DATA', 354)) {
555             return false;
556         }
557
558         /* The server is ready to accept data!
559          * According to rfc821 we should not send more than 1000 characters on a single line (including the CRLF)
560          * so we will break the data up into lines by \r and/or \n then if needed we will break each of those into
561          * smaller lines to fit within the limit.
562          * We will also look for lines that start with a '.' and prepend an additional '.'.
563          * NOTE: this does not count towards line-length limit.
564          */
565
566         // Normalize line breaks before exploding
567         $lines = explode("\n", str_replace(array("\r\n", "\r"), "\n", $msg_data));
568
569         /* To distinguish between a complete RFC822 message and a plain message body, we check if the first field
570          * of the first line (':' separated) does not contain a space then it _should_ be a header and we will
571          * process all lines before a blank line as headers.
572          */
573
574         $field = substr($lines[0], 0, strpos($lines[0], ':'));
575         $in_headers = false;
576         if (!empty($field) && strpos($field, ' ') === false) {
577             $in_headers = true;
578         }
579
580         foreach ($lines as $line) {
581             $lines_out = array();
582             if ($in_headers and $line == '') {
583                 $in_headers = false;
584             }
585             //Break this line up into several smaller lines if it's too long
586             //Micro-optimisation: isset($str[$len]) is faster than (strlen($str) > $len),
587             while (isset($line[self::MAX_LINE_LENGTH])) {
588                 //Working backwards, try to find a space within the last MAX_LINE_LENGTH chars of the line to break on
589                 //so as to avoid breaking in the middle of a word
590                 $pos = strrpos(substr($line, 0, self::MAX_LINE_LENGTH), ' ');
591                 //Deliberately matches both false and 0
592                 if (!$pos) {
593                     //No nice break found, add a hard break
594                     $pos = self::MAX_LINE_LENGTH - 1;
595                     $lines_out[] = substr($line, 0, $pos);
596                     $line = substr($line, $pos);
597                 } else {
598                     //Break at the found point
599                     $lines_out[] = substr($line, 0, $pos);
600                     //Move along by the amount we dealt with
601                     $line = substr($line, $pos + 1);
602                 }
603                 //If processing headers add a LWSP-char to the front of new line RFC822 section 3.1.1
604                 if ($in_headers) {
605                     $line = "\t" . $line;
606                 }
607             }
608             $lines_out[] = $line;
609
610             //Send the lines to the server
611             foreach ($lines_out as $line_out) {
612                 //RFC2821 section 4.5.2
613                 if (!empty($line_out) and $line_out[0] == '.') {
614                     $line_out = '.' . $line_out;
615                 }
616                 $this->client_send($line_out . self::CRLF);
617             }
618         }
619
620         //Message data has been sent, complete the command
621         //Increase timelimit for end of DATA command
622         $savetimelimit = $this->Timelimit;
623         $this->Timelimit = $this->Timelimit * 2;
624         $result = $this->sendCommand('DATA END', '.', 250);
625         //Restore timelimit
626         $this->Timelimit = $savetimelimit;
627         return $result;
628     }
629
630     /**
631      * Send an SMTP HELO or EHLO command.
632      * Used to identify the sending server to the receiving server.
633      * This makes sure that client and server are in a known state.
634      * Implements RFC 821: HELO <SP> <domain> <CRLF>
635      * and RFC 2821 EHLO.
636      * @param string $host The host name or IP to connect to
637      * @access public
638      * @return boolean
639      */
640     public function hello($host = '')
641     {
642         //Try extended hello first (RFC 2821)
643         return (boolean)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host));
644     }
645
646     /**
647      * Send an SMTP HELO or EHLO command.
648      * Low-level implementation used by hello()
649      * @see hello()
650      * @param string $hello The HELO string
651      * @param string $host The hostname to say we are
652      * @access protected
653      * @return boolean
654      */
655     protected function sendHello($hello, $host)
656     {
657         $noerror = $this->sendCommand($hello, $hello . ' ' . $host, 250);
658         $this->helo_rply = $this->last_reply;
659         if ($noerror) {
660             $this->parseHelloFields($hello);
661         } else {
662             $this->server_caps = null;
663         }
664         return $noerror;
665     }
666
667     /**
668      * Parse a reply to HELO/EHLO command to discover server extensions.
669      * In case of HELO, the only parameter that can be discovered is a server name.
670      * @access protected
671      * @param string $type - 'HELO' or 'EHLO'
672      */
673     protected function parseHelloFields($type)
674     {
675         $this->server_caps = array();
676         $lines = explode("\n", $this->last_reply);
677
678         foreach ($lines as $n => $s) {
679             //First 4 chars contain response code followed by - or space
680             $s = trim(substr($s, 4));
681             if (empty($s)) {
682                 continue;
683             }
684             $fields = explode(' ', $s);
685             if (!empty($fields)) {
686                 if (!$n) {
687                     $name = $type;
688                     $fields = $fields[0];
689                 } else {
690                     $name = array_shift($fields);
691                     switch ($name) {
692                         case 'SIZE':
693                             $fields = ($fields ? $fields[0] : 0);
694                             break;
695                         case 'AUTH':
696                             if (!is_array($fields)) {
697                                 $fields = array();
698                             }
699                             break;
700                         default:
701                             $fields = true;
702                     }
703                 }
704                 $this->server_caps[$name] = $fields;
705             }
706         }
707     }
708
709     /**
710      * Send an SMTP MAIL command.
711      * Starts a mail transaction from the email address specified in
712      * $from. Returns true if successful or false otherwise. If True
713      * the mail transaction is started and then one or more recipient
714      * commands may be called followed by a data command.
715      * Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
716      * @param string $from Source address of this message
717      * @access public
718      * @return boolean
719      */
720     public function mail($from)
721     {
722         $useVerp = ($this->do_verp ? ' XVERP' : '');
723         return $this->sendCommand(
724             'MAIL FROM',
725             'MAIL FROM:<' . $from . '>' . $useVerp,
726             250
727         );
728     }
729
730     /**
731      * Send an SMTP QUIT command.
732      * Closes the socket if there is no error or the $close_on_error argument is true.
733      * Implements from rfc 821: QUIT <CRLF>
734      * @param boolean $close_on_error Should the connection close if an error occurs?
735      * @access public
736      * @return boolean
737      */
738     public function quit($close_on_error = true)
739     {
740         $noerror = $this->sendCommand('QUIT', 'QUIT', 221);
741         $err = $this->error; //Save any error
742         if ($noerror or $close_on_error) {
743             $this->close();
744             $this->error = $err; //Restore any error from the quit command
745         }
746         return $noerror;
747     }
748
749     /**
750      * Send an SMTP RCPT command.
751      * Sets the TO argument to $toaddr.
752      * Returns true if the recipient was accepted false if it was rejected.
753      * Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
754      * @param string $address The address the message is being sent to
755      * @access public
756      * @return boolean
757      */
758     public function recipient($address)
759     {
760         return $this->sendCommand(
761             'RCPT TO',
762             'RCPT TO:<' . $address . '>',
763             array(250, 251)
764         );
765     }
766
767     /**
768      * Send an SMTP RSET command.
769      * Abort any transaction that is currently in progress.
770      * Implements rfc 821: RSET <CRLF>
771      * @access public
772      * @return boolean True on success.
773      */
774     public function reset()
775     {
776         return $this->sendCommand('RSET', 'RSET', 250);
777     }
778
779     /**
780      * Send a command to an SMTP server and check its return code.
781      * @param string $command The command name - not sent to the server
782      * @param string $commandstring The actual command to send
783      * @param integer|array $expect One or more expected integer success codes
784      * @access protected
785      * @return boolean True on success.
786      */
787     protected function sendCommand($command, $commandstring, $expect)
788     {
789         if (!$this->connected()) {
790             $this->setError("Called $command without being connected");
791             return false;
792         }
793         //Reject line breaks in all commands
794         if (strpos($commandstring, "\n") !== false or strpos($commandstring, "\r") !== false) {
795             $this->setError("Command '$command' contained line breaks");
796             return false;
797         }
798         $this->client_send($commandstring . self::CRLF);
799
800         $this->last_reply = $this->get_lines();
801         // Fetch SMTP code and possible error code explanation
802         $matches = array();
803         if (preg_match("/^([0-9]{3})[ -](?:([0-9]\\.[0-9]\\.[0-9]) )?/", $this->last_reply, $matches)) {
804             $code = $matches[1];
805             $code_ex = (count($matches) > 2 ? $matches[2] : null);
806             // Cut off error code from each response line
807             $detail = preg_replace(
808                 "/{$code}[ -]".($code_ex ? str_replace('.', '\\.', $code_ex).' ' : '')."/m",
809                 '',
810                 $this->last_reply
811             );
812         } else {
813             // Fall back to simple parsing if regex fails
814             $code = substr($this->last_reply, 0, 3);
815             $code_ex = null;
816             $detail = substr($this->last_reply, 4);
817         }
818
819         $this->edebug('SERVER -> CLIENT: ' . $this->last_reply, self::DEBUG_SERVER);
820
821         if (!in_array($code, (array)$expect)) {
822             $this->setError(
823                 "$command command failed",
824                 $detail,
825                 $code,
826                 $code_ex
827             );
828             $this->edebug(
829                 'SMTP ERROR: ' . $this->error['error'] . ': ' . $this->last_reply,
830                 self::DEBUG_CLIENT
831             );
832             return false;
833         }
834
835         $this->setError('');
836         return true;
837     }
838
839     /**
840      * Send an SMTP SAML command.
841      * Starts a mail transaction from the email address specified in $from.
842      * Returns true if successful or false otherwise. If True
843      * the mail transaction is started and then one or more recipient
844      * commands may be called followed by a data command. This command
845      * will send the message to the users terminal if they are logged
846      * in and send them an email.
847      * Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
848      * @param string $from The address the message is from
849      * @access public
850      * @return boolean
851      */
852     public function sendAndMail($from)
853     {
854         return $this->sendCommand('SAML', "SAML FROM:$from", 250);
855     }
856
857     /**
858      * Send an SMTP VRFY command.
859      * @param string $name The name to verify
860      * @access public
861      * @return boolean
862      */
863     public function verify($name)
864     {
865         return $this->sendCommand('VRFY', "VRFY $name", array(250, 251));
866     }
867
868     /**
869      * Send an SMTP NOOP command.
870      * Used to keep keep-alives alive, doesn't actually do anything
871      * @access public
872      * @return boolean
873      */
874     public function noop()
875     {
876         return $this->sendCommand('NOOP', 'NOOP', 250);
877     }
878
879     /**
880      * Send an SMTP TURN command.
881      * This is an optional command for SMTP that this class does not support.
882      * This method is here to make the RFC821 Definition complete for this class
883      * and _may_ be implemented in future
884      * Implements from rfc 821: TURN <CRLF>
885      * @access public
886      * @return boolean
887      */
888     public function turn()
889     {
890         $this->setError('The SMTP TURN command is not implemented');
891         $this->edebug('SMTP NOTICE: ' . $this->error['error'], self::DEBUG_CLIENT);
892         return false;
893     }
894
895     /**
896      * Send raw data to the server.
897      * @param string $data The data to send
898      * @access public
899      * @return integer|boolean The number of bytes sent to the server or false on error
900      */
901     public function client_send($data)
902     {
903         $this->edebug("CLIENT -> SERVER: $data", self::DEBUG_CLIENT);
904         return fwrite($this->smtp_conn, $data);
905     }
906
907     /**
908      * Get the latest error.
909      * @access public
910      * @return array
911      */
912     public function getError()
913     {
914         return $this->error;
915     }
916
917     /**
918      * Get SMTP extensions available on the server
919      * @access public
920      * @return array|null
921      */
922     public function getServerExtList()
923     {
924         return $this->server_caps;
925     }
926
927     /**
928      * A multipurpose method
929      * The method works in three ways, dependent on argument value and current state
930      *   1. HELO/EHLO was not sent - returns null and set up $this->error
931      *   2. HELO was sent
932      *     $name = 'HELO': returns server name
933      *     $name = 'EHLO': returns boolean false
934      *     $name = any string: returns null and set up $this->error
935      *   3. EHLO was sent
936      *     $name = 'HELO'|'EHLO': returns server name
937      *     $name = any string: if extension $name exists, returns boolean True
938      *       or its options. Otherwise returns boolean False
939      * In other words, one can use this method to detect 3 conditions:
940      *  - null returned: handshake was not or we don't know about ext (refer to $this->error)
941      *  - false returned: the requested feature exactly not exists
942      *  - positive value returned: the requested feature exists
943      * @param string $name Name of SMTP extension or 'HELO'|'EHLO'
944      * @return mixed
945      */
946     public function getServerExt($name)
947     {
948         if (!$this->server_caps) {
949             $this->setError('No HELO/EHLO was sent');
950             return null;
951         }
952
953         // the tight logic knot ;)
954         if (!array_key_exists($name, $this->server_caps)) {
955             if ($name == 'HELO') {
956                 return $this->server_caps['EHLO'];
957             }
958             if ($name == 'EHLO' || array_key_exists('EHLO', $this->server_caps)) {
959                 return false;
960             }
961             $this->setError('HELO handshake was used. Client knows nothing about server extensions');
962             return null;
963         }
964
965         return $this->server_caps[$name];
966     }
967
968     /**
969      * Get the last reply from the server.
970      * @access public
971      * @return string
972      */
973     public function getLastReply()
974     {
975         return $this->last_reply;
976     }
977
978     /**
979      * Read the SMTP server's response.
980      * Either before eof or socket timeout occurs on the operation.
981      * With SMTP we can tell if we have more lines to read if the
982      * 4th character is '-' symbol. If it is a space then we don't
983      * need to read anything else.
984      * @access protected
985      * @return string
986      */
987     protected function get_lines()
988     {
989         // If the connection is bad, give up straight away
990         if (!is_resource($this->smtp_conn)) {
991             return '';
992         }
993         $data = '';
994         $endtime = 0;
995         stream_set_timeout($this->smtp_conn, $this->Timeout);
996         if ($this->Timelimit > 0) {
997             $endtime = time() + $this->Timelimit;
998         }
999         while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {
1000             $str = @fgets($this->smtp_conn, 515);
1001             $this->edebug("SMTP -> get_lines(): \$data is \"$data\"", self::DEBUG_LOWLEVEL);
1002             $this->edebug("SMTP -> get_lines(): \$str is  \"$str\"", self::DEBUG_LOWLEVEL);
1003             $data .= $str;
1004             // If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen
1005             if ((isset($str[3]) and $str[3] == ' ')) {
1006                 break;
1007             }
1008             // Timed-out? Log and break
1009             $info = stream_get_meta_data($this->smtp_conn);
1010             if ($info['timed_out']) {
1011                 $this->edebug(
1012                     'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)',
1013                     self::DEBUG_LOWLEVEL
1014                 );
1015                 break;
1016             }
1017             // Now check if reads took too long
1018             if ($endtime and time() > $endtime) {
1019                 $this->edebug(
1020                     'SMTP -> get_lines(): timelimit reached ('.
1021                     $this->Timelimit . ' sec)',
1022                     self::DEBUG_LOWLEVEL
1023                 );
1024                 break;
1025             }
1026         }
1027         return $data;
1028     }
1029
1030     /**
1031      * Enable or disable VERP address generation.
1032      * @param boolean $enabled
1033      */
1034     public function setVerp($enabled = false)
1035     {
1036         $this->do_verp = $enabled;
1037     }
1038
1039     /**
1040      * Get VERP address generation mode.
1041      * @return boolean
1042      */
1043     public function getVerp()
1044     {
1045         return $this->do_verp;
1046     }
1047
1048     /**
1049      * Set error messages and codes.
1050      * @param string $message The error message
1051      * @param string $detail Further detail on the error
1052      * @param string $smtp_code An associated SMTP error code
1053      * @param string $smtp_code_ex Extended SMTP code
1054      */
1055     protected function setError($message, $detail = '', $smtp_code = '', $smtp_code_ex = '')
1056     {
1057         $this->error = array(
1058             'error' => $message,
1059             'detail' => $detail,
1060             'smtp_code' => $smtp_code,
1061             'smtp_code_ex' => $smtp_code_ex
1062         );
1063     }
1064
1065     /**
1066      * Set debug output method.
1067      * @param string|callable $method The name of the mechanism to use for debugging output, or a callable to handle it.
1068      */
1069     public function setDebugOutput($method = 'echo')
1070     {
1071         $this->Debugoutput = $method;
1072     }
1073
1074     /**
1075      * Get debug output method.
1076      * @return string
1077      */
1078     public function getDebugOutput()
1079     {
1080         return $this->Debugoutput;
1081     }
1082
1083     /**
1084      * Set debug output level.
1085      * @param integer $level
1086      */
1087     public function setDebugLevel($level = 0)
1088     {
1089         $this->do_debug = $level;
1090     }
1091
1092     /**
1093      * Get debug output level.
1094      * @return integer
1095      */
1096     public function getDebugLevel()
1097     {
1098         return $this->do_debug;
1099     }
1100
1101     /**
1102      * Set SMTP timeout.
1103      * @param integer $timeout
1104      */
1105     public function setTimeout($timeout = 0)
1106     {
1107         $this->Timeout = $timeout;
1108     }
1109
1110     /**
1111      * Get SMTP timeout.
1112      * @return integer
1113      */
1114     public function getTimeout()
1115     {
1116         return $this->Timeout;
1117     }
1118 }