X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41497a896330304904ef6d5783c724ea713739f6..ceb5a929e00123b4e224977c6b5a149f6431b250:/wp-includes/class-phpmailer.php diff --git a/wp-includes/class-phpmailer.php b/wp-includes/class-phpmailer.php index df533c27..238474ed 100644 --- a/wp-includes/class-phpmailer.php +++ b/wp-includes/class-phpmailer.php @@ -2,7 +2,7 @@ /*~ class.phpmailer.php .---------------------------------------------------------------------------. | Software: PHPMailer - PHP email class | -| Version: 5.2.1 | +| Version: 5.2.4 | | Site: https://code.google.com/a/apache-extras.org/p/phpmailer/ | | ------------------------------------------------------------------------- | | Admin: Jim Jagielski (project admininistrator) | @@ -23,7 +23,7 @@ */ /** - * PHPMailer - PHP email transport class + * PHPMailer - PHP email creation and transport class * NOTE: Requires PHP version 5 or later * @package PHPMailer * @author Andy Prevost @@ -31,12 +31,15 @@ * @author Jim Jagielski * @copyright 2010 - 2012 Jim Jagielski * @copyright 2004 - 2009 Andy Prevost - * @version $Id: class.phpmailer.php 450 2010-06-23 16:46:33Z coolbru $ * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License */ if (version_compare(PHP_VERSION, '5.0.0', '<') ) exit("Sorry, this version of PHPMailer will only run on PHP version 5 or greater!\n"); +/** + * PHP email creation and transport class + * @package PHPMailer + */ class PHPMailer { ///////////////////////////////////////////////// @@ -93,6 +96,13 @@ class PHPMailer { */ public $Sender = ''; + /** + * Sets the Return-Path of the message. If empty, it will + * be set to either From or Sender. + * @var string + */ + public $ReturnPath = ''; + /** * Sets the Subject of the message. * @var string @@ -130,11 +140,11 @@ class PHPMailer { protected $MIMEHeader = ''; /** - * Stores the complete sent MIME message (Body and Headers) + * Stores the extra header list which CreateHeader() doesn't fold in * @var string * @access protected */ - protected $SentMIMEMessage = ''; + protected $mailHeader = ''; /** * Sets word wrapping on the body of the message to a given number of @@ -155,6 +165,13 @@ class PHPMailer { */ public $Sendmail = '/usr/sbin/sendmail'; + /** + * Determine if mail() uses a fully sendmail compatible MTA that + * supports sendmail's "-oi -f" options + * @var boolean + */ + public $UseSendmailOptions = true; + /** * Path to PHPMailer plugins. Useful if the SMTP class * is in a different directory than the PHP include path. @@ -183,12 +200,21 @@ class PHPMailer { */ public $MessageID = ''; + /** + * Sets the message Date to be used in the Date header. + * If empty, the current date will be added. + * @var string + */ + public $MessageDate = ''; + ///////////////////////////////////////////////// // PROPERTIES FOR SMTP ///////////////////////////////////////////////// /** - * Sets the SMTP hosts. All hosts must be separated by a + * Sets the SMTP hosts. + * + * All hosts must be separated by a * semicolon. You can also specify a different port * for each host by using this format: [hostname:port] * (e.g. "smtp1.example.com:25;smtp2.example.com"). @@ -210,8 +236,7 @@ class PHPMailer { public $Helo = ''; /** - * Sets connection prefix. - * Options are "", "ssl" or "tls" + * Sets connection prefix. Options are "", "ssl" or "tls" * @var string */ public $SMTPSecure = ''; @@ -234,6 +259,24 @@ class PHPMailer { */ public $Password = ''; + /** + * Sets SMTP auth type. Options are LOGIN | PLAIN | NTLM (default LOGIN) + * @var string + */ + public $AuthType = ''; + + /** + * Sets SMTP realm. + * @var string + */ + public $Realm = ''; + + /** + * Sets SMTP workstation. + * @var string + */ + public $Workstation = ''; + /** * Sets the SMTP server timeout in seconds. * This function will not work with the win32 version. @@ -247,6 +290,13 @@ class PHPMailer { */ public $SMTPDebug = false; + /** + * Sets the function/method to use for debugging output. + * Right now we only honor "echo" or "error_log" + * @var string + */ + public $Debugoutput = "echo"; + /** * Prevents the SMTP connection from being closed after each mail * sending. If this is set to true then to close the connection @@ -269,53 +319,69 @@ class PHPMailer { public $SingleToArray = array(); /** - * Provides the ability to change the line ending + * Provides the ability to change the generic line ending + * NOTE: The default remains '\n'. We force CRLF where we KNOW + * it must be used via self::CRLF * @var string */ public $LE = "\n"; - /** - * Used with DKIM DNS Resource Record + /** + * Used with DKIM Signing + * required parameter if DKIM is enabled + * + * domain selector example domainkey * @var string */ - public $DKIM_selector = 'phpmailer'; + public $DKIM_selector = ''; /** - * Used with DKIM DNS Resource Record - * optional, in format of email address 'you@yourdomain.com' + * Used with DKIM Signing + * required if DKIM is enabled, in format of email address 'you@yourdomain.com' typically used as the source of the email * @var string */ public $DKIM_identity = ''; /** - * Used with DKIM DNS Resource Record + * Used with DKIM Signing + * optional parameter if your private key requires a passphras * @var string */ public $DKIM_passphrase = ''; /** - * Used with DKIM DNS Resource Record - * optional, in format of email address 'you@yourdomain.com' + * Used with DKIM Singing + * required if DKIM is enabled, in format of email address 'domain.com' * @var string */ public $DKIM_domain = ''; /** - * Used with DKIM DNS Resource Record - * optional, in format of email address 'you@yourdomain.com' + * Used with DKIM Signing + * required if DKIM is enabled, path to private key file * @var string */ public $DKIM_private = ''; /** - * Callback Action function name - * the function that handles the result of the send email action. Parameters: + * Callback Action function name. + * The function that handles the result of the send email action. + * It is called out by Send() for each email sent. + * + * Value can be: + * - 'function_name' for function names + * - 'Class::Method' for static method calls + * - array($object, 'Method') for calling methods on $object + * See http://php.net/is_callable manual page for more details. + * + * Parameters: * bool $result result of the send action * string $to email address of the recipient * string $cc cc email addresses * string $bcc bcc email addresses * string $subject the subject * string $body the email body + * string $from email address of sender * @var string */ public $action_function = ''; //'callbackAction'; @@ -324,11 +390,11 @@ class PHPMailer { * Sets the PHPMailer Version number * @var string */ - public $Version = '5.2.1'; + public $Version = '5.2.4'; /** * What to use in the X-Mailer header - * @var string + * @var string NULL for default, whitespace for None, or actual string to use */ public $XMailer = ''; @@ -336,21 +402,85 @@ class PHPMailer { // PROPERTIES, PRIVATE AND PROTECTED ///////////////////////////////////////////////// - protected $smtp = NULL; + /** + * @var SMTP An instance of the SMTP sender class + * @access protected + */ + protected $smtp = null; + /** + * @var array An array of 'to' addresses + * @access protected + */ protected $to = array(); + /** + * @var array An array of 'cc' addresses + * @access protected + */ protected $cc = array(); + /** + * @var array An array of 'bcc' addresses + * @access protected + */ protected $bcc = array(); + /** + * @var array An array of reply-to name and address + * @access protected + */ protected $ReplyTo = array(); + /** + * @var array An array of all kinds of addresses: to, cc, bcc, replyto + * @access protected + */ protected $all_recipients = array(); + /** + * @var array An array of attachments + * @access protected + */ protected $attachment = array(); + /** + * @var array An array of custom headers + * @access protected + */ protected $CustomHeader = array(); + /** + * @var string The message's MIME type + * @access protected + */ protected $message_type = ''; + /** + * @var array An array of MIME boundary strings + * @access protected + */ protected $boundary = array(); + /** + * @var array An array of available languages + * @access protected + */ protected $language = array(); + /** + * @var integer The number of errors encountered + * @access protected + */ protected $error_count = 0; + /** + * @var string The filename of a DKIM certificate file + * @access protected + */ protected $sign_cert_file = ''; + /** + * @var string The filename of a DKIM key file + * @access protected + */ protected $sign_key_file = ''; + /** + * @var string The password of a DKIM key + * @access protected + */ protected $sign_key_pass = ''; + /** + * @var boolean Whether to throw exceptions for errors + * @access protected + */ protected $exceptions = false; ///////////////////////////////////////////////// @@ -360,11 +490,46 @@ class PHPMailer { const STOP_MESSAGE = 0; // message only, continue processing const STOP_CONTINUE = 1; // message?, likely ok to continue processing const STOP_CRITICAL = 2; // message, plus full stop, critical error reached - + const CRLF = "\r\n"; // SMTP RFC specified EOL + ///////////////////////////////////////////////// // METHODS, VARIABLES ///////////////////////////////////////////////// + /** + * Calls actual mail() function, but in a safe_mode aware fashion + * Also, unless sendmail_path points to sendmail (or something that + * claims to be sendmail), don't pass params (not a perfect fix, + * but it will do) + * @param string $to To + * @param string $subject Subject + * @param string $body Message Body + * @param string $header Additional Header(s) + * @param string $params Params + * @access private + * @return bool + */ + private function mail_passthru($to, $subject, $body, $header, $params) { + if ( ini_get('safe_mode') || !($this->UseSendmailOptions) ) { + $rt = @mail($to, $this->EncodeHeader($this->SecureHeader($subject)), $body, $header); + } else { + $rt = @mail($to, $this->EncodeHeader($this->SecureHeader($subject)), $body, $header, $params); + } + return $rt; + } + + /** + * Outputs debugging info via user-defined method + * @param string $str + */ + private function edebug($str) { + if ($this->Debugoutput == "error_log") { + error_log($str); + } else { + echo $str; + } + } + /** * Constructor * @param boolean $exceptions Should we throw external exceptions? @@ -476,6 +641,7 @@ class PHPMailer { * @param string $kind One of 'to', 'cc', 'bcc', 'ReplyTo' * @param string $address The email address to send to * @param string $name + * @throws phpmailerException * @return boolean true on success, false if address already used or invalid in some way * @access protected */ @@ -485,20 +651,20 @@ class PHPMailer { if ($this->exceptions) { throw new phpmailerException('Invalid recipient array: ' . $kind); } - if ($this->SMTPDebug) { - echo $this->Lang('Invalid recipient array').': '.$kind; + if ($this->SMTPDebug) { + $this->edebug($this->Lang('Invalid recipient array').': '.$kind); } return false; } $address = trim($address); $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim - if (!self::ValidateAddress($address)) { + if (!$this->ValidateAddress($address)) { $this->SetError($this->Lang('invalid_address').': '. $address); if ($this->exceptions) { throw new phpmailerException($this->Lang('invalid_address').': '.$address); } - if ($this->SMTPDebug) { - echo $this->Lang('invalid_address').': '.$address; + if ($this->SMTPDebug) { + $this->edebug($this->Lang('invalid_address').': '.$address); } return false; } @@ -521,18 +687,20 @@ class PHPMailer { * Set the From and FromName properties * @param string $address * @param string $name + * @param int $auto Also set Reply-To and Sender + * @throws phpmailerException * @return boolean */ public function SetFrom($address, $name = '', $auto = 1) { $address = trim($address); $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim - if (!self::ValidateAddress($address)) { + if (!$this->ValidateAddress($address)) { $this->SetError($this->Lang('invalid_address').': '. $address); if ($this->exceptions) { throw new phpmailerException($this->Lang('invalid_address').': '.$address); } - if ($this->SMTPDebug) { - echo $this->Lang('invalid_address').': '.$address; + if ($this->SMTPDebug) { + $this->edebug($this->Lang('invalid_address').': '.$address); } return false; } @@ -551,25 +719,31 @@ class PHPMailer { /** * Check that a string looks roughly like an email address should - * Static so it can be used without instantiation - * Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator - * Conforms approximately to RFC2822 - * @link http://www.hexillion.com/samples/#Regex Original pattern found here + * Static so it can be used without instantiation, public so people can overload + * Conforms to RFC5322: Uses *correct* regex on which FILTER_VALIDATE_EMAIL is + * based; So why not use FILTER_VALIDATE_EMAIL? Because it was broken to + * not allow a@b type valid addresses :( + * Some Versions of PHP break on the regex though, likely due to PCRE, so use + * the older validation method for those users. (http://php.net/manual/en/pcre.installation.php) + * @link http://squiloople.com/2009/12/20/email-address-validation/ + * @copyright regex Copyright Michael Rushton 2009-10 | http://squiloople.com/ | Feel free to use and redistribute this code. But please keep this copyright notice. * @param string $address The email address to check * @return boolean * @static * @access public */ public static function ValidateAddress($address) { - if (function_exists('filter_var')) { //Introduced in PHP 5.2 - if(filter_var($address, FILTER_VALIDATE_EMAIL) === FALSE) { - return false; - } else { - return true; - } + if ((defined('PCRE_VERSION')) && (version_compare(PCRE_VERSION, '8.0') >= 0)) { + return preg_match('/^(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){255,})(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){65,}@)((?>(?>(?>((?>(?>(?>\x0D\x0A)?[ ])+|(?>[ ]*\x0D\x0A)?[ ]+)?)(\((?>(?2)(?>[\x01-\x08\x0B\x0C\x0E-\'*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\)))+(?2))|(?2))?)([!#-\'*+\/-9=?^-~-]+|"(?>(?2)(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\x7F]))*(?2)")(?>(?1)\.(?1)(?4))*(?1)@(?!(?1)[a-z0-9-]{64,})(?1)(?>([a-z0-9](?>[a-z0-9-]*[a-z0-9])?)(?>(?1)\.(?!(?1)[a-z0-9-]{64,})(?1)(?5)){0,126}|\[(?:(?>IPv6:(?>([a-f0-9]{1,4})(?>:(?6)){7}|(?!(?:.*[a-f0-9][:\]]){7,})((?6)(?>:(?6)){0,5})?::(?7)?))|(?>(?>IPv6:(?>(?6)(?>:(?6)){5}:|(?!(?:.*[a-f0-9]:){5,})(?8)?::(?>((?6)(?>:(?6)){0,3}):)?))?(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD', $address); + } elseif (function_exists('filter_var')) { //Introduced in PHP 5.2 + if(filter_var($address, FILTER_VALIDATE_EMAIL) === FALSE) { + return false; + } else { + return true; + } } else { - return preg_match('/^(?:[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+\.)*[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+@(?:(?:(?:[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!\.)){0,61}[a-zA-Z0-9_-]?\.)+[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!$)){0,61}[a-zA-Z0-9_]?)|(?:\[(?:(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\.){3}(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\]))$/', $address); - } + return preg_match('/^(?:[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+\.)*[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+@(?:(?:(?:[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!\.)){0,61}[a-zA-Z0-9_-]?\.)+[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!$)){0,61}[a-zA-Z0-9_]?)|(?:\[(?:(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\.){3}(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\]))$/', $address); + } } ///////////////////////////////////////////////// @@ -580,6 +754,7 @@ class PHPMailer { * Creates message and assigns Mailer. If the message is * not sent successfully then it returns false. Use the ErrorInfo * variable to view description of the error. + * @throws phpmailerException * @return bool */ public function Send() { @@ -587,7 +762,7 @@ class PHPMailer { if(!$this->PreSend()) return false; return $this->PostSend(); } catch (phpmailerException $e) { - $this->SentMIMEMessage = ''; + $this->mailHeader = ''; $this->SetError($e->getMessage()); if ($this->exceptions) { throw $e; @@ -596,9 +771,14 @@ class PHPMailer { } } - protected function PreSend() { + /** + * Prep mail by constructing all message entities + * @throws phpmailerException + * @return bool + */ + public function PreSend() { try { - $mailHeader = ""; + $this->mailHeader = ""; if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) { throw new phpmailerException($this->Lang('provide_address'), self::STOP_CRITICAL); } @@ -619,26 +799,25 @@ class PHPMailer { $this->MIMEBody = $this->CreateBody(); // To capture the complete message when using mail(), create - // an extra header list which CreateHeader() doesn't fold in + // an extra header list which CreateHeader() doesn't fold in if ($this->Mailer == 'mail') { if (count($this->to) > 0) { - $mailHeader .= $this->AddrAppend("To", $this->to); + $this->mailHeader .= $this->AddrAppend("To", $this->to); } else { - $mailHeader .= $this->HeaderLine("To", "undisclosed-recipients:;"); + $this->mailHeader .= $this->HeaderLine("To", "undisclosed-recipients:;"); } - $mailHeader .= $this->HeaderLine('Subject', $this->EncodeHeader($this->SecureHeader(trim($this->Subject)))); + $this->mailHeader .= $this->HeaderLine('Subject', $this->EncodeHeader($this->SecureHeader(trim($this->Subject)))); // if(count($this->cc) > 0) { - // $mailHeader .= $this->AddrAppend("Cc", $this->cc); + // $this->mailHeader .= $this->AddrAppend("Cc", $this->cc); // } } // digitally sign with DKIM if enabled - if ($this->DKIM_domain && $this->DKIM_private) { + if (!empty($this->DKIM_domain) && !empty($this->DKIM_private) && !empty($this->DKIM_selector) && !empty($this->DKIM_domain) && file_exists($this->DKIM_private)) { $header_dkim = $this->DKIM_Add($this->MIMEHeader, $this->EncodeHeader($this->SecureHeader($this->Subject)), $this->MIMEBody); $this->MIMEHeader = str_replace("\r\n", "\n", $header_dkim) . $this->MIMEHeader; } - $this->SentMIMEMessage = sprintf("%s%s\r\n\r\n%s",$this->MIMEHeader,$mailHeader,$this->MIMEBody); return true; } catch (phpmailerException $e) { @@ -650,7 +829,13 @@ class PHPMailer { } } - protected function PostSend() { + /** + * Actual Email transport function + * Send the email via the selected mechanism + * @throws phpmailerException + * @return bool + */ + public function PostSend() { try { // Choose the mailer and send through it switch($this->Mailer) { @@ -663,34 +848,34 @@ class PHPMailer { default: return $this->MailSend($this->MIMEHeader, $this->MIMEBody); } - } catch (phpmailerException $e) { $this->SetError($e->getMessage()); if ($this->exceptions) { throw $e; } - if ($this->SMTPDebug) { - echo $e->getMessage()."\n"; + if ($this->SMTPDebug) { + $this->edebug($e->getMessage()."\n"); } - return false; } + return false; } /** * Sends mail using the $Sendmail program. * @param string $header The message headers * @param string $body The message body + * @throws phpmailerException * @access protected * @return bool */ protected function SendmailSend($header, $body) { if ($this->Sender != '') { - $sendmail = sprintf("%s -oi -f %s -t", escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender)); + $sendmail = sprintf("%s -oi -f%s -t", escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender)); } else { $sendmail = sprintf("%s -oi -t", escapeshellcmd($this->Sendmail)); } if ($this->SingleTo === true) { - foreach ($this->SingleToArray as $key => $val) { + foreach ($this->SingleToArray as $val) { if(!@$mail = popen($sendmail, 'w')) { throw new phpmailerException($this->Lang('execute') . $this->Sendmail, self::STOP_CRITICAL); } @@ -726,6 +911,7 @@ class PHPMailer { * Sends mail using the PHP mail() function. * @param string $header The message headers * @param string $body The message body + * @throws phpmailerException * @access protected * @return bool */ @@ -737,40 +923,27 @@ class PHPMailer { $to = implode(', ', $toArr); if (empty($this->Sender)) { - $params = "-oi "; + $params = " "; } else { - $params = sprintf("-oi -f %s", $this->Sender); + $params = sprintf("-f%s", $this->Sender); } if ($this->Sender != '' and !ini_get('safe_mode')) { $old_from = ini_get('sendmail_from'); ini_set('sendmail_from', $this->Sender); - if ($this->SingleTo === true && count($toArr) > 1) { - foreach ($toArr as $key => $val) { - $rt = @mail($val, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params); - // implement call back function if it exists - $isSent = ($rt == 1) ? 1 : 0; - $this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body); - } - } else { - $rt = @mail($to, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header, $params); + } + $rt = false; + if ($this->SingleTo === true && count($toArr) > 1) { + foreach ($toArr as $val) { + $rt = $this->mail_passthru($val, $this->Subject, $body, $header, $params); // implement call back function if it exists $isSent = ($rt == 1) ? 1 : 0; - $this->doCallback($isSent, $to, $this->cc, $this->bcc, $this->Subject, $body); + $this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body); } } else { - if ($this->SingleTo === true && count($toArr) > 1) { - foreach ($toArr as $key => $val) { - $rt = @mail($val, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header); - // implement call back function if it exists - $isSent = ($rt == 1) ? 1 : 0; - $this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body); - } - } else { - $rt = @mail($to, $this->EncodeHeader($this->SecureHeader($this->Subject)), $body, $header); - // implement call back function if it exists - $isSent = ($rt == 1) ? 1 : 0; - $this->doCallback($isSent, $to, $this->cc, $this->bcc, $this->Subject, $body); - } + $rt = $this->mail_passthru($to, $this->Subject, $body, $header, $params); + // implement call back function if it exists + $isSent = ($rt == 1) ? 1 : 0; + $this->doCallback($isSent, $to, $this->cc, $this->bcc, $this->Subject, $body); } if (isset($old_from)) { ini_set('sendmail_from', $old_from); @@ -786,6 +959,7 @@ class PHPMailer { * Returns false if there is a bad MAIL FROM, RCPT, or DATA input. * @param string $header The message headers * @param string $body The message body + * @throws phpmailerException * @uses SMTP * @access protected * @return bool @@ -799,7 +973,8 @@ class PHPMailer { } $smtp_from = ($this->Sender == '') ? $this->From : $this->Sender; if(!$this->smtp->Mail($smtp_from)) { - throw new phpmailerException($this->Lang('from_failed') . $smtp_from, self::STOP_CRITICAL); + $this->SetError($this->Lang('from_failed') . $smtp_from . " : " . implode(",",$this->smtp->getError())) ; + throw new phpmailerException($this->ErrorInfo, self::STOP_CRITICAL); } // Attempt to send attach all recipients @@ -850,6 +1025,9 @@ class PHPMailer { } if($this->SMTPKeepAlive == true) { $this->smtp->Reset(); + } else { + $this->smtp->Quit(); + $this->smtp->Close(); } return true; } @@ -859,13 +1037,15 @@ class PHPMailer { * Returns false if the operation failed. * @uses SMTP * @access public + * @throws phpmailerException * @return bool */ public function SmtpConnect() { if(is_null($this->smtp)) { - $this->smtp = new SMTP(); + $this->smtp = new SMTP; } + $this->smtp->Timeout = $this->Timeout; $this->smtp->do_debug = $this->SMTPDebug; $hosts = explode(';', $this->Host); $index = 0; @@ -893,7 +1073,7 @@ class PHPMailer { if ($tls) { if (!$this->smtp->StartTLS()) { - throw new phpmailerException($this->Lang('tls')); + throw new phpmailerException($this->Lang('connect_host')); } //We must resend HELO after tls negotiation @@ -902,19 +1082,20 @@ class PHPMailer { $connection = true; if ($this->SMTPAuth) { - if (!$this->smtp->Authenticate($this->Username, $this->Password)) { + if (!$this->smtp->Authenticate($this->Username, $this->Password, $this->AuthType, + $this->Realm, $this->Workstation)) { throw new phpmailerException($this->Lang('authenticate')); } } } $index++; - if (!$connection) { - throw new phpmailerException($this->Lang('connect_host')); - } + if (!$connection) { + throw new phpmailerException($this->Lang('connect_host')); + } } } catch (phpmailerException $e) { $this->smtp->Reset(); - if ($this->exceptions) { + if ($this->exceptions) { throw $e; } } @@ -926,7 +1107,7 @@ class PHPMailer { * @return void */ public function SmtpClose() { - if(!is_null($this->smtp)) { + if ($this->smtp !== null) { if($this->smtp->Connected()) { $this->smtp->Quit(); $this->smtp->Close(); @@ -939,28 +1120,30 @@ class PHPMailer { * Returns false if it cannot load the language file. The default language is English. * @param string $langcode ISO 639-1 2-character language code (e.g. Portuguese: "br") * @param string $lang_path Path to the language file directory + * @return bool * @access public */ function SetLanguage($langcode = 'en', $lang_path = 'language/') { //Define full set of translatable strings $PHPMAILER_LANG = array( - 'provide_address' => 'You must provide at least one recipient email address.', + 'authenticate' => 'SMTP Error: Could not authenticate.', + 'connect_host' => 'SMTP Error: Could not connect to SMTP host.', + 'data_not_accepted' => 'SMTP Error: Data not accepted.', + 'empty_message' => 'Message body empty', + 'encoding' => 'Unknown encoding: ', + 'execute' => 'Could not execute: ', + 'file_access' => 'Could not access file: ', + 'file_open' => 'File Error: Could not open file: ', + 'from_failed' => 'The following From address failed: ', + 'instantiate' => 'Could not instantiate mail function.', + 'invalid_address' => 'Invalid address', 'mailer_not_supported' => ' mailer is not supported.', - 'execute' => 'Could not execute: ', - 'instantiate' => 'Could not instantiate mail function.', - 'authenticate' => 'SMTP Error: Could not authenticate.', - 'from_failed' => 'The following From address failed: ', - 'recipients_failed' => 'SMTP Error: The following recipients failed: ', - 'data_not_accepted' => 'SMTP Error: Data not accepted.', - 'connect_host' => 'SMTP Error: Could not connect to SMTP host.', - 'file_access' => 'Could not access file: ', - 'file_open' => 'File Error: Could not open file: ', - 'encoding' => 'Unknown encoding: ', - 'signing' => 'Signing Error: ', - 'smtp_error' => 'SMTP server error: ', - 'empty_message' => 'Message body empty', - 'invalid_address' => 'Invalid address', - 'variable_set' => 'Cannot set or reset variable: ' + 'provide_address' => 'You must provide at least one recipient email address.', + 'recipients_failed' => 'SMTP Error: The following recipients failed: ', + 'signing' => 'Signing Error: ', + 'smtp_connect_failed' => 'SMTP Connect() failed.', + 'smtp_error' => 'SMTP server error: ', + 'variable_set' => 'Cannot set or reset variable: ' ); //Overwrite language-specific strings. This way we'll never have missing translations - no more "language string failed to load"! $l = true; @@ -986,6 +1169,8 @@ class PHPMailer { /** * Creates recipient headers. * @access public + * @param string $type + * @param array $addr * @return string */ public function AddrAppend($type, $addr) { @@ -1003,6 +1188,7 @@ class PHPMailer { /** * Formats an address correctly. * @access public + * @param string $addr * @return string */ public function AddrFormat($addr) { @@ -1028,13 +1214,15 @@ class PHPMailer { // If utf-8 encoding is used, we will need to make sure we don't // split multibyte characters when we wrap $is_utf8 = (strtolower($this->CharSet) == "utf-8"); + $lelen = strlen($this->LE); + $crlflen = strlen(self::CRLF); $message = $this->FixEOL($message); - if (substr($message, -1) == $this->LE) { - $message = substr($message, 0, -1); + if (substr($message, -$lelen) == $this->LE) { + $message = substr($message, 0, -$lelen); } - $line = explode($this->LE, $message); + $line = explode($this->LE, $message); // Magic. We know FixEOL uses $LE $message = ''; for ($i = 0 ;$i < count($line); $i++) { $line_part = explode(' ', $line[$i]); @@ -1042,7 +1230,7 @@ class PHPMailer { for ($e = 0; $e $length)) { - $space_left = $length - strlen($buf) - 1; + $space_left = $length - strlen($buf) - $crlflen; if ($e != 0) { if ($space_left > 20) { $len = $space_left; @@ -1056,7 +1244,7 @@ class PHPMailer { $part = substr($word, 0, $len); $word = substr($word, $len); $buf .= ' ' . $part; - $message .= $buf . sprintf("=%s", $this->LE); + $message .= $buf . sprintf("=%s", self::CRLF); } else { $message .= $buf . $soft_break; } @@ -1075,7 +1263,7 @@ class PHPMailer { $word = substr($word, $len); if (strlen($word) > 0) { - $message .= $part . sprintf("=%s", $this->LE); + $message .= $part . sprintf("=%s", self::CRLF); } else { $buf = $part; } @@ -1090,7 +1278,7 @@ class PHPMailer { } } } - $message .= $buf . $this->LE; + $message .= $buf . self::CRLF; } return $message; @@ -1175,8 +1363,15 @@ class PHPMailer { $this->boundary[2] = 'b2_' . $uniq_id; $this->boundary[3] = 'b3_' . $uniq_id; - $result .= $this->HeaderLine('Date', self::RFCDate()); - if($this->Sender == '') { + if ($this->MessageDate == '') { + $result .= $this->HeaderLine('Date', self::RFCDate()); + } else { + $result .= $this->HeaderLine('Date', $this->MessageDate); + } + + if ($this->ReturnPath) { + $result .= $this->HeaderLine('Return-Path', trim($this->ReturnPath)); + } elseif ($this->Sender == '') { $result .= $this->HeaderLine('Return-Path', trim($this->From)); } else { $result .= $this->HeaderLine('Return-Path', trim($this->Sender)); @@ -1195,7 +1390,7 @@ class PHPMailer { $result .= $this->HeaderLine('To', 'undisclosed-recipients:;'); } } - } + } $from = array(); $from[0][0] = trim($this->From); @@ -1227,10 +1422,13 @@ class PHPMailer { $result .= sprintf("Message-ID: <%s@%s>%s", $uniq_id, $this->ServerHostname(), $this->LE); } $result .= $this->HeaderLine('X-Priority', $this->Priority); - if($this->XMailer) { - $result .= $this->HeaderLine('X-Mailer', $this->XMailer); + if ($this->XMailer == '') { + $result .= $this->HeaderLine('X-Mailer', 'PHPMailer '.$this->Version.' (http://code.google.com/a/apache-extras.org/p/phpmailer/)'); } else { - $result .= $this->HeaderLine('X-Mailer', 'PHPMailer '.$this->Version.' (http://code.google.com/a/apache-extras.org/p/phpmailer/)'); + $myXmailer = trim($this->XMailer); + if ($myXmailer) { + $result .= $this->HeaderLine('X-Mailer', $myXmailer); + } } if($this->ConfirmReadingTo != '') { @@ -1257,10 +1455,6 @@ class PHPMailer { public function GetMailMIME() { $result = ''; switch($this->message_type) { - case 'plain': - $result .= $this->HeaderLine('Content-Transfer-Encoding', $this->Encoding); - $result .= $this->TextLine('Content-Type: '.$this->ContentType.'; charset="'.$this->CharSet.'"'); - break; case 'inline': $result .= $this->HeaderLine('Content-Type', 'multipart/related;'); $result .= $this->TextLine("\tboundary=\"" . $this->boundary[1] . '"'); @@ -1277,10 +1471,15 @@ class PHPMailer { $result .= $this->HeaderLine('Content-Type', 'multipart/alternative;'); $result .= $this->TextLine("\tboundary=\"" . $this->boundary[1] . '"'); break; + default: + // Catches case 'plain': and case '': + $result .= $this->HeaderLine('Content-Transfer-Encoding', $this->Encoding); + $result .= $this->TextLine('Content-Type: '.$this->ContentType.'; charset='.$this->CharSet); + break; } if($this->Mailer != 'mail') { - $result .= $this->LE.$this->LE; + $result .= $this->LE; } return $result; @@ -1292,28 +1491,26 @@ class PHPMailer { * @return string */ public function GetSentMIMEMessage() { - return $this->SentMIMEMessage; + return $this->MIMEHeader . $this->mailHeader . self::CRLF . $this->MIMEBody; } /** * Assembles the message body. Returns an empty string on failure. * @access public + * @throws phpmailerException * @return string The assembled message body */ public function CreateBody() { $body = ''; if ($this->sign_key_file) { - $body .= $this->GetMailMIME(); + $body .= $this->GetMailMIME().$this->LE; } $this->SetWordWrap(); switch($this->message_type) { - case 'plain': - $body .= $this->EncodeString($this->Body, $this->Encoding); - break; case 'inline': $body .= $this->GetBoundary($this->boundary[1], '', '', ''); $body .= $this->EncodeString($this->Body, $this->Encoding); @@ -1398,6 +1595,10 @@ class PHPMailer { $body .= $this->LE; $body .= $this->AttachAll("attachment", $this->boundary[1]); break; + default: + // catch case 'plain' and case '' + $body .= $this->EncodeString($this->Body, $this->Encoding); + break; } if ($this->IsError()) { @@ -1430,6 +1631,10 @@ class PHPMailer { /** * Returns the start of a message boundary. * @access protected + * @param string $boundary + * @param string $charSet + * @param string $contentType + * @param string $encoding * @return string */ protected function GetBoundary($boundary, $charSet, $contentType, $encoding) { @@ -1444,7 +1649,7 @@ class PHPMailer { $encoding = $this->Encoding; } $result .= $this->TextLine('--' . $boundary); - $result .= sprintf("Content-Type: %s; charset=\"%s\"", $contentType, $charSet); + $result .= sprintf("Content-Type: %s; charset=%s", $contentType, $charSet); $result .= $this->LE; $result .= $this->HeaderLine('Content-Transfer-Encoding', $encoding); $result .= $this->LE; @@ -1455,6 +1660,7 @@ class PHPMailer { /** * Returns the end of a message boundary. * @access protected + * @param string $boundary * @return string */ protected function EndBoundary($boundary) { @@ -1478,6 +1684,8 @@ class PHPMailer { /** * Returns a formatted header line. * @access public + * @param string $name + * @param string $value * @return string */ public function HeaderLine($name, $value) { @@ -1487,6 +1695,7 @@ class PHPMailer { /** * Returns a formatted mail line. * @access public + * @param string $value * @return string */ public function TextLine($value) { @@ -1505,6 +1714,7 @@ class PHPMailer { * @param string $name Overrides the attachment name. * @param string $encoding File encoding (see $Encoding). * @param string $type File extension (MIME) type. + * @throws phpmailerException * @return bool */ public function AddAttachment($path, $name = '', $encoding = 'base64', $type = 'application/octet-stream') { @@ -1533,8 +1743,8 @@ class PHPMailer { if ($this->exceptions) { throw $e; } - if ($this->SMTPDebug) { - echo $e->getMessage()."\n"; + if ($this->SMTPDebug) { + $this->edebug($e->getMessage()."\n"); } if ( $e->getCode() == self::STOP_CRITICAL ) { return false; @@ -1555,6 +1765,8 @@ class PHPMailer { * Attaches all fs, string, and binary attachments to the message. * Returns an empty string on failure. * @access protected + * @param string $disposition_type + * @param string $boundary * @return string */ protected function AttachAll($disposition_type, $boundary) { @@ -1568,6 +1780,8 @@ class PHPMailer { // CHECK IF IT IS A VALID DISPOSITION_FILTER if($attachment[6] == $disposition_type) { // Check for string attachment + $string = ''; + $path = ''; $bString = $attachment[5]; if ($bString) { $string = $attachment[0]; @@ -1624,6 +1838,7 @@ class PHPMailer { * Returns an empty string on failure. * @param string $path The full path to the file * @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' + * @throws phpmailerException * @see EncodeFile() * @access protected * @return string @@ -1633,28 +1848,28 @@ class PHPMailer { if (!is_readable($path)) { throw new phpmailerException($this->Lang('file_open') . $path, self::STOP_CONTINUE); } - if (function_exists('get_magic_quotes')) { - function get_magic_quotes() { - return false; - } - } - $magic_quotes = get_magic_quotes_runtime(); - if ($magic_quotes) { + // if (!function_exists('get_magic_quotes')) { + // function get_magic_quotes() { + // return false; + // } + // } + $magic_quotes = get_magic_quotes_runtime(); + if ($magic_quotes) { if (version_compare(PHP_VERSION, '5.3.0', '<')) { set_magic_quotes_runtime(0); } else { - ini_set('magic_quotes_runtime', 0); - } - } + ini_set('magic_quotes_runtime', 0); + } + } $file_buffer = file_get_contents($path); $file_buffer = $this->EncodeString($file_buffer, $encoding); - if ($magic_quotes) { + if ($magic_quotes) { if (version_compare(PHP_VERSION, '5.3.0', '<')) { set_magic_quotes_runtime($magic_quotes); } else { - ini_set('magic_quotes_runtime', $magic_quotes); - } - } + ini_set('magic_quotes_runtime', $magic_quotes); + } + } return $file_buffer; } catch (Exception $e) { $this->SetError($e->getMessage()); @@ -1699,6 +1914,8 @@ class PHPMailer { /** * Encode a header string to best (shortest) of Q, B, quoted or none. * @access public + * @param string $str + * @param string $position * @return string */ public function EncodeHeader($str, $position = 'text') { @@ -1737,7 +1954,7 @@ class PHPMailer { if (function_exists('mb_strlen') && $this->HasMultiBytes($str)) { // Use a custom function which correctly encodes and wraps long // multibyte strings without breaking lines within a character - $encoded = $this->Base64EncodeWrapMB($str); + $encoded = $this->Base64EncodeWrapMB($str, "\n"); } else { $encoded = base64_encode($str); $maxlen -= $maxlen % 4; @@ -1747,7 +1964,7 @@ class PHPMailer { $encoding = 'Q'; $encoded = $this->EncodeQ($str, $position); $encoded = $this->WrapText($encoded, $maxlen, true); - $encoded = str_replace('='.$this->LE, "\n", trim($encoded)); + $encoded = str_replace('='.self::CRLF, "\n", trim($encoded)); } $encoded = preg_replace('/^(.*)$/m', " =?".$this->CharSet."?$encoding?\\1?=", $encoded); @@ -1776,12 +1993,16 @@ class PHPMailer { * Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php * @access public * @param string $str multi-byte text to wrap encode + * @param string $lf string to use as linefeed/end-of-line * @return string */ - public function Base64EncodeWrapMB($str) { + public function Base64EncodeWrapMB($str, $lf=null) { $start = "=?".$this->CharSet."?B?"; $end = "?="; $encoded = ""; + if ($lf === null) { + $lf = $this->LE; + } $mb_length = mb_strlen($str, $this->CharSet); // Each line must have length <= 75, including $start and $end @@ -1802,11 +2023,11 @@ class PHPMailer { } while (strlen($chunk) > $length); - $encoded .= $chunk . $this->LE; + $encoded .= $chunk . $lf; } // Chomp the last linefeed - $encoded = substr($encoded, 0, -strlen($this->LE)); + $encoded = substr($encoded, 0, -strlen($lf)); return $encoded; } @@ -1814,8 +2035,10 @@ class PHPMailer { * Encode string to quoted-printable. * Only uses standard PHP, slow, but will always work * @access public - * @param string $string the text to encode + * @param string $input * @param integer $line_max Number of chars allowed on a line before wrapping + * @param bool $space_conv + * @internal param string $string the text to encode * @return string */ public function EncodeQPphp( $input = '', $line_max = 76, $space_conv = false) { @@ -1840,8 +2063,8 @@ class PHPMailer { $c = '=20'; } } elseif ( ($dec == 61) || ($dec < 32 ) || ($dec > 126) ) { // always encode "\t", which is *not* required - $h2 = floor($dec/16); - $h1 = floor($dec%16); + $h2 = (integer)floor($dec/16); + $h1 = (integer)floor($dec%16); $c = $escape.$hex[$h2].$hex[$h1]; } if ( (strlen($newline) + strlen($c)) >= $line_max ) { // CRLF is not counted @@ -1901,29 +2124,37 @@ class PHPMailer { * @return string */ public function EncodeQ($str, $position = 'text') { - // There should not be any EOL in the string - $encoded = preg_replace('/[\r\n]*/', '', $str); - + //There should not be any EOL in the string + $pattern=""; + $encoded = str_replace(array("\r", "\n"), '', $str); switch (strtolower($position)) { case 'phrase': - $encoded = preg_replace("/([^A-Za-z0-9!*+\/ -])/e", "'='.sprintf('%02X', ord('\\1'))", $encoded); + $pattern = '^A-Za-z0-9!*+\/ -'; break; + case 'comment': - $encoded = preg_replace("/([\(\)\"])/e", "'='.sprintf('%02X', ord('\\1'))", $encoded); + $pattern = '\(\)"'; + //note that we dont break here! + //for this reason we build the $pattern withoud including delimiters and [] + case 'text': default: - // Replace every high ascii, control =, ? and _ characters - //TODO using /e (equivalent to eval()) is probably not a good idea - $encoded = preg_replace('/([\000-\011\013\014\016-\037\075\077\137\177-\377])/e', - "'='.sprintf('%02X', ord(stripslashes('\\1')))", $encoded); + //Replace every high ascii, control =, ? and _ characters + //We put \075 (=) as first value to make sure it's the first one in being converted, preventing double encode + $pattern = '\075\000-\011\013\014\016-\037\077\137\177-\377' . $pattern; break; } + + if (preg_match_all("/[{$pattern}]/", $encoded, $matches)) { + foreach (array_unique($matches[0]) as $char) { + $encoded = str_replace($char, '=' . sprintf('%02X', ord($char)), $encoded); + } + } + + //Replace every spaces to _ (more readable than =20) + return str_replace(' ', '_', $encoded); +} - // Replace every spaces to _ (more readable than =20) - $encoded = str_replace(' ', '_', $encoded); - - return $encoded; - } /** * Adds a string or binary attachment (non-filesystem) to the list. @@ -1989,12 +2220,25 @@ class PHPMailer { return true; } - public function AddStringEmbeddedImage($string, $cid, $filename = '', $encoding = 'base64', $type = 'application/octet-stream') { + /** + * Adds an embedded stringified attachment. This can include images, sounds, and + * just about any other document. Make sure to set the $type to an + * image type. For JPEG images use "image/jpeg" and for GIF images + * use "image/gif". + * @param string $string The attachment. + * @param string $cid Content ID of the attachment. Use this to identify + * the Id for accessing the image in an HTML form. + * @param string $name Overrides the attachment name. + * @param string $encoding File encoding (see $Encoding). + * @param string $type File extension (MIME) type. + * @return bool + */ + public function AddStringEmbeddedImage($string, $cid, $name = '', $encoding = 'base64', $type = 'application/octet-stream') { // Append to $attachment array $this->attachment[] = array( 0 => $string, - 1 => $filename, - 2 => basename($filename), + 1 => $name, + 2 => $name, 3 => $encoding, 4 => $type, 5 => true, // isStringAttachment @@ -2017,6 +2261,10 @@ class PHPMailer { return false; } + /** + * Returns true if an attachment (non-inline) is present. + * @return bool + */ public function AttachmentExists() { foreach($this->attachment as $attachment) { if ($attachment[6] == 'attachment') { @@ -2026,8 +2274,12 @@ class PHPMailer { return false; } + /** + * Does this message have an alternative body set? + * @return bool + */ public function AlternativeExists() { - return strlen($this->AltBody)>0; + return !empty($this->AltBody); } ///////////////////////////////////////////////// @@ -2111,6 +2363,7 @@ class PHPMailer { /** * Adds the error message to the error container. * @access protected + * @param string $msg * @return void */ protected function SetError($msg) { @@ -2160,6 +2413,7 @@ class PHPMailer { /** * Returns a message in the appropriate language. * @access protected + * @param string $key * @return string */ protected function Lang($key) { @@ -2184,30 +2438,44 @@ class PHPMailer { } /** - * Changes every end of line from CR or LF to CRLF. + * Changes every end of line from CRLF, CR or LF to $this->LE. * @access public + * @param string $str String to FixEOL * @return string */ public function FixEOL($str) { - $str = str_replace("\r\n", "\n", $str); - $str = str_replace("\r", "\n", $str); - $str = str_replace("\n", $this->LE, $str); - return $str; + // condense down to \n + $nstr = str_replace(array("\r\n", "\r"), "\n", $str); + // Now convert LE as needed + if ($this->LE !== "\n") { + $nstr = str_replace("\n", $this->LE, $nstr); + } + return $nstr; } /** - * Adds a custom header. + * Adds a custom header. $name value can be overloaded to contain + * both header name and value (name:value) * @access public + * @param string $name custom header name + * @param string $value header value * @return void */ - public function AddCustomHeader($custom_header) { - $this->CustomHeader[] = explode(':', $custom_header, 2); + public function AddCustomHeader($name, $value=null) { + if ($value === null) { + // Value passed in as name:value + $this->CustomHeader[] = explode(':', $name, 2); + } else { + $this->CustomHeader[] = array($name, $value); + } } /** * Evaluates the message and returns modifications for inline images and backgrounds * @access public - * @return $message + * @param string $message Text to be HTML modified + * @param string $basedir baseline directory for path + * @return string $message */ public function MsgHTML($message, $basedir = '') { preg_match_all("/(src|background)=[\"'](.*)[\"']/Ui", $message, $images); @@ -2217,13 +2485,15 @@ class PHPMailer { if (!preg_match('#^[A-z]+://#', $url)) { $filename = basename($url); $directory = dirname($url); - ($directory == '.') ? $directory='': ''; - $cid = 'cid:' . md5($filename); + if ($directory == '.') { + $directory = ''; + } + $cid = 'cid:' . md5($url); $ext = pathinfo($filename, PATHINFO_EXTENSION); $mimeType = self::_mime_types($ext); if ( strlen($basedir) > 1 && substr($basedir, -1) != '/') { $basedir .= '/'; } if ( strlen($directory) > 1 && substr($directory, -1) != '/') { $directory .= '/'; } - if ( $this->AddEmbeddedImage($basedir.$directory.$filename, md5($filename), $filename, 'base64', $mimeType) ) { + if ( $this->AddEmbeddedImage($basedir.$directory.$filename, md5($url), $filename, 'base64', $mimeType) ) { $message = preg_replace("/".$images[1][$i]."=[\"']".preg_quote($url, '/')."[\"']/Ui", $images[1][$i]."=\"".$cid."\"", $message); } } @@ -2231,40 +2501,42 @@ class PHPMailer { } $this->IsHTML(true); $this->Body = $message; - if (empty($this->AltBody)) { - $textMsg = trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/s', '', $message))); - if (!empty($textMsg)) { - $this->AltBody = html_entity_decode($textMsg, ENT_QUOTES, $this->CharSet); - } - } + if (empty($this->AltBody)) { + $textMsg = trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/s', '', $message))); + if (!empty($textMsg)) { + $this->AltBody = html_entity_decode($textMsg, ENT_QUOTES, $this->CharSet); + } + } if (empty($this->AltBody)) { $this->AltBody = 'To view this email message, open it in a program that understands HTML!' . "\n\n"; } - return $message; + return $message; } /** * Gets the MIME type of the embedded or inline image - * @param string File extension + * @param string $ext File extension * @access public * @return string MIME type of ext * @static */ public static function _mime_types($ext = '') { $mimes = array( + 'xl' => 'application/excel', 'hqx' => 'application/mac-binhex40', 'cpt' => 'application/mac-compactpro', - 'doc' => 'application/msword', 'bin' => 'application/macbinary', + 'doc' => 'application/msword', + 'word' => 'application/msword', + 'class' => 'application/octet-stream', + 'dll' => 'application/octet-stream', 'dms' => 'application/octet-stream', + 'exe' => 'application/octet-stream', 'lha' => 'application/octet-stream', 'lzh' => 'application/octet-stream', - 'exe' => 'application/octet-stream', - 'class' => 'application/octet-stream', 'psd' => 'application/octet-stream', - 'so' => 'application/octet-stream', 'sea' => 'application/octet-stream', - 'dll' => 'application/octet-stream', + 'so' => 'application/octet-stream', 'oda' => 'application/oda', 'pdf' => 'application/pdf', 'ai' => 'application/postscript', @@ -2282,9 +2554,9 @@ class PHPMailer { 'dxr' => 'application/x-director', 'dvi' => 'application/x-dvi', 'gtar' => 'application/x-gtar', - 'php' => 'application/x-httpd-php', - 'php4' => 'application/x-httpd-php', 'php3' => 'application/x-httpd-php', + 'php4' => 'application/x-httpd-php', + 'php' => 'application/x-httpd-php', 'phtml' => 'application/x-httpd-php', 'phps' => 'application/x-httpd-php-source', 'js' => 'application/x-javascript', @@ -2292,53 +2564,50 @@ class PHPMailer { 'sit' => 'application/x-stuffit', 'tar' => 'application/x-tar', 'tgz' => 'application/x-tar', - 'xhtml' => 'application/xhtml+xml', 'xht' => 'application/xhtml+xml', + 'xhtml' => 'application/xhtml+xml', 'zip' => 'application/zip', 'mid' => 'audio/midi', 'midi' => 'audio/midi', - 'mpga' => 'audio/mpeg', 'mp2' => 'audio/mpeg', 'mp3' => 'audio/mpeg', + 'mpga' => 'audio/mpeg', 'aif' => 'audio/x-aiff', - 'aiff' => 'audio/x-aiff', 'aifc' => 'audio/x-aiff', + 'aiff' => 'audio/x-aiff', 'ram' => 'audio/x-pn-realaudio', 'rm' => 'audio/x-pn-realaudio', 'rpm' => 'audio/x-pn-realaudio-plugin', 'ra' => 'audio/x-realaudio', - 'rv' => 'video/vnd.rn-realvideo', 'wav' => 'audio/x-wav', 'bmp' => 'image/bmp', 'gif' => 'image/gif', 'jpeg' => 'image/jpeg', - 'jpg' => 'image/jpeg', 'jpe' => 'image/jpeg', + 'jpg' => 'image/jpeg', 'png' => 'image/png', 'tiff' => 'image/tiff', 'tif' => 'image/tiff', + 'eml' => 'message/rfc822', 'css' => 'text/css', 'html' => 'text/html', 'htm' => 'text/html', 'shtml' => 'text/html', - 'txt' => 'text/plain', - 'text' => 'text/plain', 'log' => 'text/plain', + 'text' => 'text/plain', + 'txt' => 'text/plain', 'rtx' => 'text/richtext', 'rtf' => 'text/rtf', 'xml' => 'text/xml', 'xsl' => 'text/xml', 'mpeg' => 'video/mpeg', - 'mpg' => 'video/mpeg', 'mpe' => 'video/mpeg', - 'qt' => 'video/quicktime', + 'mpg' => 'video/mpeg', 'mov' => 'video/quicktime', + 'qt' => 'video/quicktime', + 'rv' => 'video/vnd.rn-realvideo', 'avi' => 'video/x-msvideo', - 'movie' => 'video/x-sgi-movie', - 'doc' => 'application/msword', - 'word' => 'application/msword', - 'xl' => 'application/excel', - 'eml' => 'message/rfc822' + 'movie' => 'video/x-sgi-movie' ); return (!isset($mimes[strtolower($ext)])) ? 'application/octet-stream' : $mimes[strtolower($ext)]; } @@ -2353,6 +2622,8 @@ class PHPMailer { * @param string $name Parameter Name * @param mixed $value Parameter Value * NOTE: will not work with arrays, there are no arrays to set/reset + * @throws phpmailerException + * @return bool * @todo Should this not be using __set() magic function? */ public function set($name, $value = '') { @@ -2378,15 +2649,14 @@ class PHPMailer { * @return string */ public function SecureHeader($str) { - $str = str_replace("\r", '', $str); - $str = str_replace("\n", '', $str); - return trim($str); + return trim(str_replace(array("\r", "\n"), '', $str)); } /** * Set the private key file and password to sign the message. * * @access public + * @param $cert_filename * @param string $key_filename Parameter File Name * @param string $key_pass Password for private key */ @@ -2400,11 +2670,10 @@ class PHPMailer { * Set the private key file and password to sign the message. * * @access public - * @param string $key_filename Parameter File Name - * @param string $key_pass Password for private key + * @param string $txt + * @return string */ public function DKIM_QP($txt) { - $tmp = ''; $line = ''; for ($i = 0; $i < strlen($txt); $i++) { $ord = ord($txt[$i]); @@ -2422,6 +2691,7 @@ class PHPMailer { * * @access public * @param string $s Header + * @return string */ public function DKIM_Sign($s) { $privKeyStr = file_get_contents($this->DKIM_private); @@ -2433,6 +2703,7 @@ class PHPMailer { if (openssl_sign($s, $signature, $privKey)) { return base64_encode($signature); } + return ''; } /** @@ -2440,6 +2711,7 @@ class PHPMailer { * * @access public * @param string $s Header + * @return string */ public function DKIM_HeaderC($s) { $s = preg_replace("/\r\n\s+/", " ", $s); @@ -2459,6 +2731,7 @@ class PHPMailer { * * @access public * @param string $body Message Body + * @return string */ public function DKIM_BodyC($body) { if ($body == '') return "\r\n"; @@ -2479,6 +2752,7 @@ class PHPMailer { * @param string $headers_line Header lines * @param string $subject Subject * @param string $body Body + * @return string */ public function DKIM_Add($headers_line, $subject, $body) { $DKIMsignatureType = 'rsa-sha1'; // Signature & hash algorithms @@ -2487,6 +2761,8 @@ class PHPMailer { $DKIMtime = time() ; // Signature Timestamp = seconds since 00:00:00 - Jan 1, 1970 (UTC time zone) $subject_header = "Subject: $subject"; $headers = explode($this->LE, $headers_line); + $from_header = ""; + $to_header = ""; foreach($headers as $header) { if (strpos($header, 'From:') === 0) { $from_header = $header; @@ -2512,18 +2788,36 @@ class PHPMailer { "\tb="; $toSign = $this->DKIM_HeaderC($from_header . "\r\n" . $to_header . "\r\n" . $subject_header . "\r\n" . $dkimhdrs); $signed = $this->DKIM_Sign($toSign); - return "X-PHPMAILER-DKIM: phpmailer.worxware.com\r\n".$dkimhdrs.$signed."\r\n"; + return "X-PHPMAILER-DKIM: code.google.com/a/apache-extras.org/p/phpmailer/\r\n".$dkimhdrs.$signed."\r\n"; } - protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body) { - if (!empty($this->action_function) && function_exists($this->action_function)) { - $params = array($isSent, $to, $cc, $bcc, $subject, $body); + /** + * Perform callback + * @param boolean $isSent + * @param string $to + * @param string $cc + * @param string $bcc + * @param string $subject + * @param string $body + * @param string $from + */ + protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from=null) { + if (!empty($this->action_function) && is_callable($this->action_function)) { + $params = array($isSent, $to, $cc, $bcc, $subject, $body, $from); call_user_func_array($this->action_function, $params); } } } +/** + * Exception handler for PHPMailer + * @package PHPMailer + */ class phpmailerException extends Exception { + /** + * Prettify error message output + * @return string + */ public function errorMessage() { $errorMsg = '' . $this->getMessage() . "
\n"; return $errorMsg;