3 .---------------------------------------------------------------------------.
4 | Software: PHPMailer - PHP email class |
6 | Site: https://code.google.com/a/apache-extras.org/p/phpmailer/ |
7 | ------------------------------------------------------------------------- |
8 | Admin: Jim Jagielski (project admininistrator) |
9 | Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net |
10 | : Marcus Bointon (coolbru) coolbru@users.sourceforge.net |
11 | : Jim Jagielski (jimjag) jimjag@gmail.com |
12 | Founder: Brent R. Matzelle (original founder) |
13 | Copyright (c) 2010-2012, Jim Jagielski. All Rights Reserved. |
14 | Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
15 | Copyright (c) 2001-2003, Brent R. Matzelle |
16 | ------------------------------------------------------------------------- |
17 | License: Distributed under the Lesser General Public License (LGPL) |
18 | http://www.gnu.org/copyleft/lesser.html |
19 | This program is distributed in the hope that it will be useful - WITHOUT |
20 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
21 | FITNESS FOR A PARTICULAR PURPOSE. |
22 '---------------------------------------------------------------------------'
26 * PHPMailer - PHP SMTP email transport class
27 * NOTE: Designed for use with PHP version 5 and up
29 * @author Andy Prevost
30 * @author Marcus Bointon
31 * @copyright 2004 - 2008 Andy Prevost
32 * @author Jim Jagielski
33 * @copyright 2010 - 2012 Jim Jagielski
34 * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
35 * @version $Id: class.smtp.php 450 2010-06-23 16:46:33Z coolbru $
39 * SMTP is rfc 821 compliant and implements all the rfc 821 SMTP
40 * commands except TURN which will always return a not implemented
41 * error. SMTP also provides some utility methods for sending mail
43 * original author: Chris Ryan
51 public $SMTP_PORT = 25;
54 * SMTP reply line ending
57 public $CRLF = "\r\n";
60 * Sets whether debugging is turned on
63 public $do_debug; // the level of debug to perform
66 * Sets VERP use on/off (default is off)
69 public $do_verp = false;
72 * Sets the SMTP PHPMailer Version number
75 public $Version = '5.2.1';
77 /////////////////////////////////////////////////
78 // PROPERTIES, PRIVATE AND PROTECTED
79 /////////////////////////////////////////////////
81 private $smtp_conn; // the socket to the server
82 private $error; // error if any on the last call
83 private $helo_rply; // the reply the server sent to us for HELO
86 * Initialize the class so that the data is in a known state.
90 public function __construct() {
93 $this->helo_rply = null;
98 /////////////////////////////////////////////////
99 // CONNECTION FUNCTIONS
100 /////////////////////////////////////////////////
103 * Connect to the server specified on the port specified.
104 * If the port is not specified use the default SMTP_PORT.
105 * If tval is specified then a connection will try and be
106 * established with the server for that number of seconds.
107 * If tval is not specified the default is 30 seconds to
108 * try on the connection.
110 * SMTP CODE SUCCESS: 220
111 * SMTP CODE FAILURE: 421
115 public function Connect($host, $port = 0, $tval = 30) {
116 // set the error val to null so there is no confusion
119 // make sure we are __not__ connected
120 if($this->connected()) {
121 // already connected, generate error
122 $this->error = array("error" => "Already connected to a server");
127 $port = $this->SMTP_PORT;
130 // connect to the smtp server
131 $this->smtp_conn = @fsockopen($host, // the host of the server
132 $port, // the port to use
133 $errno, // error number if any
134 $errstr, // error message if any
135 $tval); // give up after ? secs
136 // verify we connected properly
137 if(empty($this->smtp_conn)) {
138 $this->error = array("error" => "Failed to connect to server",
140 "errstr" => $errstr);
141 if($this->do_debug >= 1) {
142 echo "SMTP -> ERROR: " . $this->error["error"] . ": $errstr ($errno)" . $this->CRLF . '<br />';
147 // SMTP server can take longer to respond, give longer timeout for first read
148 // Windows does not have support for this timeout function
149 if(substr(PHP_OS, 0, 3) != "WIN")
150 socket_set_timeout($this->smtp_conn, $tval, 0);
152 // get any announcement
153 $announce = $this->get_lines();
155 if($this->do_debug >= 2) {
156 echo "SMTP -> FROM SERVER:" . $announce . $this->CRLF . '<br />';
163 * Initiate a TLS communication with the server.
165 * SMTP CODE 220 Ready to start TLS
166 * SMTP CODE 501 Syntax error (no parameters allowed)
167 * SMTP CODE 454 TLS not available due to temporary reason
169 * @return bool success
171 public function StartTLS() {
172 $this->error = null; # to avoid confusion
174 if(!$this->connected()) {
175 $this->error = array("error" => "Called StartTLS() without being connected");
179 fputs($this->smtp_conn,"STARTTLS" . $this->CRLF);
181 $rply = $this->get_lines();
182 $code = substr($rply,0,3);
184 if($this->do_debug >= 2) {
185 echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
190 array("error" => "STARTTLS not accepted from server",
191 "smtp_code" => $code,
192 "smtp_msg" => substr($rply,4));
193 if($this->do_debug >= 1) {
194 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
199 // Begin encrypted connection
200 if(!stream_socket_enable_crypto($this->smtp_conn, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
208 * Performs SMTP authentication. Must be run after running the
209 * Hello() method. Returns true if successfully authenticated.
213 public function Authenticate($username, $password) {
214 // Start authentication
215 fputs($this->smtp_conn,"AUTH LOGIN" . $this->CRLF);
217 $rply = $this->get_lines();
218 $code = substr($rply,0,3);
222 array("error" => "AUTH not accepted from server",
223 "smtp_code" => $code,
224 "smtp_msg" => substr($rply,4));
225 if($this->do_debug >= 1) {
226 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
231 // Send encoded username
232 fputs($this->smtp_conn, base64_encode($username) . $this->CRLF);
234 $rply = $this->get_lines();
235 $code = substr($rply,0,3);
239 array("error" => "Username not accepted from server",
240 "smtp_code" => $code,
241 "smtp_msg" => substr($rply,4));
242 if($this->do_debug >= 1) {
243 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
248 // Send encoded password
249 fputs($this->smtp_conn, base64_encode($password) . $this->CRLF);
251 $rply = $this->get_lines();
252 $code = substr($rply,0,3);
256 array("error" => "Password not accepted from server",
257 "smtp_code" => $code,
258 "smtp_msg" => substr($rply,4));
259 if($this->do_debug >= 1) {
260 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
269 * Returns true if connected to a server otherwise false
273 public function Connected() {
274 if(!empty($this->smtp_conn)) {
275 $sock_status = socket_get_status($this->smtp_conn);
276 if($sock_status["eof"]) {
277 // the socket is valid but we are not connected
278 if($this->do_debug >= 1) {
279 echo "SMTP -> NOTICE:" . $this->CRLF . "EOF caught while checking if connected";
284 return true; // everything looks good
290 * Closes the socket and cleans up the state of the class.
291 * It is not considered good to use this function without
292 * first trying to use QUIT.
296 public function Close() {
297 $this->error = null; // so there is no confusion
298 $this->helo_rply = null;
299 if(!empty($this->smtp_conn)) {
300 // close the connection and cleanup
301 fclose($this->smtp_conn);
302 $this->smtp_conn = 0;
306 /////////////////////////////////////////////////
308 /////////////////////////////////////////////////
311 * Issues a data command and sends the msg_data to the server
312 * finializing the mail transaction. $msg_data is the message
313 * that is to be send with the headers. Each header needs to be
314 * on a single line followed by a <CRLF> with the message headers
315 * and the message body being seperated by and additional <CRLF>.
317 * Implements rfc 821: DATA <CRLF>
319 * SMTP CODE INTERMEDIATE: 354
322 * SMTP CODE SUCCESS: 250
323 * SMTP CODE FAILURE: 552,554,451,452
324 * SMTP CODE FAILURE: 451,554
325 * SMTP CODE ERROR : 500,501,503,421
329 public function Data($msg_data) {
330 $this->error = null; // so no confusion is caused
332 if(!$this->connected()) {
333 $this->error = array(
334 "error" => "Called Data() without being connected");
338 fputs($this->smtp_conn,"DATA" . $this->CRLF);
340 $rply = $this->get_lines();
341 $code = substr($rply,0,3);
343 if($this->do_debug >= 2) {
344 echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
349 array("error" => "DATA command not accepted from server",
350 "smtp_code" => $code,
351 "smtp_msg" => substr($rply,4));
352 if($this->do_debug >= 1) {
353 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
358 /* the server is ready to accept data!
359 * according to rfc 821 we should not send more than 1000
361 * characters on a single line so we will break the data up
362 * into lines by \r and/or \n then if needed we will break
363 * each of those into smaller lines to fit within the limit.
364 * in addition we will be looking for lines that start with
365 * a period '.' and append and additional period '.' to that
366 * line. NOTE: this does not count towards limit.
369 // normalize the line breaks so we know the explode works
370 $msg_data = str_replace("\r\n","\n",$msg_data);
371 $msg_data = str_replace("\r","\n",$msg_data);
372 $lines = explode("\n",$msg_data);
374 /* we need to find a good way to determine is headers are
375 * in the msg_data or if it is a straight msg body
376 * currently I am assuming rfc 822 definitions of msg headers
377 * and if the first field of the first line (':' sperated)
378 * does not contain a space then it _should_ be a header
379 * and we can process all lines before a blank "" line as
383 $field = substr($lines[0],0,strpos($lines[0],":"));
385 if(!empty($field) && !strstr($field," ")) {
389 $max_line_length = 998; // used below; set here for ease in change
391 while(list(,$line) = @each($lines)) {
393 if($line == "" && $in_headers) {
396 // ok we need to break this line up into several smaller lines
397 while(strlen($line) > $max_line_length) {
398 $pos = strrpos(substr($line,0,$max_line_length)," ");
400 // Patch to fix DOS attack
402 $pos = $max_line_length - 1;
403 $lines_out[] = substr($line,0,$pos);
404 $line = substr($line,$pos);
406 $lines_out[] = substr($line,0,$pos);
407 $line = substr($line,$pos + 1);
410 /* if processing headers add a LWSP-char to the front of new line
411 * rfc 822 on long msg headers
414 $line = "\t" . $line;
417 $lines_out[] = $line;
419 // send the lines to the server
420 while(list(,$line_out) = @each($lines_out)) {
421 if(strlen($line_out) > 0)
423 if(substr($line_out, 0, 1) == ".") {
424 $line_out = "." . $line_out;
427 fputs($this->smtp_conn,$line_out . $this->CRLF);
431 // message data has been sent
432 fputs($this->smtp_conn, $this->CRLF . "." . $this->CRLF);
434 $rply = $this->get_lines();
435 $code = substr($rply,0,3);
437 if($this->do_debug >= 2) {
438 echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
443 array("error" => "DATA not accepted from server",
444 "smtp_code" => $code,
445 "smtp_msg" => substr($rply,4));
446 if($this->do_debug >= 1) {
447 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
455 * Sends the HELO command to the smtp server.
456 * This makes sure that we and the server are in
457 * the same known state.
459 * Implements from rfc 821: HELO <SP> <domain> <CRLF>
461 * SMTP CODE SUCCESS: 250
462 * SMTP CODE ERROR : 500, 501, 504, 421
466 public function Hello($host = '') {
467 $this->error = null; // so no confusion is caused
469 if(!$this->connected()) {
470 $this->error = array(
471 "error" => "Called Hello() without being connected");
475 // if hostname for HELO was not specified send default
477 // determine appropriate default to send to server
481 // Send extended hello first (RFC 2821)
482 if(!$this->SendHello("EHLO", $host)) {
483 if(!$this->SendHello("HELO", $host)) {
492 * Sends a HELO/EHLO command.
496 private function SendHello($hello, $host) {
497 fputs($this->smtp_conn, $hello . " " . $host . $this->CRLF);
499 $rply = $this->get_lines();
500 $code = substr($rply,0,3);
502 if($this->do_debug >= 2) {
503 echo "SMTP -> FROM SERVER: " . $rply . $this->CRLF . '<br />';
508 array("error" => $hello . " not accepted from server",
509 "smtp_code" => $code,
510 "smtp_msg" => substr($rply,4));
511 if($this->do_debug >= 1) {
512 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
517 $this->helo_rply = $rply;
523 * Starts a mail transaction from the email address specified in
524 * $from. Returns true if successful or false otherwise. If True
525 * the mail transaction is started and then one or more Recipient
526 * commands may be called followed by a Data command.
528 * Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
530 * SMTP CODE SUCCESS: 250
531 * SMTP CODE SUCCESS: 552,451,452
532 * SMTP CODE SUCCESS: 500,501,421
536 public function Mail($from) {
537 $this->error = null; // so no confusion is caused
539 if(!$this->connected()) {
540 $this->error = array(
541 "error" => "Called Mail() without being connected");
545 $useVerp = ($this->do_verp ? "XVERP" : "");
546 fputs($this->smtp_conn,"MAIL FROM:<" . $from . ">" . $useVerp . $this->CRLF);
548 $rply = $this->get_lines();
549 $code = substr($rply,0,3);
551 if($this->do_debug >= 2) {
552 echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
557 array("error" => "MAIL not accepted from server",
558 "smtp_code" => $code,
559 "smtp_msg" => substr($rply,4));
560 if($this->do_debug >= 1) {
561 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
569 * Sends the quit command to the server and then closes the socket
570 * if there is no error or the $close_on_error argument is true.
572 * Implements from rfc 821: QUIT <CRLF>
574 * SMTP CODE SUCCESS: 221
575 * SMTP CODE ERROR : 500
579 public function Quit($close_on_error = true) {
580 $this->error = null; // so there is no confusion
582 if(!$this->connected()) {
583 $this->error = array(
584 "error" => "Called Quit() without being connected");
588 // send the quit command to the server
589 fputs($this->smtp_conn,"quit" . $this->CRLF);
591 // get any good-bye messages
592 $byemsg = $this->get_lines();
594 if($this->do_debug >= 2) {
595 echo "SMTP -> FROM SERVER:" . $byemsg . $this->CRLF . '<br />';
601 $code = substr($byemsg,0,3);
603 // use e as a tmp var cause Close will overwrite $this->error
604 $e = array("error" => "SMTP server rejected quit command",
605 "smtp_code" => $code,
606 "smtp_rply" => substr($byemsg,4));
608 if($this->do_debug >= 1) {
609 echo "SMTP -> ERROR: " . $e["error"] . ": " . $byemsg . $this->CRLF . '<br />';
613 if(empty($e) || $close_on_error) {
621 * Sends the command RCPT to the SMTP server with the TO: argument of $to.
622 * Returns true if the recipient was accepted false if it was rejected.
624 * Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
626 * SMTP CODE SUCCESS: 250,251
627 * SMTP CODE FAILURE: 550,551,552,553,450,451,452
628 * SMTP CODE ERROR : 500,501,503,421
632 public function Recipient($to) {
633 $this->error = null; // so no confusion is caused
635 if(!$this->connected()) {
636 $this->error = array(
637 "error" => "Called Recipient() without being connected");
641 fputs($this->smtp_conn,"RCPT TO:<" . $to . ">" . $this->CRLF);
643 $rply = $this->get_lines();
644 $code = substr($rply,0,3);
646 if($this->do_debug >= 2) {
647 echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
650 if($code != 250 && $code != 251) {
652 array("error" => "RCPT not accepted from server",
653 "smtp_code" => $code,
654 "smtp_msg" => substr($rply,4));
655 if($this->do_debug >= 1) {
656 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
664 * Sends the RSET command to abort and transaction that is
665 * currently in progress. Returns true if successful false
668 * Implements rfc 821: RSET <CRLF>
670 * SMTP CODE SUCCESS: 250
671 * SMTP CODE ERROR : 500,501,504,421
675 public function Reset() {
676 $this->error = null; // so no confusion is caused
678 if(!$this->connected()) {
679 $this->error = array(
680 "error" => "Called Reset() without being connected");
684 fputs($this->smtp_conn,"RSET" . $this->CRLF);
686 $rply = $this->get_lines();
687 $code = substr($rply,0,3);
689 if($this->do_debug >= 2) {
690 echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
695 array("error" => "RSET failed",
696 "smtp_code" => $code,
697 "smtp_msg" => substr($rply,4));
698 if($this->do_debug >= 1) {
699 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
708 * Starts a mail transaction from the email address specified in
709 * $from. Returns true if successful or false otherwise. If True
710 * the mail transaction is started and then one or more Recipient
711 * commands may be called followed by a Data command. This command
712 * will send the message to the users terminal if they are logged
713 * in and send them an email.
715 * Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
717 * SMTP CODE SUCCESS: 250
718 * SMTP CODE SUCCESS: 552,451,452
719 * SMTP CODE SUCCESS: 500,501,502,421
723 public function SendAndMail($from) {
724 $this->error = null; // so no confusion is caused
726 if(!$this->connected()) {
727 $this->error = array(
728 "error" => "Called SendAndMail() without being connected");
732 fputs($this->smtp_conn,"SAML FROM:" . $from . $this->CRLF);
734 $rply = $this->get_lines();
735 $code = substr($rply,0,3);
737 if($this->do_debug >= 2) {
738 echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
743 array("error" => "SAML not accepted from server",
744 "smtp_code" => $code,
745 "smtp_msg" => substr($rply,4));
746 if($this->do_debug >= 1) {
747 echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
755 * This is an optional command for SMTP that this class does not
756 * support. This method is here to make the RFC821 Definition
757 * complete for this class and __may__ be implimented in the future
759 * Implements from rfc 821: TURN <CRLF>
761 * SMTP CODE SUCCESS: 250
762 * SMTP CODE FAILURE: 502
763 * SMTP CODE ERROR : 500, 503
767 public function Turn() {
768 $this->error = array("error" => "This method, TURN, of the SMTP ".
769 "is not implemented");
770 if($this->do_debug >= 1) {
771 echo "SMTP -> NOTICE: " . $this->error["error"] . $this->CRLF . '<br />';
777 * Get the current error
781 public function getError() {
785 /////////////////////////////////////////////////
786 // INTERNAL FUNCTIONS
787 /////////////////////////////////////////////////
790 * Read in as many lines as possible
791 * either before eof or socket timeout occurs on the operation.
792 * With SMTP we can tell if we have more lines to read if the
793 * 4th character is '-' symbol. If it is a space then we don't
794 * need to read anything else.
798 private function get_lines() {
800 while(!feof($this->smtp_conn)) {
801 $str = @fgets($this->smtp_conn,515);
802 if($this->do_debug >= 4) {
803 echo "SMTP -> get_lines(): \$data was \"$data\"" . $this->CRLF . '<br />';
804 echo "SMTP -> get_lines(): \$str is \"$str\"" . $this->CRLF . '<br />';
807 if($this->do_debug >= 4) {
808 echo "SMTP -> get_lines(): \$data is \"$data\"" . $this->CRLF . '<br />';
810 // if 4th character is a space, we are done reading, break the loop
811 if(substr($str,3,1) == " ") { break; }