Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Centralise check for debug output

PSR-2 reformat

Enable debug output for failing test

Fix broken test
Comment clearout

Proper thin spaces before French punctuation

Fix phpdocs for addrAppend and addrFormat, fixes #81
Minor code cleanup, remove some local vars

See changelog.

More phpdoc cleanup
  • Loading branch information...
commit d992ae6dc4a14ccce7019d8a71d52b7f70d73403 1 parent c5e9f78
Marcus Bointon authored
2  LICENSE
View
@@ -312,7 +312,7 @@ of these things:
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
- e) Verify that the user has already received a copy of these
+ e) verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
33 PHPMailerAutoload.php
View
@@ -0,0 +1,33 @@
+<?php
+/**
+ * PHPMailer SPL autoloader.
+ * PHP Version 5.0.0
+ * @package PHPMailer
+ * @link https://github.com/PHPMailer/PHPMailer/
+ * @author Marcus Bointon (coolbru) <phpmailer@synchromedia.co.uk>
+ * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
+ * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
+ * @author Brent R. Matzelle (original founder)
+ * @copyright 2013 Marcus Bointon
+ * @copyright 2010 - 2012 Jim Jagielski
+ * @copyright 2004 - 2009 Andy Prevost
+ * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
+ * @note This program is distributed in the hope that it will be useful - WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.
+ */
+
+/**
+ * PHPMailer SPL autoloader.
+ * @param string $classname The name of the class to load
+ */
+function PHPMailerAutoload($classname)
+{
+ //Can't use __DIR__ as it's only in PHP 5.3+
+ $filename = dirname(__FILE__).DIRECTORY_SEPARATOR.'class.'.strtolower($classname).'.php';
+ if (is_readable($filename)) {
+ require $filename;
+ }
+}
+
+spl_autoload_register('PHPMailerAutoload');
24 README.md
View
@@ -7,7 +7,7 @@ Build status: [![Build Status](https://travis-ci.org/Synchro/PHPMailer.png)](htt
- Probably the world's most popular code for sending email from PHP!
- Used by many open-source projects: Drupal, SugarCRM, Yii, Joomla! and many more
- Integrated SMTP support - send without a local mail server
-- Send emails with multiple TOs, CCs, BCCs and REPLY-TOs
+- send emails with multiple TOs, CCs, BCCs and REPLY-TOs
- Multipart/alternative emails for mail clients that do not read HTML email
- Support for 8bit, base64, binary, and quoted-printable encoding
- SMTP authentication with LOGIN, PLAIN, NTLM and CRAM-MD5 mechanisms
@@ -42,7 +42,7 @@ require 'class.phpmailer.php';
$mail = new PHPMailer;
-$mail->IsSMTP(); // Set mailer to use SMTP
+$mail->isSMTP(); // Set mailer to use SMTP
$mail->Host = 'smtp1.example.com;smtp2.example.com'; // Specify main and backup server
$mail->SMTPAuth = true; // Enable SMTP authentication
$mail->Username = 'jswan'; // SMTP username
@@ -51,22 +51,22 @@ $mail->SMTPSecure = 'tls'; // Enable encryption, 'ssl
$mail->From = 'from@example.com';
$mail->FromName = 'Mailer';
-$mail->AddAddress('josh@example.net', 'Josh Adams'); // Add a recipient
-$mail->AddAddress('ellen@example.com'); // Name is optional
-$mail->AddReplyTo('info@example.com', 'Information');
-$mail->AddCC('cc@example.com');
-$mail->AddBCC('bcc@example.com');
+$mail->addAddress('josh@example.net', 'Josh Adams'); // Add a recipient
+$mail->addAddress('ellen@example.com'); // Name is optional
+$mail->addReplyTo('info@example.com', 'Information');
+$mail->addCC('cc@example.com');
+$mail->addBCC('bcc@example.com');
$mail->WordWrap = 50; // Set word wrap to 50 characters
-$mail->AddAttachment('/var/tmp/file.tar.gz'); // Add attachments
-$mail->AddAttachment('/tmp/image.jpg', 'new.jpg'); // Optional name
-$mail->IsHTML(true); // Set email format to HTML
+$mail->addAttachment('/var/tmp/file.tar.gz'); // Add attachments
+$mail->addAttachment('/tmp/image.jpg', 'new.jpg'); // Optional name
+$mail->isHTML(true); // Set email format to HTML
$mail->Subject = 'Here is the subject';
$mail->Body = 'This is the HTML message body <b>in bold!</b>';
$mail->AltBody = 'This is the body in plain text for non-HTML mail clients';
-if(!$mail->Send()) {
+if(!$mail->send()) {
echo 'Message could not be sent.';
echo 'Mailer Error: ' . $mail->ErrorInfo;
exit;
@@ -84,7 +84,7 @@ PHPMailer defaults to English, but in the `languages` folder you'll find numerou
```php
// To load the French version
-$mail->SetLanguage('fr', '/optional/path/to/language/directory/');
+$mail->setLanguage('fr', '/optional/path/to/language/directory/');
```
## Documentation
16 changelog.md
View
@@ -1,5 +1,6 @@
# ChangeLog
+## Version 5.2.7 ()
* Add Ukranian translation from @Krezalis
* Support for do_verp
* Fix bug in CRAM-MD5 AUTH
@@ -14,19 +15,26 @@
* Update SyntaxHighlighter
* Major overhaul and cleanup of example code
* New PHPMailer graphic
-* MsgHTML now uses RFC2392-compliant content ids
-* Add line break normalization function and use it in MsgHTML
+* msgHTML now uses RFC2392-compliant content ids
+* Add line break normalization function and use it in msgHTML
* Don't set unnecessary reply-to addresses
* Make fakesendmail.sh a bit cleaner and safer
* Set a content-transfer-encoding on multiparts (fixes msglint error)
-* Fix cid generation in MsgHTML (Thanks to @digitalthought)
+* Fix cid generation in msgHTML (Thanks to @digitalthought)
* Fix handling of multiple SMTP servers (Thanks to @NanoCaiordo)
-* SMTP->Connect() now supports stream context options (Thanks to @stanislavdavid)
+* SMTP->connect() now supports stream context options (Thanks to @stanislavdavid)
* Add support for iCal event alternatives (Thanks to @reblutus)
* Update to Polish language file (Thanks to Krzysztof Kowalewski)
* Update to Norwegian language file (Thanks to @datagutten)
* Update to Hungarian language file (Thanks to @dominicus-75)
* Add Persian/Farsi translation from @jaii
+* Make SMTPDebug property type match type in SMTP class
+* Add unit tests for DKIM
+* Major refactor of SMTP class
+* Reformat to PSR-2 coding standard
+* Introduce autoloader
+* Allow overriding of SMTP class
+* Overhaul of PHPDocs
## Version 5.2.6 (April 11th 2013)
* Reflect move to PHPMailer GitHub organisation at https://github.com/PHPMailer/PHPMailer
6,134 class.phpmailer.php
View
3,207 additions, 2,927 deletions not shown
739 class.pop3.php
View
@@ -1,418 +1,383 @@
<?php
-/*~ class.pop3.php
-.---------------------------------------------------------------------------.
-| Software: PHPMailer - PHP email class |
-| Version: 5.2.6 |
-| Site: https://github.com/PHPMailer/PHPMailer/ |
-| ------------------------------------------------------------------------- |
-| Admins: Marcus Bointon |
-| Admins: Jim Jagielski |
-| Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net |
-| : Marcus Bointon (coolbru) coolbru@users.sourceforge.net |
-| : Jim Jagielski (jimjag) jimjag@gmail.com |
-| Founder: Brent R. Matzelle (original founder) |
-| Copyright (c) 2010-2012, Jim Jagielski. All Rights Reserved. |
-| Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
-| Copyright (c) 2001-2003, Brent R. Matzelle |
-| ------------------------------------------------------------------------- |
-| License: Distributed under the Lesser General Public License (LGPL) |
-| http://www.gnu.org/copyleft/lesser.html |
-| This program is distributed in the hope that it will be useful - WITHOUT |
-| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
-| FITNESS FOR A PARTICULAR PURPOSE. |
-'---------------------------------------------------------------------------'
-*/
-
/**
- * PHPMailer - PHP POP Before SMTP Authentication Class
- * NOTE: Designed for use with PHP version 5 and up
+ * PHPMailer POP-Before-SMTP Authentication Class.
+ * PHP Version 5.0.0
+ * Version 5.2.7
* @package PHPMailer
- * @author Andy Prevost
- * @author Marcus Bointon
- * @author Jim Jagielski
+ * @link https://github.com/PHPMailer/PHPMailer/
+ * @author Marcus Bointon (coolbru) <phpmailer@synchromedia.co.uk>
+ * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
+ * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
+ * @author Brent R. Matzelle (original founder)
+ * @copyright 2013 Marcus Bointon
* @copyright 2010 - 2012 Jim Jagielski
* @copyright 2004 - 2009 Andy Prevost
- * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
+ * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
+ * @note This program is distributed in the hope that it will be useful - WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
- * PHP POP-Before-SMTP Authentication Class
- *
- * Version 5.2.6
- *
- * @license: LGPL, see PHPMailer License
- *
- * Specifically for PHPMailer to allow POP before SMTP authentication.
- * Does not yet work with APOP - if you have an APOP account, contact Jim Jagielski
- * and we can test changes to this script.
- *
- * This class is based on the structure of the SMTP class originally authored by Chris Ryan
- *
- * This class is rfc 1939 compliant and implements all the commands
- * required for POP3 connection, authentication and disconnection.
- *
+ * PHPMailer POP-Before-SMTP Authentication Class.
+ * Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication.
+ * Does not support APOP.
* @package PHPMailer
- * @author Richard Davey (orig) <rich@corephp.co.uk>
- * @author Andy Prevost
- * @author Jim Jagielski
+ * @author Richard Davey (original author) <rich@corephp.co.uk>
+ * @author Marcus Bointon (coolbru) <phpmailer@synchromedia.co.uk>
+ * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
+ * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
*/
-class POP3 {
- /**
- * Default POP3 port
- * @var int
- */
- public $POP3_PORT = 110;
-
- /**
- * Default Timeout
- * @var int
- */
- public $POP3_TIMEOUT = 30;
-
- /**
- * POP3 Carriage Return + Line Feed
- * @var string
- */
- public $CRLF = "\r\n";
-
- /**
- * Displaying Debug warnings? (0 = now, 1+ = yes)
- * @var int
- */
- public $do_debug = 2;
-
- /**
- * POP3 Mail Server
- * @var string
- */
- public $host;
-
- /**
- * POP3 Port
- * @var int
- */
- public $port;
-
- /**
- * POP3 Timeout Value
- * @var int
- */
- public $tval;
-
- /**
- * POP3 Username
- * @var string
- */
- public $username;
-
- /**
- * POP3 Password
- * @var string
- */
- public $password;
-
- /**
- * Sets the POP3 PHPMailer Version number
- * @var string
- */
- public $Version = '5.2.6';
-
- /////////////////////////////////////////////////
- // PROPERTIES, PRIVATE AND PROTECTED
- /////////////////////////////////////////////////
-
- /**
- * @var resource Resource handle for the POP connection socket
- */
- private $pop_conn;
- /**
- * @var boolean Are we connected?
- */
- private $connected;
- /**
- * @var array Error container
- */
- private $error; // Error log array
-
- /**
- * Constructor, sets the initial values
- * @access public
- * @return POP3
- */
- public function __construct() {
- $this->pop_conn = 0;
- $this->connected = false;
- $this->error = null;
- }
-
- /**
- * Combination of public events - connect, login, disconnect
- * @access public
- * @param string $host
- * @param bool|int $port
- * @param bool|int $tval
- * @param string $username
- * @param string $password
- * @param int $debug_level
- * @return bool
- */
- public function Authorise ($host, $port = false, $tval = false, $username, $password, $debug_level = 0) {
- $this->host = $host;
-
- // If no port value is passed, retrieve it
- if ($port == false) {
- $this->port = $this->POP3_PORT;
- } else {
- $this->port = $port;
+class POP3
+{
+ /**
+ * The POP3 PHPMailer Version number.
+ * @type string
+ * @access public
+ */
+ public $Version = '5.2.7';
+
+ /**
+ * Default POP3 port number.
+ * @type int
+ * @access public
+ */
+ public $POP3_PORT = 110;
+
+ /**
+ * Default timeout in seconds.
+ * @type int
+ * @access public
+ */
+ public $POP3_TIMEOUT = 30;
+
+ /**
+ * POP3 Carriage Return + Line Feed.
+ * @type string
+ * @access public
+ */
+ public $CRLF = "\r\n";
+
+ /**
+ * Debug display level.
+ * Options: 0 = no, 1+ = yes
+ * @type int
+ * @access public
+ */
+ public $do_debug = 0;
+
+ /**
+ * POP3 mail server hostname.
+ * @type string
+ * @access public
+ */
+ public $host;
+
+ /**
+ * POP3 port number.
+ * @type int
+ * @access public
+ */
+ public $port;
+
+ /**
+ * POP3 Timeout Value in seconds.
+ * @type int
+ * @access public
+ */
+ public $tval;
+
+ /**
+ * POP3 username
+ * @type string
+ * @access public
+ */
+ public $username;
+
+ /**
+ * POP3 password.
+ * @type string
+ * @access public
+ */
+ public $password;
+
+ /**
+ * Resource handle for the POP3 connection socket.
+ * @type resource
+ * @access private
+ */
+ private $pop_conn;
+
+ /**
+ * Are we connected?
+ * @type bool
+ * @access private
+ */
+ private $connected;
+
+ /**
+ * Error container.
+ * @type array
+ * @access private
+ */
+ private $error;
+
+ /**
+ * Constructor.
+ * @access public
+ * @access private
+ */
+ public function __construct()
+ {
+ $this->pop_conn = 0;
+ $this->connected = false;
+ $this->error = null;
}
- // If no port value is passed, retrieve it
- if ($tval == false) {
- $this->tval = $this->POP3_TIMEOUT;
- } else {
- $this->tval = $tval;
+ /**
+ * Authenticate with a POP3 server.
+ * A connect, login, disconnect sequence
+ * appropriate for POP-before SMTP authorisation.
+ * @access public
+ * @param string $host
+ * @param bool|int $port
+ * @param bool|int $tval
+ * @param string $username
+ * @param string $password
+ * @param int $debug_level
+ * @return bool
+ */
+ public function authorise($host, $port = false, $tval = false, $username = '', $password = '', $debug_level = 0)
+ {
+ $this->host = $host;
+ // If no port value is passed, retrieve it
+ if ($port == false) {
+ $this->port = $this->POP3_PORT;
+ } else {
+ $this->port = $port;
+ }
+ // If no port value is passed, retrieve it
+ if ($tval == false) {
+ $this->tval = $this->POP3_TIMEOUT;
+ } else {
+ $this->tval = $tval;
+ }
+ $this->do_debug = $debug_level;
+ $this->username = $username;
+ $this->password = $password;
+ // Refresh the error log
+ $this->error = null;
+ // connect
+ $result = $this->connect($this->host, $this->port, $this->tval);
+ if ($result) {
+ $login_result = $this->login($this->username, $this->password);
+ if ($login_result) {
+ $this->disconnect();
+ return true;
+ }
+ }
+ // We need to disconnect regardless if the login succeeded
+ $this->disconnect();
+ return false;
}
- $this->do_debug = $debug_level;
- $this->username = $username;
- $this->password = $password;
-
- // Refresh the error log
- $this->error = null;
-
- // Connect
- $result = $this->Connect($this->host, $this->port, $this->tval);
-
- if ($result) {
- $login_result = $this->Login($this->username, $this->password);
-
- if ($login_result) {
- $this->Disconnect();
-
- return true;
- }
-
+ /**
+ * Connect to a POP3 server.
+ * @access public
+ * @param string $host
+ * @param bool|int $port
+ * @param integer $tval
+ * @return boolean
+ */
+ public function connect($host, $port = false, $tval = 30)
+ {
+ // Are we already connected?
+ if ($this->connected) {
+ return true;
+ }
+
+ //On Windows this will raise a PHP Warning error if the hostname doesn't exist.
+ //Rather than suppress it with @fsockopen, capture it cleanly instead
+ set_error_handler(array($this, 'catchWarning'));
+
+ // connect to the POP3 server
+ $this->pop_conn = fsockopen(
+ $host, // POP3 Host
+ $port, // Port #
+ $errno, // Error Number
+ $errstr, // Error Message
+ $tval
+ ); // Timeout (seconds)
+ // Restore the error handler
+ restore_error_handler();
+ // Does the Error Log now contain anything?
+ if ($this->error && $this->do_debug >= 1) {
+ $this->displayErrors();
+ }
+ // Did we connect?
+ if ($this->pop_conn == false) {
+ // It would appear not...
+ $this->error = array(
+ 'error' => "Failed to connect to server $host on port $port",
+ 'errno' => $errno,
+ 'errstr' => $errstr
+ );
+ if ($this->do_debug >= 1) {
+ $this->displayErrors();
+ }
+ return false;
+ }
+
+ // Increase the stream time-out
+ // Check for PHP 4.3.0 or later
+ if (version_compare(phpversion(), '5.0.0', 'ge')) {
+ stream_set_timeout($this->pop_conn, $tval, 0);
+ } else {
+ // Does not work on Windows
+ if (substr(PHP_OS, 0, 3) !== 'WIN') {
+ socket_set_timeout($this->pop_conn, $tval, 0);
+ }
+ }
+
+ // Get the POP3 server response
+ $pop3_response = $this->getResponse();
+ // Check for the +OK
+ if ($this->checkResponse($pop3_response)) {
+ // The connection is established and the POP3 server is talking
+ $this->connected = true;
+ return true;
+ }
+ return false;
}
- // We need to disconnect regardless if the login succeeded
- $this->Disconnect();
-
- return false;
- }
-
- /**
- * Connect to the POP3 server
- * @access public
- * @param string $host
- * @param bool|int $port
- * @param integer $tval
- * @return boolean
- */
- public function Connect ($host, $port = false, $tval = 30) {
- // Are we already connected?
- if ($this->connected) {
- return true;
+ /**
+ * Log in to the POP3 server.
+ * Does not support APOP (RFC 2828, 4949).
+ * @access public
+ * @param string $username
+ * @param string $password
+ * @return boolean
+ */
+ public function login($username = '', $password = '')
+ {
+ if ($this->connected == false) {
+ $this->error = 'Not connected to POP3 server';
+
+ if ($this->do_debug >= 1) {
+ $this->displayErrors();
+ }
+ }
+ if (empty($username)) {
+ $username = $this->username;
+ }
+ if (empty($password)) {
+ $password = $this->password;
+ }
+ $pop_username = "USER $username" . $this->CRLF;
+ $pop_password = "PASS $password" . $this->CRLF;
+ // send the Username
+ $this->sendString($pop_username);
+ $pop3_response = $this->getResponse();
+ if ($this->checkResponse($pop3_response)) {
+ // send the Password
+ $this->sendString($pop_password);
+ $pop3_response = $this->getResponse();
+ if ($this->checkResponse($pop3_response)) {
+ return true;
+ }
+ }
+ return false;
}
- /*
- On Windows this will raise a PHP Warning error if the hostname doesn't exist.
- Rather than suppress it with @fsockopen, let's capture it cleanly instead
- */
-
- set_error_handler(array(&$this, 'catchWarning'));
-
- // Connect to the POP3 server
- $this->pop_conn = fsockopen($host, // POP3 Host
- $port, // Port #
- $errno, // Error Number
- $errstr, // Error Message
- $tval); // Timeout (seconds)
-
- // Restore the error handler
- restore_error_handler();
-
- // Does the Error Log now contain anything?
- if ($this->error && $this->do_debug >= 1) {
- $this->displayErrors();
+ /**
+ * Disconnect from the POP3 server.
+ * @access public
+ */
+ public function disconnect()
+ {
+ $this->sendString('QUIT');
+ fclose($this->pop_conn);
}
- // Did we connect?
- if ($this->pop_conn == false) {
- // It would appear not...
- $this->error = array(
- 'error' => "Failed to connect to server $host on port $port",
- 'errno' => $errno,
- 'errstr' => $errstr
- );
-
- if ($this->do_debug >= 1) {
- $this->displayErrors();
- }
-
- return false;
+ /**
+ * Get a response from the POP3 server.
+ * $size is the maximum number of bytes to retrieve
+ * @param integer $size
+ * @return string
+ * @access private
+ */
+ private function getResponse($size = 128)
+ {
+ $pop3_response = fgets($this->pop_conn, $size);
+ return $pop3_response;
}
- // Increase the stream time-out
-
- // Check for PHP 4.3.0 or later
- if (version_compare(phpversion(), '5.0.0', 'ge')) {
- stream_set_timeout($this->pop_conn, $tval, 0);
- } else {
- // Does not work on Windows
- if (substr(PHP_OS, 0, 3) !== 'WIN') {
- socket_set_timeout($this->pop_conn, $tval, 0);
- }
- }
-
- // Get the POP3 server response
- $pop3_response = $this->getResponse();
-
- // Check for the +OK
- if ($this->checkResponse($pop3_response)) {
- // The connection is established and the POP3 server is talking
- $this->connected = true;
- return true;
- }
- return false;
- }
-
- /**
- * Login to the POP3 server (does not support APOP yet)
- * @access public
- * @param string $username
- * @param string $password
- * @return boolean
- */
- public function Login ($username = '', $password = '') {
- if ($this->connected == false) {
- $this->error = 'Not connected to POP3 server';
-
- if ($this->do_debug >= 1) {
- $this->displayErrors();
- }
+ /**
+ * Send raw data to the POP3 server.
+ * @param string $string
+ * @return integer
+ * @access private
+ */
+ private function sendString($string)
+ {
+ $bytes_sent = fwrite($this->pop_conn, $string, strlen($string));
+ return $bytes_sent;
}
- if (empty($username)) {
- $username = $this->username;
- }
-
- if (empty($password)) {
- $password = $this->password;
- }
-
- $pop_username = "USER $username" . $this->CRLF;
- $pop_password = "PASS $password" . $this->CRLF;
-
- // Send the Username
- $this->sendString($pop_username);
- $pop3_response = $this->getResponse();
-
- if ($this->checkResponse($pop3_response)) {
- // Send the Password
- $this->sendString($pop_password);
- $pop3_response = $this->getResponse();
-
- if ($this->checkResponse($pop3_response)) {
- return true;
- }
+ /**
+ * Checks the POP3 server response.
+ * Looks for for +OK or -ERR.
+ * @param string $string
+ * @return boolean
+ * @access private
+ */
+ private function checkResponse($string)
+ {
+ if (substr($string, 0, 3) !== '+OK') {
+ $this->error = array(
+ 'error' => "Server reported an error: $string",
+ 'errno' => 0,
+ 'errstr' => ''
+ );
+ if ($this->do_debug >= 1) {
+ $this->displayErrors();
+ }
+ return false;
+ } else {
+ return true;
+ }
}
- return false;
- }
- /**
- * Disconnect from the POP3 server
- * @access public
- */
- public function Disconnect () {
- $this->sendString('QUIT');
-
- fclose($this->pop_conn);
- }
-
- /////////////////////////////////////////////////
- // Private Methods
- /////////////////////////////////////////////////
-
- /**
- * Get the socket response back.
- * $size is the maximum number of bytes to retrieve
- * @access private
- * @param integer $size
- * @return string
- */
- private function getResponse ($size = 128) {
- $pop3_response = fgets($this->pop_conn, $size);
-
- return $pop3_response;
- }
-
- /**
- * Send a string down the open socket connection to the POP3 server
- * @access private
- * @param string $string
- * @return integer
- */
- private function sendString ($string) {
- $bytes_sent = fwrite($this->pop_conn, $string, strlen($string));
-
- return $bytes_sent;
- }
-
- /**
- * Checks the POP3 server response for +OK or -ERR
- * @access private
- * @param string $string
- * @return boolean
- */
- private function checkResponse ($string) {
- if (substr($string, 0, 3) !== '+OK') {
- $this->error = array(
- 'error' => "Server reported an error: $string",
- 'errno' => 0,
- 'errstr' => ''
- );
-
- if ($this->do_debug >= 1) {
- $this->displayErrors();
- }
-
- return false;
- } else {
- return true;
+ /**
+ * Display errors if debug is enabled.
+ * @access private
+ */
+ private function displayErrors()
+ {
+ echo '<pre>';
+ foreach ($this->error as $single_error) {
+ print_r($single_error);
+ }
+ echo '</pre>';
}
- }
-
- /**
- * If debug is enabled, display the error message array
- * @access private
- */
- private function displayErrors () {
- echo '<pre>';
-
- foreach ($this->error as $single_error) {
- print_r($single_error);
+ /**
+ * POP3 connection error handler.
+ * @param integer $errno
+ * @param string $errstr
+ * @param string $errfile
+ * @param integer $errline
+ * @access private
+ */
+ private function catchWarning($errno, $errstr, $errfile, $errline)
+ {
+ $this->error[] = array(
+ 'error' => "Connecting to the POP3 server raised a PHP warning: ",
+ 'errno' => $errno,
+ 'errstr' => $errstr,
+ 'errfile' => $errfile,
+ 'errline' => $errline
+ );
}
-
- echo '</pre>';
- }
-
- /**
- * Takes over from PHP for the socket warning handler
- * @access private
- * @param integer $errno
- * @param string $errstr
- * @param string $errfile
- * @param integer $errline
- */
- private function catchWarning ($errno, $errstr, $errfile, $errline) {
- $this->error[] = array(
- 'error' => "Connecting to the POP3 server raised a PHP warning: ",
- 'errno' => $errno,
- 'errstr' => $errstr
- );
- }
-
- // End of class
}
1,833 class.smtp.php
View
@@ -1,1092 +1,943 @@
<?php
-/*~ class.smtp.php
-.---------------------------------------------------------------------------.
-| Software: PHPMailer - PHP email class |
-| Version: 5.2.6 |
-| Site: https://github.com/PHPMailer/PHPMailer/ |
-| ------------------------------------------------------------------------- |
-| Admins: Marcus Bointon |
-| Admins: Jim Jagielski |
-| Authors: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net |
-| : Marcus Bointon (coolbru) phpmailer@synchromedia.co.uk |
-| : Jim Jagielski (jimjag) jimjag@gmail.com |
-| Founder: Brent R. Matzelle (original founder) |
-| Copyright (c) 2010-2012, Jim Jagielski. All Rights Reserved. |
-| Copyright (c) 2004-2009, Andy Prevost. All Rights Reserved. |
-| Copyright (c) 2001-2003, Brent R. Matzelle |
-| ------------------------------------------------------------------------- |
-| License: Distributed under the Lesser General Public License (LGPL) |
-| http://www.gnu.org/copyleft/lesser.html |
-| This program is distributed in the hope that it will be useful - WITHOUT |
-| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
-| FITNESS FOR A PARTICULAR PURPOSE. |
-'---------------------------------------------------------------------------'
-*/
-
/**
- * PHPMailer - PHP SMTP email transport class
- * NOTE: Designed for use with PHP version 5 and up
- * @package PHPMailer
- * @author Andy Prevost
- * @author Marcus Bointon
+ * PHPMailer RFC821 SMTP email transport class.
+ * Version 5.2.7
+ * PHP version 5.0.0
+ * @category PHP
+ * @package PHPMailer
+ * @link https://github.com/PHPMailer/PHPMailer/
+ * @author Marcus Bointon (coolbru) <phpmailer@synchromedia.co.uk>
+ * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
+ * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
+ * @copyright 2013 Marcus Bointon
* @copyright 2004 - 2008 Andy Prevost
- * @author Jim Jagielski
* @copyright 2010 - 2012 Jim Jagielski
- * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
+ * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
*/
/**
- * PHP RFC821 SMTP client
+ * PHPMailer RFC821 SMTP email transport class.
+ *
+ * Implements RFC 821 SMTP commands
+ * and provides some utility methods for sending mail to an SMTP server.
+ *
+ * PHP Version 5.0.0
*
- * Implements all the RFC 821 SMTP commands except TURN which will always return a not implemented error.
- * SMTP also provides some utility methods for sending mail to an SMTP server.
- * @author Chris Ryan
- * @package PHPMailer
+ * @category PHP
+ * @package PHPMailer
+ * @link https://github.com/PHPMailer/PHPMailer/blob/master/class.smtp.php
+ * @author Chris Ryan <unknown@example.com>
+ * @author Marcus Bointon <phpmailer@synchromedia.co.uk>
+ * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
*/
-class SMTP {
- /**
- * SMTP server port
- * @var int
- */
- public $SMTP_PORT = 25;
-
- /**
- * SMTP reply line ending (don't change)
- * @var string
- */
- public $CRLF = "\r\n";
-
- /**
- * Debug output level; 0 for no output
- * @var int
- */
- public $do_debug = 0;
-
- /**
- * Sets the function/method to use for debugging output.
- * Right now we only honor 'echo', 'html' or 'error_log'
- * @var string
- */
- public $Debugoutput = 'echo';
-
- /**
- * Sets VERP use on/off (default is off)
- * @var bool
- */
- public $do_verp = false;
-
- /**
- * Sets the SMTP timeout value for reads, in seconds
- * @var int
- */
- public $Timeout = 15;
-
- /**
- * Sets the SMTP timelimit value for reads, in seconds
- * @var int
- */
- public $Timelimit = 30;
-
- /**
- * Sets the SMTP PHPMailer Version number
- * @var string
- */
- public $Version = '5.2.6';
-
- /////////////////////////////////////////////////
- // PROPERTIES, PRIVATE AND PROTECTED
- /////////////////////////////////////////////////
-
- /**
- * @var resource The socket to the server
- */
- protected $smtp_conn;
- /**
- * @var string Error message, if any, for the last call
- */
- protected $error;
- /**
- * @var string The reply the server sent to us for HELO
- */
- protected $helo_rply;
-
- /**
- * Outputs debugging info via user-defined method
- * @param string $str
- */
- protected function edebug($str) {
- switch ($this->Debugoutput) {
- case 'error_log':
- error_log($str);
- break;
- case 'html':
- //Cleans up output a bit for a better looking display that's HTML-safe
- echo htmlentities(preg_replace('/[\r\n]+/', '', $str), ENT_QUOTES, 'UTF-8')."<br>\n";
- break;
- case 'echo':
- default:
- //Just echoes exactly what was received
- echo $str;
- }
- }
-
- /**
- * Initialize the class so that the data is in a known state.
- * @access public
- * @return SMTP
- */
- public function __construct() {
- $this->smtp_conn = 0;
- $this->error = null;
- $this->helo_rply = null;
-
- $this->do_debug = 0;
- }
-
- /////////////////////////////////////////////////
- // CONNECTION FUNCTIONS
- /////////////////////////////////////////////////
-
- /**
- * Connect to an SMTP server
- *
- * SMTP CODE SUCCESS: 220
- * SMTP CODE FAILURE: 421
- * @access public
- * @param string $host SMTP server IP or host name
- * @param int $port The port number to connect to, or use the default port if not specified
- * @param int $timeout How long to wait for the connection to open
- * @param array $options An array of options compatible with stream_context_create()
- * @return bool
- */
- public function Connect($host, $port = 0, $timeout = 30, $options = array()) {
- // Clear errors to avoid confusion
- $this->error = null;
-
- // Make sure we are __not__ connected
- if($this->connected()) {
- // Already connected, generate error
- $this->error = array('error' => 'Already connected to a server');
- return false;
- }
+class SMTP
+{
+ /**
+ * The PHPMailer SMTP Version number.
+ */
+ const VERSION = '5.2.7';
- if(empty($port)) {
- $port = $this->SMTP_PORT;
- }
+ /**
+ * SMTP line break constant.
+ */
+ const CRLF = "\r\n";
- // Connect to the SMTP server
- $errno = 0;
- $errstr = '';
- $socket_context = stream_context_create($options);
- //Need to suppress errors here as connection failures can be handled at a higher level
- $this->smtp_conn = @stream_socket_client($host.":".$port, $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT, $socket_context);
-
- // Verify we connected properly
- if(empty($this->smtp_conn)) {
- $this->error = array('error' => 'Failed to connect to server',
- 'errno' => $errno,
- 'errstr' => $errstr);
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ": $errstr ($errno)");
- }
- return false;
- }
+ /**
+ * The SMTP port to use if one is not specified.
+ */
+ const DEFAULT_SMTP_PORT = 25;
- // SMTP server can take longer to respond, give longer timeout for first read
- // Windows does not have support for this timeout function
- if(substr(PHP_OS, 0, 3) != 'WIN') {
- $max = ini_get('max_execution_time');
- if ($max != 0 && $timeout > $max) { // Don't bother if unlimited
- @set_time_limit($timeout);
- }
- stream_set_timeout($this->smtp_conn, $timeout, 0);
- }
+ /**
+ * The PHPMailer SMTP Version number.
+ * @type string
+ * @deprecated This should be a constant
+ * @see SMTP::VERSION
+ */
+ public $Version = '5.2.7';
- // get any announcement
- $announce = $this->get_lines();
+ /**
+ * SMTP server port number.
+ * @type int
+ * @deprecated This is only ever ued as default value, so should be a constant
+ * @see SMTP::DEFAULT_SMTP_PORT
+ */
+ public $SMTP_PORT = 25;
- if($this->do_debug >= 2) {
- $this->edebug('SMTP -> FROM SERVER:' . $announce);
- }
+ /**
+ * SMTP reply line ending
+ * @type string
+ * @deprecated Use the class constant instead
+ * @see SMTP::CRLF
+ */
+ public $CRLF = "\r\n";
- return true;
- }
-
- /**
- * Initiate a TLS communication with the server.
- *
- * SMTP CODE 220 Ready to start TLS
- * SMTP CODE 501 Syntax error (no parameters allowed)
- * SMTP CODE 454 TLS not available due to temporary reason
- * @access public
- * @return bool success
- */
- public function StartTLS() {
- $this->error = null; # to avoid confusion
-
- if(!$this->connected()) {
- $this->error = array('error' => 'Called StartTLS() without being connected');
- return false;
- }
+ /**
+ * Debug output level.
+ * Options: 0 for no output, 1 for commands, 2 for data and commands
+ * @type int
+ */
+ public $do_debug = 0;
+
+ /**
+ * The function/method to use for debugging output.
+ * Options: 'echo', 'html' or 'error_log'
+ * @type string
+ */
+ public $Debugoutput = 'echo';
- $this->client_send('STARTTLS' . $this->CRLF);
+ /**
+ * Whether to use VERP.
+ * @type bool
+ */
+ public $do_verp = false;
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
+ /**
+ * The SMTP timeout value for reads, in seconds.
+ * @type int
+ */
+ public $Timeout = 15;
- if($this->do_debug >= 2) {
- $this->edebug('SMTP -> FROM SERVER:' . $rply);
- }
+ /**
+ * The SMTP timelimit value for reads, in seconds.
+ * @type int
+ */
+ public $Timelimit = 30;
- if($code != 220) {
- $this->error =
- array('error' => 'STARTTLS not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
- }
+ /**
+ * The socket for the server connection.
+ * @type resource
+ */
+ protected $smtp_conn;
- // Begin encrypted connection
- if(!stream_socket_enable_crypto($this->smtp_conn, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
- return false;
- }
+ /**
+ * Error message, if any, for the last call.
+ * @type string
+ */
+ protected $error = '';
- return true;
- }
-
- /**
- * Performs SMTP authentication. Must be run after running the
- * Hello() method. Returns true if successfully authenticated.
- * @access public
- * @param string $username
- * @param string $password
- * @param string $authtype
- * @param string $realm
- * @param string $workstation
- * @return bool
- */
- public function Authenticate($username, $password, $authtype='LOGIN', $realm='', $workstation='') {
- if (empty($authtype)) {
- $authtype = 'LOGIN';
- }
+ /**
+ * The reply the server sent to us for HELO.
+ * @type string
+ */
+ protected $helo_rply = '';
- switch ($authtype) {
- case 'PLAIN':
- // Start authentication
- $this->client_send('AUTH PLAIN' . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
-
- if($code != 334) {
- $this->error =
- array('error' => 'AUTH not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
- }
- // Send encoded username and password
- $this->client_send(base64_encode("\0".$username."\0".$password) . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
-
- if($code != 235) {
- $this->error =
- array('error' => 'Authentication not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
- }
- break;
- case 'LOGIN':
- // Start authentication
- $this->client_send('AUTH LOGIN' . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
-
- if($code != 334) {
- $this->error =
- array('error' => 'AUTH not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
- }
+ /**
+ * The most recent reply received from the server.
+ * @type string
+ */
+ protected $last_reply = '';
- // Send encoded username
- $this->client_send(base64_encode($username) . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
-
- if($code != 334) {
- $this->error =
- array('error' => 'Username not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
- }
+ /**
+ * Constructor.
+ * @access public
+ */
+ public function __construct()
+ {
+ $this->smtp_conn = 0;
+ $this->error = null;
+ $this->helo_rply = null;
+
+ $this->do_debug = 0;
+ }
- // Send encoded password
- $this->client_send(base64_encode($password) . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
-
- if($code != 235) {
- $this->error =
- array('error' => 'Password not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
+ /**
+ * Output debugging info via a user-selected method.
+ * @param string $str Debug string to output
+ * @return void
+ */
+ protected function edebug($str)
+ {
+ switch ($this->Debugoutput) {
+ case 'error_log':
+ //Don't output, just log
+ error_log($str);
+ break;
+ case 'html':
+ //Cleans up output a bit for a better looking, HTML-safe output
+ echo htmlentities(
+ preg_replace('/[\r\n]+/', '', $str),
+ ENT_QUOTES,
+ 'UTF-8'
+ )
+ . "<br>\n";
+ break;
+ case 'echo':
+ default:
+ //Just echoes whatever was received
+ echo $str;
}
- break;
- case 'NTLM':
- /*
- * ntlm_sasl_client.php
- ** Bundled with Permission
- **
- ** How to telnet in windows: http://technet.microsoft.com/en-us/library/aa995718%28EXCHG.65%29.aspx
- ** PROTOCOL Documentation http://curl.haxx.se/rfc/ntlm.html#ntlmSmtpAuthentication
- */
- require_once 'extras/ntlm_sasl_client.php';
- $temp = new stdClass();
- $ntlm_client = new ntlm_sasl_client_class;
- if(! $ntlm_client->Initialize($temp)){//let's test if every function its available
- $this->error = array('error' => $temp->error);
- if($this->do_debug >= 1) {
- $this->edebug('You need to enable some modules in your php.ini file: ' . $this->error['error']);
- }
+ }
+
+ /**
+ * Connect to an SMTP server.
+ * @param string $host SMTP server IP or host name
+ * @param int $port The port number to connect to
+ * @param int $timeout How long to wait for the connection to open
+ * @param array $options An array of options for stream_context_create()
+ * @access public
+ * @return bool
+ */
+ public function connect($host, $port = null, $timeout = 30, $options = array())
+ {
+ // Clear errors to avoid confusion
+ $this->error = null;
+
+ // Make sure we are __not__ connected
+ if ($this->connected()) {
+ // Already connected, generate error
+ $this->error = array('error' => 'Already connected to a server');
return false;
}
- $msg1 = $ntlm_client->TypeMsg1($realm, $workstation);//msg1
- $this->client_send('AUTH NTLM ' . base64_encode($msg1) . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
+ if (empty($port)) {
+ $port = self::DEFAULT_SMTP_PORT;
+ }
- if($code != 334) {
- $this->error =
- array('error' => 'AUTH not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
+ // Connect to the SMTP server
+ $errno = 0;
+ $errstr = '';
+ $socket_context = stream_context_create($options);
+ //Suppress errors; connection failures are handled at a higher level
+ $this->smtp_conn = @stream_socket_client(
+ $host . ":" . $port,
+ $errno,
+ $errstr,
+ $timeout,
+ STREAM_CLIENT_CONNECT,
+ $socket_context
+ );
+
+ // Verify we connected properly
+ if (empty($this->smtp_conn)) {
+ $this->error = array(
+ 'error' => 'Failed to connect to server',
+ 'errno' => $errno,
+ 'errstr' => $errstr
+ );
+ if ($this->do_debug >= 1) {
+ $this->edebug(
+ 'SMTP -> ERROR: ' . $this->error['error']
+ . ": $errstr ($errno)"
+ );
}
return false;
}
- $challenge = substr($rply, 3);//though 0 based, there is a white space after the 3 digit number....//msg2
- $challenge = base64_decode($challenge);
- $ntlm_res = $ntlm_client->NTLMResponse(substr($challenge, 24, 8), $password);
- $msg3 = $ntlm_client->TypeMsg3($ntlm_res, $username, $realm, $workstation);//msg3
- // Send encoded username
- $this->client_send(base64_encode($msg3) . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
-
- if($code != 235) {
- $this->error =
- array('error' => 'Could not authenticate',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
+ // SMTP server can take longer to respond, give longer timeout for first read
+ // Windows does not have support for this timeout function
+ if (substr(PHP_OS, 0, 3) != 'WIN') {
+ $max = ini_get('max_execution_time');
+ if ($max != 0 && $timeout > $max) { // Don't bother if unlimited
+ @set_time_limit($timeout);
}
- return false;
- }
- break;
- case 'CRAM-MD5':
- // Start authentication
- $this->client_send('AUTH CRAM-MD5' . $this->CRLF);
-
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
-
- if($code != 334) {
- $this->error =
- array('error' => 'AUTH not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
+ stream_set_timeout($this->smtp_conn, $timeout, 0);
}
- // Get the challenge
- $challenge = base64_decode(substr($rply, 4));
+ // Get any announcement
+ $announce = $this->get_lines();
- // Build the response
- $response = $username . ' ' . $this->hmac($challenge, $password);
+ if ($this->do_debug >= 2) {
+ $this->edebug('SMTP -> FROM SERVER:' . $announce);
+ }
- // Send encoded credentials
- $this->client_send(base64_encode($response) . $this->CRLF);
+ return true;
+ }
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
+ /**
+ * Initiate a TLS (encrypted) session.
+ * @access public
+ * @return bool
+ */
+ public function startTLS()
+ {
+ if (!$this->sendCommand("STARTTLS", "STARTTLS", 220)) {
+ return false;
+ }
+ // Begin encrypted connection
+ if (!stream_socket_enable_crypto(
+ $this->smtp_conn,
+ true,
+ STREAM_CRYPTO_METHOD_TLS_CLIENT
+ )
+ ) {
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Perform SMTP authentication.
+ * Must be run after hello().
+ * @see hello()
+ * @param string $username The user name
+ * @param string $password The password
+ * @param string $authtype The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5)
+ * @param string $realm The auth realm for NTLM
+ * @param string $workstation The auth workstation for NTLM
+ * @access public
+ * @return bool True if successfully authenticated.
+ */
+ public function authenticate(
+ $username,
+ $password,
+ $authtype = 'LOGIN',
+ $realm = '',
+ $workstation = ''
+ ) {
+ if (empty($authtype)) {
+ $authtype = 'LOGIN';
+ }
- if($code != 235) {
- $this->error =
- array('error' => 'Credentials not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
+ switch ($authtype) {
+ case 'PLAIN':
+ // Start authentication
+ if (!$this->sendCommand('AUTH', 'AUTH PLAIN', 334)) {
+ return false;
+ }
+ // Send encoded username and password
+ if (!$this->sendCommand(
+ 'User & Password',
+ base64_encode("\0" . $username . "\0" . $password),
+ 235
+ )
+ ) {
+ return false;
+ }
+ break;
+ case 'LOGIN':
+ // Start authentication
+ if (!$this->sendCommand('AUTH', 'AUTH LOGIN', 334)) {
+ return false;
+ }
+ if (!$this->sendCommand("Username", base64_encode($username), 334)) {
+ return false;
+ }
+ if (!$this->sendCommand("Password", base64_encode($password), 235)) {
+ return false;
+ }
+ break;
+ case 'NTLM':
+ /*
+ * ntlm_sasl_client.php
+ * Bundled with Permission
+ *
+ * How to telnet in windows:
+ * http://technet.microsoft.com/en-us/library/aa995718%28EXCHG.65%29.aspx
+ * PROTOCOL Docs http://curl.haxx.se/rfc/ntlm.html#ntlmSmtpAuthentication
+ */
+ require_once 'extras/ntlm_sasl_client.php';
+ $temp = new stdClass();
+ $ntlm_client = new ntlm_sasl_client_class;
+ //Check that functions are available
+ if (!$ntlm_client->Initialize($temp)) {
+ $this->error = array('error' => $temp->error);
+ if ($this->do_debug >= 1) {
+ $this->edebug(
+ 'You need to enable some modules in your php.ini file: '
+ . $this->error['error']
+ );
+ }
+ return false;
+ }
+ //msg1
+ $msg1 = $ntlm_client->TypeMsg1($realm, $workstation); //msg1
+
+ if (!$this->sendCommand(
+ 'AUTH NTLM',
+ 'AUTH NTLM ' . base64_encode($msg1),
+ 334
+ )
+ ) {
+ return false;
+ }
+
+ //Though 0 based, there is a white space after the 3 digit number
+ //msg2
+ $challenge = substr($this->last_reply, 3);
+ $challenge = base64_decode($challenge);
+ $ntlm_res = $ntlm_client->NTLMResponse(
+ substr($challenge, 24, 8),
+ $password
+ );
+ //msg3
+ $msg3 = $ntlm_client->TypeMsg3(
+ $ntlm_res,
+ $username,
+ $realm,
+ $workstation
+ );
+ // send encoded username
+ return $this->sendCommand('Username', base64_encode($msg3), 235);
+ break;
+ case 'CRAM-MD5':
+ // Start authentication
+ if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) {
+ return false;
+ }
+ // Get the challenge
+ $challenge = base64_decode(substr($this->last_reply, 4));
+
+ // Build the response
+ $response = $username . ' ' . $this->hmac($challenge, $password);
+
+ // send encoded credentials
+ return $this->sendCommand('Username', base64_encode($response), 235);
+ break;
}
- break;
+ return true;
}
- return true;
- }
-
- /**
- * Works like hash_hmac('md5', $data, $key) in case that function is not available
- * @access protected
- * @param string $data
- * @param string $key
- * @return string
- */
- protected function hmac($data, $key) {
- if (function_exists('hash_hmac')) {
- return hash_hmac('md5', $data, $key);
- }
-
- // The following borrowed from http://php.net/manual/en/function.mhash.php#27225
-
- // RFC 2104 HMAC implementation for php.
- // Creates an md5 HMAC.
- // Eliminates the need to install mhash to compute a HMAC
- // Hacked by Lance Rushing
-
- $b = 64; // byte length for md5
- if (strlen($key) > $b) {
- $key = pack('H*', md5($key));
- }
- $key = str_pad($key, $b, chr(0x00));
- $ipad = str_pad('', $b, chr(0x36));
- $opad = str_pad('', $b, chr(0x5c));
- $k_ipad = $key ^ $ipad ;
- $k_opad = $key ^ $opad;
-
- return md5($k_opad . pack('H*', md5($k_ipad . $data)));
- }
-
- /**
- * Returns true if connected to a server otherwise false
- * @access public
- * @return bool
- */
- public function Connected() {
- if(!empty($this->smtp_conn)) {
- $sock_status = stream_get_meta_data($this->smtp_conn);
- if($sock_status['eof']) {
- // the socket is valid but we are not connected
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> NOTICE: EOF caught while checking if connected');
+
+ /**
+ * Calculate an MD5 HMAC hash.
+ * Works like hash_hmac('md5', $data, $key)
+ * in case that function is not available
+ * @param string $data The data to hash
+ * @param string $key The key to hash with
+ * @access protected
+ * @return string
+ */
+ protected function hmac($data, $key)
+ {
+ if (function_exists('hash_hmac')) {
+ return hash_hmac('md5', $data, $key);
}
- $this->Close();
- return false;
- }
- return true; // everything looks good
- }
- return false;
- }
-
- /**
- * Closes the socket and cleans up the state of the class.
- * It is not considered good to use this function without
- * first trying to use QUIT.
- * @access public
- * @return void
- */
- public function Close() {
- $this->error = null; // so there is no confusion
- $this->helo_rply = null;
- if(!empty($this->smtp_conn)) {
- // close the connection and cleanup
- fclose($this->smtp_conn);
- $this->smtp_conn = 0;
- }
- }
-
- /////////////////////////////////////////////////
- // SMTP COMMANDS
- /////////////////////////////////////////////////
-
- /**
- * Issues a data command and sends the msg_data to the server
- * finializing the mail transaction. $msg_data is the message
- * that is to be send with the headers. Each header needs to be
- * on a single line followed by a <CRLF> with the message headers
- * and the message body being separated by and additional <CRLF>.
- *
- * Implements rfc 821: DATA <CRLF>
- *
- * SMTP CODE INTERMEDIATE: 354
- * [data]
- * <CRLF>.<CRLF>
- * SMTP CODE SUCCESS: 250
- * SMTP CODE FAILURE: 552, 554, 451, 452
- * SMTP CODE FAILURE: 451, 554
- * SMTP CODE ERROR : 500, 501, 503, 421
- * @access public
- * @param string $msg_data
- * @return bool
- */
- public function Data($msg_data) {
- $this->error = null; // so no confusion is caused
-
- if(!$this->connected()) {
- $this->error = array(
- 'error' => 'Called Data() without being connected');
- return false;
- }
- $this->client_send('DATA' . $this->CRLF);
+ // The following borrowed from
+ // http://php.net/manual/en/function.mhash.php#27225
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
+ // RFC 2104 HMAC implementation for php.
+ // Creates an md5 HMAC.
+ // Eliminates the need to install mhash to compute a HMAC
+ // Hacked by Lance Rushing
- if($this->do_debug >= 2) {
- $this->edebug('SMTP -> FROM SERVER:' . $rply);
- }
+ $b = 64; // byte length for md5
+ if (strlen($key) > $b) {
+ $key = pack('H*', md5($key));
+ }
+ $key = str_pad($key, $b, chr(0x00));
+ $ipad = str_pad('', $b, chr(0x36));
+ $opad = str_pad('', $b, chr(0x5c));
+ $k_ipad = $key ^ $ipad;
+ $k_opad = $key ^ $opad;
- if($code != 354) {
- $this->error =
- array('error' => 'DATA command not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
+ return md5($k_opad . pack('H*', md5($k_ipad . $data)));
}
- /* the server is ready to accept data!
- * according to rfc 821 we should not send more than 1000
- * including the CRLF
- * characters on a single line so we will break the data up
- * into lines by \r and/or \n then if needed we will break
- * each of those into smaller lines to fit within the limit.
- * in addition we will be looking for lines that start with
- * a period '.' and append and additional period '.' to that
- * line. NOTE: this does not count towards limit.
+ /**
+ * Check connection state.
+ * @access public
+ * @return bool True if connected.
*/
+ public function connected()
+ {
+ if (!empty($this->smtp_conn)) {
+ $sock_status = stream_get_meta_data($this->smtp_conn);
+ if ($sock_status['eof']) {
+ // the socket is valid but we are not connected
+ if ($this->do_debug >= 1) {
+ $this->edebug(
+ 'SMTP -> NOTICE: EOF caught while checking if connected'
+ );
+ }
+ $this->close();
+ return false;
+ }
+ return true; // everything looks good
+ }
+ return false;
+ }
- // normalize the line breaks so we know the explode works
- $msg_data = str_replace("\r\n", "\n", $msg_data);
- $msg_data = str_replace("\r", "\n", $msg_data);
- $lines = explode("\n", $msg_data);
-
- /* we need to find a good way to determine is headers are
- * in the msg_data or if it is a straight msg body
- * currently I am assuming rfc 822 definitions of msg headers
- * and if the first field of the first line (':' sperated)
- * does not contain a space then it _should_ be a header
- * and we can process all lines before a blank "" line as
- * headers.
+ /**
+ * Close the socket and clean up the state of the class.
+ * Don't use this function without first trying to use QUIT.
+ * @see quit()
+ * @access public
+ * @return void
*/
-
- $field = substr($lines[0], 0, strpos($lines[0], ':'));
- $in_headers = false;
- if(!empty($field) && !strstr($field, ' ')) {
- $in_headers = true;
+ public function close()
+ {
+ $this->error = null; // so there is no confusion
+ $this->helo_rply = null;
+ if (!empty($this->smtp_conn)) {
+ // close the connection and cleanup
+ fclose($this->smtp_conn);
+ $this->smtp_conn = 0;
+ }
}
- $max_line_length = 998; // used below; set here for ease in change
-
- while(list(, $line) = @each($lines)) {
- $lines_out = null;
- if($line == '' && $in_headers) {
- $in_headers = false;
- }
- // ok we need to break this line up into several smaller lines
- while(strlen($line) > $max_line_length) {
- $pos = strrpos(substr($line, 0, $max_line_length), ' ');
-
- // Patch to fix DOS attack
- if(!$pos) {
- $pos = $max_line_length - 1;
- $lines_out[] = substr($line, 0, $pos);
- $line = substr($line, $pos);
- } else {
- $lines_out[] = substr($line, 0, $pos);
- $line = substr($line, $pos + 1);
+ /**
+ * Send an SMTP DATA command.
+ * Issues a data command and sends the msg_data to the server,
+ * finializing the mail transaction. $msg_data is the message
+ * that is to be send with the headers. Each header needs to be
+ * on a single line followed by a <CRLF> with the message headers
+ * and the message body being separated by and additional <CRLF>.
+ * Implements rfc 821: DATA <CRLF>
+ * @param string $msg_data Message data to send
+ * @access public
+ * @return bool
+ */
+ public function data($msg_data)
+ {
+ if (!$this->sendCommand('DATA', 'DATA', 354)) {
+ return false;
}
- /* if processing headers add a LWSP-char to the front of new line
- * rfc 822 on long msg headers
+ /* The server is ready to accept data!
+ * according to rfc821 we should not send more than 1000
+ * including the CRLF
+ * characters on a single line so we will break the data up
+ * into lines by \r and/or \n then if needed we will break
+ * each of those into smaller lines to fit within the limit.
+ * in addition we will be looking for lines that start with
+ * a period '.' and append and additional period '.' to that
+ * line. NOTE: this does not count towards limit.
*/
- if($in_headers) {
- $line = "\t" . $line;
- }
- }
- $lines_out[] = $line;
-
- // send the lines to the server
- while(list(, $line_out) = @each($lines_out)) {
- if(strlen($line_out) > 0)
- {
- if(substr($line_out, 0, 1) == '.') {
- $line_out = '.' . $line_out;
- }
+
+ // Normalize the line breaks before exploding
+ $msg_data = str_replace("\r\n", "\n", $msg_data);
+ $msg_data = str_replace("\r", "\n", $msg_data);
+ $lines = explode("\n", $msg_data);
+
+ /* We need to find a good way to determine if headers are
+ * in the msg_data or if it is a straight msg body
+ * currently I am assuming rfc822 definitions of msg headers
+ * and if the first field of the first line (':' separated)
+ * does not contain a space then it _should_ be a header
+ * and we can process all lines before a blank "" line as
+ * headers.
+ */
+
+ $field = substr($lines[0], 0, strpos($lines[0], ':'));
+ $in_headers = false;
+ if (!empty($field) && !strstr($field, ' ')) {
+ $in_headers = true;
}
- $this->client_send($line_out . $this->CRLF);
- }
- }
- // message data has been sent
- $this->client_send($this->CRLF . '.' . $this->CRLF);
+ //RFC 2822 section 2.1.1 limit
+ $max_line_length = 998;
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
+ foreach ($lines as $line) {
+ $lines_out = null;
+ if ($line == '' && $in_headers) {
+ $in_headers = false;
+ }
+ // ok we need to break this line up into several smaller lines
+ while (strlen($line) > $max_line_length) {
+ $pos = strrpos(substr($line, 0, $max_line_length), ' ');
+
+ // Patch to fix DOS attack
+ if (!$pos) {
+ $pos = $max_line_length - 1;
+ $lines_out[] = substr($line, 0, $pos);
+ $line = substr($line, $pos);
+ } else {
+ $lines_out[] = substr($line, 0, $pos);
+ $line = substr($line, $pos + 1);
+ }
+
+ /* If processing headers add a LWSP-char to the front of new line
+ * rfc822 on long msg headers
+ */
+ if ($in_headers) {
+ $line = "\t" . $line;
+ }
+ }
+ $lines_out[] = $line;
+
+ // send the lines to the server
+ while (list(, $line_out) = @each($lines_out)) {
+ if (strlen($line_out) > 0) {
+ if (substr($line_out, 0, 1) == '.') {
+ $line_out = '.' . $line_out;
+ }
+ }
+ $this->client_send($line_out . self::CRLF);
+ }
+ }
- if($this->do_debug >= 2) {
- $this->edebug('SMTP -> FROM SERVER:' . $rply);
+ // Message data has been sent, complete the command
+ return $this->sendCommand('DATA END', self::CRLF . '.', 250);
}
- if($code != 250) {
- $this->error =
- array('error' => 'DATA not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
- }
- return true;
- }
-
- /**
- * Sends the HELO command to the smtp server.
- * This makes sure that we and the server are in
- * the same known state.
- *
- * Implements from rfc 821: HELO <SP> <domain> <CRLF>
- *
- * SMTP CODE SUCCESS: 250
- * SMTP CODE ERROR : 500, 501, 504, 421
- * @access public
- * @param string $host
- * @return bool
- */
- public function Hello($host = '') {
- $this->error = null; // so no confusion is caused
-
- if(!$this->connected()) {
- $this->error = array(
- 'error' => 'Called Hello() without being connected');
- return false;
- }
+ /**
+ * Send an SMTP HELO or EHLO command.
+ * Used to identify the sending server to the receiving server.
+ * This makes sure that client and server are in a known state.
+ * Implements from RFC 821: HELO <SP> <domain> <CRLF>
+ * and RFC 2821 EHLO.
+ * @param string $host The host name or IP to connect to
+ * @access public
+ * @return bool
+ */
+ public function hello($host = '')
+ {
+ // Try extended hello first (RFC 2821)
+ if (!$this->sendHello('EHLO', $host)) {
+ if (!$this->sendHello('HELO', $host)) {
+ return false;
+ }
+ }
- // if hostname for HELO was not specified send default
- if(empty($host)) {
- // determine appropriate default to send to server
- $host = 'localhost';
+ return true;
}
- // Send extended hello first (RFC 2821)
- if(!$this->SendHello('EHLO', $host)) {
- if(!$this->SendHello('HELO', $host)) {
- return false;
- }
+ /**
+ * Send an SMTP HELO or EHLO command.
+ * Low-level implementation used by hello()
+ * @see hello()
+ * @param string $hello The HELO string
+ * @param string $host The hostname to say we are
+ * @access protected
+ * @return bool
+ */
+ protected function sendHello($hello, $host)
+ {
+ $noerror = $this->sendCommand($hello, $hello . ' ' . $host, 250);
+ $this->helo_rply = $this->last_reply;
+ return $noerror;
+ }
+
+ /**
+ * Send an SMTP MAIL command.
+ * Starts a mail transaction from the email address specified in
+ * $from. Returns true if successful or false otherwise. If True
+ * the mail transaction is started and then one or more recipient
+ * commands may be called followed by a data command.
+ * Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
+ * @param string $from Source address of this message
+ * @access public
+ * @return bool
+ */
+ public function mail($from)
+ {
+ $useVerp = ($this->do_verp ? ' XVERP' : '');
+ return $this->sendCommand(
+ 'MAIL FROM',
+ 'MAIL FROM:<' . $from . '>' . $useVerp,
+ 250
+ );
+ }
+
+ /**
+ * Send an SMTP QUIT command.
+ * Closes the socket if there is no error or the $close_on_error argument is true.
+ * Implements from rfc 821: QUIT <CRLF>
+ * @param bool $close_on_error Should the connection close if an error occurs?
+ * @access public
+ * @return bool
+ */
+ public function quit($close_on_error = true)
+ {
+ $noerror = $this->sendCommand('QUIT', 'QUIT', 221);
+ $e = $this->error; //Save any error
+ if ($noerror or $close_on_error) {
+ $this->close();
+ $this->error = $e; //Restore any error from the quit command
+ }
+ return $noerror;
}
- return true;
- }
-
- /**
- * Sends a HELO/EHLO command.
- * @access protected
- * @param string $hello
- * @param string $host
- * @return bool
- */
- protected function SendHello($hello, $host) {
- $this->client_send($hello . ' ' . $host . $this->CRLF);
+ /**
+ * Send an SMTP RCPT command.
+ * Sets the TO argument to $to.
+ * Returns true if the recipient was accepted false if it was rejected.
+ * Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
+ * @param string $to The address the message is being sent to
+ * @access public
+ * @return bool
+ */
+ public function recipient($to)
+ {
+ return $this->sendCommand(
+ 'RCPT TO ',
+ 'RCPT TO:<' . $to . '>',
+ array(250, 251)
+ );
+ }
+
+ /**
+ * Send an SMTP RSET command.
+ * Abort any transaction that is currently in progress.
+ * Implements rfc 821: RSET <CRLF>
+ * @access public
+ * @return bool True on success.
+ */
+ public function reset()
+ {
+ return $this->sendCommand('RSET', 'RSET', 250);
+ }
+
+ /**
+ * Send a command to an SMTP server and check its return code.
+ * @param string $command The command name - not sent to the server
+ * @param string $commandstring The actual command to send
+ * @param int|array $expect One or more expected integer success codes
+ * @access protected
+ * @return bool True on success.
+ */
+ protected function sendCommand($command, $commandstring, $expect)
+ {
+ if (!$this->connected()) {
+ $this->error = array(
+ "error" => "Called $command without being connected"
+ );
+ return false;
+ }
+ $this->client_send($commandstring . self::CRLF);
- $rply = $this->get_lines();
- $code = substr($rply, 0, 3);
+ $reply = $this->get_lines();
+ $code = substr($reply, 0, 3);
- if($this->do_debug >= 2) {
- $this->edebug('SMTP -> FROM SERVER: ' . $rply);
- }
+ if ($this->do_debug >= 2) {
+ $this->edebug('SMTP -> FROM SERVER:' . $reply);
+ }
- if($code != 250) {
- $this->error =
- array('error' => $hello . ' not accepted from server',
- 'smtp_code' => $code,
- 'smtp_msg' => substr($rply, 4));
- if($this->do_debug >= 1) {
- $this->edebug('SMTP -> ERROR: ' . $this->error['error'] . ': ' . $rply);
- }
- return false;
- }
+ if (!in_array($code, (array)$expect)) {
+ $this->last_reply = null;
+ $this->error = array(
+ "error" => "$command command failed",
+ "smtp_code" => $code,
+ "detail" => substr($reply, 4)
+ );
+ if ($this->do_debug >= 1) {
+ $this->edebug(
+ 'SMTP -> ERROR: ' . $this->error['error'] . ': ' . $reply
+ );
+ }
+ return false;
+ }
- $this->helo_rply = $rply;
-
- return true;
- }
-
- /**
- * Starts a mail transaction from the email address specified in