1
0
mirror of https://github.com/e107inc/e107.git synced 2025-08-02 20:57:26 +02:00

Bouncing email notifications added on login. DKIM support added for outgoing mail. PHP Mailer upgraded to v5.2.8

This commit is contained in:
Cameron
2015-05-25 13:37:17 -07:00
parent 0557e770eb
commit 219c68e5ed
10 changed files with 669 additions and 613 deletions

View File

@@ -447,6 +447,10 @@ class mailout_main_ui extends e_admin_ui
{ {
$this->saveMailPrefs($mes); // TODO check if functional, $emessage -> $mes $this->saveMailPrefs($mes); // TODO check if functional, $emessage -> $mes
} }
elseif(!empty($_POST['DKIM_generate']))
{
$this->generateDKIM();
}
} }
@@ -454,6 +458,78 @@ class mailout_main_ui extends e_admin_ui
} }
/**
*
* https://www.mail-tester.com/spf-dkim-check
* http://dkimvalidator.com/
* @return bool
*/
private function generateDKIM()
{
$privatekeyfile = e_SYSTEM.'dkim_private.key';
$tp = e107::getParser();
if(file_exists($privatekeyfile))
{
e107::getMessage()->addInfo("DKIM keys already exists (".$privatekeyfile.")");
$text = $this->getDKIMPublicKey();
e107::getMessage()->addInfo("Add the following to your ".e_DOMAIN." DNS Zone records:".print_a($text,true));
e107::getMessage()->addinfo("Consider testing it using this website: http://dkimvalidator.com");
return false;
}
$keyLength = 1024; // Any higher and cPanel < 11.50 will refuse it.
$pk = openssl_pkey_new(
array(
"digest_alg" => "sha1",
'private_key_bits' => $keyLength, // (2048 bits is the recommended minimum key length - gmail won't accept less than 1024 bits)
'private_key_type' => OPENSSL_KEYTYPE_RSA
)
);
openssl_pkey_export_to_file($pk, $privatekeyfile);
// $contents = file_get_contents($privatekeyfile);
$tmp = openssl_pkey_get_details($pk);
$pubKey = $tmp['key'];
file_put_contents( e_SYSTEM."dkim_public.key",$pubKey);
// e107::getMessage()->addInfo(nl2br($pubKey));
$pubString = str_replace(array('-----BEGIN PUBLIC KEY-----','-----END PUBLIC KEY-----',"\n"),"",$pubKey);
// $dnsEntry = 'phpmailer._domainkey IN TXT "v=DKIM1; k=rsa; g=*; s=email; h=sha1; t=s; p=[x];"';
$dnsEntry = 'phpmailer._domainkey IN TXT "v=DKIM1; k=rsa; p=[x];"';
$text = $tp->lanVars($dnsEntry, $pubString);
e107::getMessage()->addInfo("Add the following ".$keyLength." bit key to your ".e_DOMAIN." DNS Zone records:".print_a($text,true));
e107::getMessage()->addinfo("Consider testing it using this website: http://dkimvalidator.com");
}
private function getDKIMPublicKey()
{
$pubKey = file_get_contents( e_SYSTEM."dkim_public.key");
$pubString = str_replace(array('-----BEGIN PUBLIC KEY-----','-----END PUBLIC KEY-----',"\n"),"",$pubKey);
// $dnsEntry = 'phpmailer._domainkey IN TXT "v=DKIM1; k=rsa; g=*; s=email; h=sha1; t=s; p=[x];"';
$dnsEntry = 'phpmailer._domainkey IN TXT "v=DKIM1; k=rsa; p=[x];"';
return e107::getParser()->lanVars($dnsEntry, $pubString);
}
private function sendTestBounce() private function sendTestBounce()
{ {
$mes = e107::getMessage(); $mes = e107::getMessage();
@@ -1136,8 +1212,12 @@ class mailout_main_ui extends e_admin_ui
"</td> "</td>
</tr>\n"; </tr>\n";
*/ */
if(function_exists('openssl_pkey_new'))
{
$text .= "<tr><td>DomainKeys Identified Mail (DKIM)</td><td class='form-inline'>".$frm->button('DKIM_generate',1,'primary','Generate Public/Private keys')."
</td></tr>";
}
$text .= "</table></fieldset> $text .= "</table></fieldset>
<fieldset id='core-mail-prefs-bounce'> <fieldset id='core-mail-prefs-bounce'>
<legend>".LAN_MAILOUT_31."</legend> <legend>".LAN_MAILOUT_31."</legend>
@@ -1211,7 +1291,13 @@ class mailout_main_ui extends e_admin_ui
</td></tr> </td></tr>
<tr><td>".LAN_MAILOUT_236."</td><td>".$lastBounceText."</td></tr> <tr><td>".LAN_MAILOUT_236."</td><td>".$lastBounceText."</td></tr>";
$text .= "
</tbody></table>"; </tbody></table>";
// Parameters for mail-account based bounce processing // Parameters for mail-account based bounce processing
@@ -1254,7 +1340,12 @@ class mailout_main_ui extends e_admin_ui
$check = ($pref['mail_bounce_auto']==1) ? " checked='checked'" : ""; $check = ($pref['mail_bounce_auto']==1) ? " checked='checked'" : "";
$text .= "<tr><td>".LAN_MAILOUT_245."</td><td><input type='checkbox' name='mail_bounce_auto' value='1' {$check} /><span class='field-help'>&nbsp;".LAN_MAILOUT_246."</span></td></tr> $text .= "<tr><td>".LAN_MAILOUT_245."</td><td><input type='checkbox' name='mail_bounce_auto' value='1' {$check} /><span class='field-help'>&nbsp;".LAN_MAILOUT_246."</span></td></tr>
";
$text .= "
</tbody> </tbody>
</table></fieldset> </table></fieldset>
@@ -1577,8 +1668,8 @@ class mailout_recipients_ui extends e_admin_ui
'checkboxes' => array('title'=> '', 'type' => null, 'width' =>'5%', 'forced'=> TRUE, 'thclass'=>'center', 'class'=>'center'), 'checkboxes' => array('title'=> '', 'type' => null, 'width' =>'5%', 'forced'=> TRUE, 'thclass'=>'center', 'class'=>'center'),
'mail_target_id' => array('title' => LAN_MAILOUT_143, 'thclass' => 'left', 'forced' => TRUE), 'mail_target_id' => array('title' => LAN_MAILOUT_143, 'thclass' => 'left', 'forced' => TRUE),
'mail_recipient_id' => array('title' => LAN_MAILOUT_142, 'type'=>'number', 'data'=>'int', 'thclass' => 'left', 'readonly'=>2), 'mail_recipient_id' => array('title' => LAN_MAILOUT_142, 'type'=>'number', 'data'=>'int', 'thclass' => 'left', 'readonly'=>2),
'mail_recipient_name' => array('title' => LAN_MAILOUT_141, 'type'=>'text', 'readonly'=>2, 'forced' => TRUE), 'mail_recipient_name' => array('title' => LAN_MAILOUT_141, 'type'=>'text', 'data'=>'str', 'readonly'=>2, 'forced' => TRUE),
'mail_recipient_email' => array('title' => LAN_MAILOUT_140, 'thclass' => 'left', 'forced' => TRUE), 'mail_recipient_email' => array('title' => LAN_MAILOUT_140, 'type'=>'email', 'data'=>'str', 'thclass' => 'left', 'forced' => TRUE),
'mail_status' => array('title' => LAN_MAILOUT_138, 'type'=>'method', 'filter'=>true, 'data'=>'int', 'thclass' => 'left', 'class'=>'left', 'writeParms'=>''), 'mail_status' => array('title' => LAN_MAILOUT_138, 'type'=>'method', 'filter'=>true, 'data'=>'int', 'thclass' => 'left', 'class'=>'left', 'writeParms'=>''),
'mail_detail_id' => array('title' => LAN_MAILOUT_137, 'type'=>'dropdown', 'filter'=>true), 'mail_detail_id' => array('title' => LAN_MAILOUT_137, 'type'=>'dropdown', 'filter'=>true),
'mail_send_date' => array('title' => LAN_MAILOUT_139, 'proc' => 'sdatetime'), 'mail_send_date' => array('title' => LAN_MAILOUT_139, 'proc' => 'sdatetime'),

View File

@@ -196,6 +196,13 @@ class userlogin
return $this->invalidLogin($username, LOGIN_BANNED,$this->userData['user_id']); return $this->invalidLogin($username, LOGIN_BANNED,$this->userData['user_id']);
case USER_VALIDATED : // Valid user case USER_VALIDATED : // Valid user
break; // Nothing to do ATM break; // Nothing to do ATM
case USER_EMAIL_BOUNCED:
$bounceLAN = "Emails to [x] are bouncing back. Please [verify your email address is correct]."; //TODO LAN
$bounceMessage = $tp->lanVars($bounceLAN, $this->userData['user_email'],true );
$bounceMessage = str_replace(array('[',']'),array("<a href='".e_HTTP."usersettings.php'>","</a>"), $bounceMessage);
e107::getMessage()->addWarning($bounceMessage, 'default', true);
break;
default : // May want to pick this up default : // May want to pick this up
} }

View File

@@ -320,6 +320,21 @@ class e107Email extends PHPMailer
$this->From = $tp->toHTML(vartrue($pref['replyto_email'],$overrides['siteadminemail']),'','RAWTEXT'); $this->From = $tp->toHTML(vartrue($pref['replyto_email'],$overrides['siteadminemail']),'','RAWTEXT');
$this->WordWrap = 76; // Set a sensible default $this->WordWrap = 76; // Set a sensible default
$pref['mail_dkim'] = 1;
$privatekeyfile = e_SYSTEM.'dkim_private.key';
if($pref['mail_dkim'] && is_readable($privatekeyfile))
{
$this->DKIM_domain = e_DOMAIN; // 'example.com';
$this->DKIM_private = $privatekeyfile;
$this->DKIM_selector = 'phpmailer';
$this->DKIM_passphrase = ''; //key is not encrypted
$this->DKIM_identifier = $this->From;
}
// Now look for any overrides - slightly cumbersome way of doing it, but does give control over what can be set from here // Now look for any overrides - slightly cumbersome way of doing it, but does give control over what can be set from here
// Options are those accepted by the arraySet() method. // Options are those accepted by the arraySet() method.
if(!empty($overrides)) if(!empty($overrides))

View File

@@ -1516,11 +1516,11 @@ class e107MailManager
{ {
$errors[] = 'Bad element count: '.count($vals); $errors[] = 'Bad element count: '.count($vals);
} }
elseif ($uid || $emailAddress) // Not using admin->mailout, so just update the user table for user_id = $uid; elseif (!empty($uid) || !empty($emailAddress)) // Update the user table for user_id = $uid;
{ {
require_once(e_HANDLER.'user_handler.php'); // require_once(e_HANDLER.'user_handler.php');
$err = e107::getUserSession()->userStatusUpdate('bounce', $uid, $emailAddress);
if($err = userHandler::userStatusUpdate('bounce', $uid, $emailAddress)) if($err)
{ {
$errors[] = $err; $errors[] = $err;
} }

View File

@@ -238,7 +238,7 @@ class notify
$mailData = array( $mailData = array(
'mail_total_count' => count($recipients), 'mail_total_count' => count($recipients),
'mail_content_status' => MAIL_STATUS_TEMP, 'mail_content_status' => MAIL_STATUS_TEMP,
'mail_create_app' => 'notify', 'mail_create_app' => 'core',
'mail_title' => 'NOTIFY', 'mail_title' => 'NOTIFY',
'mail_subject' => $subject, 'mail_subject' => $subject,
'mail_sender_email' => e107::getPref('replyto_email',$siteadminemail), 'mail_sender_email' => e107::getPref('replyto_email',$siteadminemail),

View File

@@ -31,12 +31,12 @@ class PHPMailer
* The PHPMailer Version number. * The PHPMailer Version number.
* @type string * @type string
*/ */
public $Version = '5.2.9'; public $Version = '5.2.8';
/** /**
* Email priority. * Email priority.
* Options: 1 = High, 3 = Normal, 5 = low. * Options: 1 = High, 3 = Normal, 5 = low.
* @type integer * @type int
*/ */
public $Priority = 3; public $Priority = 3;
@@ -149,7 +149,7 @@ class PHPMailer
/** /**
* Word-wrap the message body to this number of chars. * Word-wrap the message body to this number of chars.
* @type integer * @type int
*/ */
public $WordWrap = 0; public $WordWrap = 0;
@@ -169,7 +169,7 @@ class PHPMailer
/** /**
* Whether mail() uses a fully sendmail-compatible MTA. * Whether mail() uses a fully sendmail-compatible MTA.
* One which supports sendmail's "-oi -f" options. * One which supports sendmail's "-oi -f" options.
* @type boolean * @type bool
*/ */
public $UseSendmailOptions = true; public $UseSendmailOptions = true;
@@ -216,8 +216,6 @@ class PHPMailer
* You can also specify a different port * You can also specify a different port
* for each host by using this format: [hostname:port] * for each host by using this format: [hostname:port]
* (e.g. "smtp1.example.com:25;smtp2.example.com"). * (e.g. "smtp1.example.com:25;smtp2.example.com").
* You can also specify encryption type, for example:
* (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465").
* Hosts will be tried in order. * Hosts will be tried in order.
* @type string * @type string
*/ */
@@ -225,8 +223,8 @@ class PHPMailer
/** /**
* The default SMTP server port. * The default SMTP server port.
* @type integer * @type int
* @TODO Why is this needed when the SMTP class takes care of it? * @Todo Why is this needed when the SMTP class takes care of it?
*/ */
public $Port = 25; public $Port = 25;
@@ -248,7 +246,7 @@ class PHPMailer
/** /**
* Whether to use SMTP authentication. * Whether to use SMTP authentication.
* Uses the Username and Password properties. * Uses the Username and Password properties.
* @type boolean * @type bool
* @see PHPMailer::$Username * @see PHPMailer::$Username
* @see PHPMailer::$Password * @see PHPMailer::$Password
*/ */
@@ -289,21 +287,19 @@ class PHPMailer
/** /**
* The SMTP server timeout in seconds. * The SMTP server timeout in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2 * @type int
* @type integer
*/ */
public $Timeout = 300; public $Timeout = 10;
/** /**
* SMTP class debug output mode. * SMTP class debug output mode.
* Debug output level.
* Options: * Options:
* * `0` No output * 0: no output
* * `1` Commands * 1: commands
* * `2` Data and commands * 2: data and commands
* * `3` As 2 plus connection status * 3: as 2 plus connection status
* * `4` Low-level data output * 4: low level data output
* @type integer * @type int
* @see SMTP::$do_debug * @see SMTP::$do_debug
*/ */
public $SMTPDebug = 0; public $SMTPDebug = 0;
@@ -311,15 +307,10 @@ class PHPMailer
/** /**
* How to handle debug output. * How to handle debug output.
* Options: * Options:
* * `echo` Output plain-text as-is, appropriate for CLI * 'echo': Output plain-text as-is, appropriate for CLI
* * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output * 'html': Output escaped, line breaks converted to <br>, appropriate for browser output
* * `error_log` Output to error log as configured in php.ini * 'error_log': Output to error log as configured in php.ini
* * @type string
* Alternatively, you can provide a callable expecting two params: a message string and the debug level:
* <code>
* $mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
* </code>
* @type string|callable
* @see SMTP::$Debugoutput * @see SMTP::$Debugoutput
*/ */
public $Debugoutput = 'echo'; public $Debugoutput = 'echo';
@@ -328,21 +319,21 @@ class PHPMailer
* Whether to keep SMTP connection open after each message. * Whether to keep SMTP connection open after each message.
* If this is set to true then to close the connection * If this is set to true then to close the connection
* requires an explicit call to smtpClose(). * requires an explicit call to smtpClose().
* @type boolean * @type bool
*/ */
public $SMTPKeepAlive = false; public $SMTPKeepAlive = false;
/** /**
* Whether to split multiple to addresses into multiple messages * Whether to split multiple to addresses into multiple messages
* or send them all in one message. * or send them all in one message.
* @type boolean * @type bool
*/ */
public $SingleTo = false; public $SingleTo = false;
/** /**
* Storage for addresses when SingleTo is enabled. * Storage for addresses when SingleTo is enabled.
* @type array * @type array
* @TODO This should really not be public * @todo This should really not be public
*/ */
public $SingleToArray = array(); public $SingleToArray = array();
@@ -351,13 +342,13 @@ class PHPMailer
* Only applicable when sending via SMTP. * Only applicable when sending via SMTP.
* @link http://en.wikipedia.org/wiki/Variable_envelope_return_path * @link http://en.wikipedia.org/wiki/Variable_envelope_return_path
* @link http://www.postfix.org/VERP_README.html Postfix VERP info * @link http://www.postfix.org/VERP_README.html Postfix VERP info
* @type boolean * @type bool
*/ */
public $do_verp = false; public $do_verp = false;
/** /**
* Whether to allow sending messages with an empty body. * Whether to allow sending messages with an empty body.
* @type boolean * @type bool
*/ */
public $AllowEmpty = false; public $AllowEmpty = false;
@@ -411,7 +402,7 @@ class PHPMailer
* Value can be any php callable: http://www.php.net/is_callable * Value can be any php callable: http://www.php.net/is_callable
* *
* Parameters: * Parameters:
* boolean $result result of the send action * bool $result result of the send action
* string $to email address of the recipient * string $to email address of the recipient
* string $cc cc email addresses * string $cc cc email addresses
* string $bcc bcc email addresses * string $bcc bcc email addresses
@@ -545,38 +536,45 @@ class PHPMailer
/** /**
* Whether to throw exceptions for errors. * Whether to throw exceptions for errors.
* @type boolean * @type bool
* @access protected * @access protected
*/ */
protected $exceptions = false; protected $exceptions = false;
/** /**
* Error severity: message only, continue processing. * Error severity: message only, continue processing
*/ */
const STOP_MESSAGE = 0; const STOP_MESSAGE = 0;
/** /**
* Error severity: message, likely ok to continue processing. * Error severity: message, likely ok to continue processing
*/ */
const STOP_CONTINUE = 1; const STOP_CONTINUE = 1;
/** /**
* Error severity: message, plus full stop, critical error reached. * Error severity: message, plus full stop, critical error reached
*/ */
const STOP_CRITICAL = 2; const STOP_CRITICAL = 2;
/** /**
* SMTP RFC standard line ending. * SMTP RFC standard line ending
*/ */
const CRLF = "\r\n"; const CRLF = "\r\n";
/** /**
* Constructor. * Constructor
* @param boolean $exceptions Should we throw external exceptions? * @param bool $exceptions Should we throw external exceptions?
*/ */
public function __construct($exceptions = false) public function __construct($exceptions = false)
{ {
$this->exceptions = ($exceptions == true); $this->exceptions = ($exceptions == true);
//Make sure our autoloader is loaded
if (version_compare(PHP_VERSION, '5.1.2', '>=')) {
$autoload = spl_autoload_functions();
if ($autoload === false or !in_array('PHPMailerAutoload', $autoload)) {
require 'PHPMailerAutoload.php';
}
}
} }
/** /**
@@ -600,7 +598,7 @@ class PHPMailer
* @param string $header Additional Header(s) * @param string $header Additional Header(s)
* @param string $params Params * @param string $params Params
* @access private * @access private
* @return boolean * @return bool
*/ */
private function mailPassthru($to, $subject, $body, $header, $params) private function mailPassthru($to, $subject, $body, $header, $params)
{ {
@@ -620,54 +618,38 @@ class PHPMailer
/** /**
* Output debugging info via user-defined method. * Output debugging info via user-defined method.
* Only generates output if SMTP debug output is enabled (@see SMTP::$do_debug). * Only if debug output is enabled.
* @see PHPMailer::$Debugoutput * @see PHPMailer::$Debugoutput
* @see PHPMailer::$SMTPDebug * @see PHPMailer::$SMTPDebug
* @param string $str * @param string $str
*/ */
protected function edebug($str) protected function edebug($str)
{ {
if ($this->SMTPDebug <= 0) { if (!$this->SMTPDebug) {
return;
}
if (is_callable($this->Debugoutput)) {
call_user_func($this->Debugoutput, $str, $this->SMTPDebug);
return; return;
} }
switch ($this->Debugoutput) { switch ($this->Debugoutput) {
case 'error_log': case 'error_log':
//Don't output, just log
error_log($str); error_log($str);
break; break;
case 'html': case 'html':
//Cleans up output a bit for a better looking, HTML-safe output //Cleans up output a bit for a better looking display that's HTML-safe
echo htmlentities( echo htmlentities(preg_replace('/[\r\n]+/', '', $str), ENT_QUOTES, $this->CharSet) . "<br>\n";
preg_replace('/[\r\n]+/', '', $str),
ENT_QUOTES,
'UTF-8'
)
. "<br>\n";
break; break;
case 'echo': case 'echo':
default: default:
//Normalize line breaks echo $str."\n";
$str = preg_replace('/(\r\n|\r|\n)/ms', "\n", $str);
echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
"\n",
"\n \t ",
trim($str)
) . "\n";
} }
} }
/** /**
* Sets message type to HTML or plain. * Sets message type to HTML or plain.
* @param boolean $isHtml True for HTML mode. * @param bool $ishtml True for HTML mode.
* @return void * @return void
*/ */
public function isHTML($isHtml = true) public function isHTML($ishtml = true)
{ {
if ($isHtml) { if ($ishtml) {
$this->ContentType = 'text/html'; $this->ContentType = 'text/html';
} else { } else {
$this->ContentType = 'text/plain'; $this->ContentType = 'text/plain';
@@ -728,7 +710,7 @@ class PHPMailer
* Add a "To" address. * Add a "To" address.
* @param string $address * @param string $address
* @param string $name * @param string $name
* @return boolean true on success, false if address already used * @return bool true on success, false if address already used
*/ */
public function addAddress($address, $name = '') public function addAddress($address, $name = '')
{ {
@@ -740,7 +722,7 @@ class PHPMailer
* @note: This function works with the SMTP mailer on win32, not with the "mail" mailer. * @note: This function works with the SMTP mailer on win32, not with the "mail" mailer.
* @param string $address * @param string $address
* @param string $name * @param string $name
* @return boolean true on success, false if address already used * @return bool true on success, false if address already used
*/ */
public function addCC($address, $name = '') public function addCC($address, $name = '')
{ {
@@ -752,7 +734,7 @@ class PHPMailer
* @note: This function works with the SMTP mailer on win32, not with the "mail" mailer. * @note: This function works with the SMTP mailer on win32, not with the "mail" mailer.
* @param string $address * @param string $address
* @param string $name * @param string $name
* @return boolean true on success, false if address already used * @return bool true on success, false if address already used
*/ */
public function addBCC($address, $name = '') public function addBCC($address, $name = '')
{ {
@@ -763,7 +745,7 @@ class PHPMailer
* Add a "Reply-to" address. * Add a "Reply-to" address.
* @param string $address * @param string $address
* @param string $name * @param string $name
* @return boolean * @return bool
*/ */
public function addReplyTo($address, $name = '') public function addReplyTo($address, $name = '')
{ {
@@ -777,7 +759,7 @@ class PHPMailer
* @param string $address The email address to send to * @param string $address The email address to send to
* @param string $name * @param string $name
* @throws phpmailerException * @throws phpmailerException
* @return boolean true on success, false if address already used or invalid in some way * @return bool true on success, false if address already used or invalid in some way
* @access protected * @access protected
*/ */
protected function addAnAddress($kind, $address, $name = '') protected function addAnAddress($kind, $address, $name = '')
@@ -819,9 +801,9 @@ class PHPMailer
* Set the From and FromName properties. * Set the From and FromName properties.
* @param string $address * @param string $address
* @param string $name * @param string $name
* @param boolean $auto Whether to also set the Sender address, defaults to true * @param bool $auto Whether to also set the Sender address, defaults to true
* @throws phpmailerException * @throws phpmailerException
* @return boolean * @return bool
*/ */
public function setFrom($address, $name = '', $auto = true) public function setFrom($address, $name = '', $auto = true)
{ {
@@ -867,25 +849,19 @@ class PHPMailer
* * `php` Use PHP built-in FILTER_VALIDATE_EMAIL; same as pcre8 but does not allow 'dotless' domains; * * `php` Use PHP built-in FILTER_VALIDATE_EMAIL; same as pcre8 but does not allow 'dotless' domains;
* * `html5` Use the pattern given by the HTML5 spec for 'email' type form input elements. * * `html5` Use the pattern given by the HTML5 spec for 'email' type form input elements.
* * `noregex` Don't use a regex: super fast, really dumb. * * `noregex` Don't use a regex: super fast, really dumb.
* @return boolean * @return bool
* @static * @static
* @access public * @access public
*/ */
public static function validateAddress($address, $patternselect = 'auto') public static function validateAddress($address, $patternselect = 'auto')
{ {
if (!$patternselect or $patternselect == 'auto') { if (!$patternselect or $patternselect == 'auto') {
//Check this constant first so it works when extension_loaded() is disabled by safe mode if (defined('PCRE_VERSION')) { //Check this constant so it works when extension_loaded() is disabled
//Constant was added in PHP 5.2.4 if (version_compare(PCRE_VERSION, '8.0') >= 0) {
if (defined('PCRE_VERSION')) {
//This pattern can get stuck in a recursive loop in PCRE <= 8.0.2
if (version_compare(PCRE_VERSION, '8.0.3') >= 0) {
$patternselect = 'pcre8'; $patternselect = 'pcre8';
} else { } else {
$patternselect = 'pcre'; $patternselect = 'pcre';
} }
} elseif (function_exists('extension_loaded') and extension_loaded('pcre')) {
//Fall back to older PCRE
$patternselect = 'pcre';
} else { } else {
//Filter_var appeared in PHP 5.2.0 and does not require the PCRE extension //Filter_var appeared in PHP 5.2.0 and does not require the PCRE extension
if (version_compare(PHP_VERSION, '5.2.0') >= 0) { if (version_compare(PHP_VERSION, '5.2.0') >= 0) {
@@ -903,7 +879,7 @@ class PHPMailer
* @copyright 2009-2010 Michael Rushton * @copyright 2009-2010 Michael Rushton
* Feel free to use and redistribute this code. But please keep this copyright notice. * Feel free to use and redistribute this code. But please keep this copyright notice.
*/ */
return (boolean)preg_match( return (bool)preg_match(
'/^(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){255,})(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){65,}@)' . '/^(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){255,})(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){65,}@)' .
'((?>(?>(?>((?>(?>(?>\x0D\x0A)?[\t ])+|(?>[\t ]*\x0D\x0A)?[\t ]+)?)(\((?>(?2)' . '((?>(?>(?>((?>(?>(?>\x0D\x0A)?[\t ])+|(?>[\t ]*\x0D\x0A)?[\t ]+)?)(\((?>(?2)' .
'(?>[\x01-\x08\x0B\x0C\x0E-\'*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\)))+(?2))|(?2))?)' . '(?>[\x01-\x08\x0B\x0C\x0E-\'*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\)))+(?2))|(?2))?)' .
@@ -915,9 +891,10 @@ class PHPMailer
'|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD', '|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD',
$address $address
); );
break;
case 'pcre': case 'pcre':
//An older regex that doesn't need a recent PCRE //An older regex that doesn't need a recent PCRE
return (boolean)preg_match( return (bool)preg_match(
'/^(?!(?>"?(?>\\\[ -~]|[^"])"?){255,})(?!(?>"?(?>\\\[ -~]|[^"])"?){65,}@)(?>' . '/^(?!(?>"?(?>\\\[ -~]|[^"])"?){255,})(?!(?>"?(?>\\\[ -~]|[^"])"?){65,}@)(?>' .
'[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*")' . '[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*")' .
'(?>\.(?>[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*"))*' . '(?>\.(?>[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*"))*' .
@@ -930,25 +907,26 @@ class PHPMailer
'|[1-9]?[0-9])(?>\.(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}))\])$/isD', '|[1-9]?[0-9])(?>\.(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}))\])$/isD',
$address $address
); );
break;
case 'html5': case 'html5':
/** /**
* This is the pattern used in the HTML5 spec for validation of 'email' type form input elements. * This is the pattern used in the HTML5 spec for validation of 'email' type form input elements.
* @link http://www.whatwg.org/specs/web-apps/current-work/#e-mail-state-(type=email) * @link http://www.whatwg.org/specs/web-apps/current-work/#e-mail-state-(type=email)
*/ */
return (boolean)preg_match( return (bool)preg_match('/^[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[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])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/sD', $address);
'[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/sD', break;
$address case 'php':
); default:
return (bool)filter_var($address, FILTER_VALIDATE_EMAIL);
break;
case 'noregex': case 'noregex':
//No PCRE! Do something _very_ approximate! //No PCRE! Do something _very_ approximate!
//Check the address is 3 chars or longer and contains an @ that's not the first or last char //Check the address is 3 chars or longer and contains an @ that's not the first or last char
return (strlen($address) >= 3 return (strlen($address) >= 3
and strpos($address, '@') >= 1 and strpos($address, '@') >= 1
and strpos($address, '@') != strlen($address) - 1); and strpos($address, '@') != strlen($address) - 1);
case 'php': break;
default:
return (boolean)filter_var($address, FILTER_VALIDATE_EMAIL);
} }
} }
@@ -956,7 +934,7 @@ class PHPMailer
* Create a message and send it. * Create a message and send it.
* Uses the sending method specified by $Mailer. * Uses the sending method specified by $Mailer.
* @throws phpmailerException * @throws phpmailerException
* @return boolean false on error - See the ErrorInfo property for details of the error. * @return bool false on error - See the ErrorInfo property for details of the error.
*/ */
public function send() public function send()
{ {
@@ -978,7 +956,7 @@ class PHPMailer
/** /**
* Prepare a message for sending. * Prepare a message for sending.
* @throws phpmailerException * @throws phpmailerException
* @return boolean * @return bool
*/ */
public function preSend() public function preSend()
{ {
@@ -1046,7 +1024,7 @@ class PHPMailer
* Actually send a message. * Actually send a message.
* Send the email via the selected mechanism * Send the email via the selected mechanism
* @throws phpmailerException * @throws phpmailerException
* @return boolean * @return bool
*/ */
public function postSend() public function postSend()
{ {
@@ -1085,7 +1063,7 @@ class PHPMailer
* @see PHPMailer::$Sendmail * @see PHPMailer::$Sendmail
* @throws phpmailerException * @throws phpmailerException
* @access protected * @access protected
* @return boolean * @return bool
*/ */
protected function sendmailSend($header, $body) protected function sendmailSend($header, $body)
{ {
@@ -1103,23 +1081,17 @@ class PHPMailer
} }
} }
if ($this->SingleTo === true) { if ($this->SingleTo === true) {
foreach ($this->SingleToArray as $toAddr) { foreach ($this->SingleToArray as $val) {
if (!@$mail = popen($sendmail, 'w')) { if (!@$mail = popen($sendmail, 'w')) {
throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
} }
fputs($mail, 'To: ' . $toAddr . "\n"); fputs($mail, 'To: ' . $val . "\n");
fputs($mail, $header); fputs($mail, $header);
fputs($mail, $body); fputs($mail, $body);
$result = pclose($mail); $result = pclose($mail);
$this->doCallback( // implement call back function if it exists
($result == 0), $isSent = ($result == 0) ? 1 : 0;
array($toAddr), $this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
$this->cc,
$this->bcc,
$this->Subject,
$body,
$this->From
);
if ($result != 0) { if ($result != 0) {
throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
} }
@@ -1131,7 +1103,9 @@ class PHPMailer
fputs($mail, $header); fputs($mail, $header);
fputs($mail, $body); fputs($mail, $body);
$result = pclose($mail); $result = pclose($mail);
$this->doCallback(($result == 0), $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From); // implement call back function if it exists
$isSent = ($result == 0) ? 1 : 0;
$this->doCallback($isSent, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
if ($result != 0) { if ($result != 0) {
throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
} }
@@ -1146,7 +1120,7 @@ class PHPMailer
* @link http://www.php.net/manual/en/book.mail.php * @link http://www.php.net/manual/en/book.mail.php
* @throws phpmailerException * @throws phpmailerException
* @access protected * @access protected
* @return boolean * @return bool
*/ */
protected function mailSend($header, $body) protected function mailSend($header, $body)
{ {
@@ -1167,13 +1141,17 @@ class PHPMailer
} }
$result = false; $result = false;
if ($this->SingleTo === true && count($toArr) > 1) { if ($this->SingleTo === true && count($toArr) > 1) {
foreach ($toArr as $toAddr) { foreach ($toArr as $val) {
$result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params); $result = $this->mailPassthru($val, $this->Subject, $body, $header, $params);
$this->doCallback($result, array($toAddr), $this->cc, $this->bcc, $this->Subject, $body, $this->From); // implement call back function if it exists
$isSent = ($result == 1) ? 1 : 0;
$this->doCallback($isSent, $val, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
} }
} else { } else {
$result = $this->mailPassthru($to, $this->Subject, $body, $header, $params); $result = $this->mailPassthru($to, $this->Subject, $body, $header, $params);
$this->doCallback($result, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From); // implement call back function if it exists
$isSent = ($result == 1) ? 1 : 0;
$this->doCallback($isSent, $to, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
} }
if (isset($old_from)) { if (isset($old_from)) {
ini_set('sendmail_from', $old_from); ini_set('sendmail_from', $old_from);
@@ -1207,7 +1185,7 @@ class PHPMailer
* @throws phpmailerException * @throws phpmailerException
* @uses SMTP * @uses SMTP
* @access protected * @access protected
* @return boolean * @return bool
*/ */
protected function smtpSend($header, $body) protected function smtpSend($header, $body)
{ {
@@ -1226,29 +1204,29 @@ class PHPMailer
foreach ($this->to as $to) { foreach ($this->to as $to) {
if (!$this->smtp->recipient($to[0])) { if (!$this->smtp->recipient($to[0])) {
$bad_rcpt[] = $to[0]; $bad_rcpt[] = $to[0];
$isSent = false; $isSent = 0;
} else { } else {
$isSent = true; $isSent = 1;
} }
$this->doCallback($isSent, array($to[0]), array(), array(), $this->Subject, $body, $this->From); $this->doCallback($isSent, $to[0], '', '', $this->Subject, $body, $this->From);
} }
foreach ($this->cc as $cc) { foreach ($this->cc as $cc) {
if (!$this->smtp->recipient($cc[0])) { if (!$this->smtp->recipient($cc[0])) {
$bad_rcpt[] = $cc[0]; $bad_rcpt[] = $cc[0];
$isSent = false; $isSent = 0;
} else { } else {
$isSent = true; $isSent = 1;
} }
$this->doCallback($isSent, array(), array($cc[0]), array(), $this->Subject, $body, $this->From); $this->doCallback($isSent, '', $cc[0], '', $this->Subject, $body, $this->From);
} }
foreach ($this->bcc as $bcc) { foreach ($this->bcc as $bcc) {
if (!$this->smtp->recipient($bcc[0])) { if (!$this->smtp->recipient($bcc[0])) {
$bad_rcpt[] = $bcc[0]; $bad_rcpt[] = $bcc[0];
$isSent = false; $isSent = 0;
} else { } else {
$isSent = true; $isSent = 1;
} }
$this->doCallback($isSent, array(), array(), array($bcc[0]), $this->Subject, $body, $this->From); $this->doCallback($isSent, '', '', $bcc[0], $this->Subject, $body, $this->From);
} }
//Only send the DATA command if we have viable recipients //Only send the DATA command if we have viable recipients
@@ -1277,7 +1255,7 @@ class PHPMailer
* @uses SMTP * @uses SMTP
* @access public * @access public
* @throws phpmailerException * @throws phpmailerException
* @return boolean * @return bool
*/ */
public function smtpConnect($options = array()) public function smtpConnect($options = array())
{ {
@@ -1388,7 +1366,7 @@ class PHPMailer
* The default language is English. * The default language is English.
* @param string $langcode ISO 639-1 2-character language code (e.g. French is "fr") * @param string $langcode ISO 639-1 2-character language code (e.g. French is "fr")
* @param string $lang_path Path to the language file directory, with trailing separator (slash) * @param string $lang_path Path to the language file directory, with trailing separator (slash)
* @return boolean * @return bool
* @access public * @access public
*/ */
public function setLanguage($langcode = 'en', $lang_path = '') public function setLanguage($langcode = 'en', $lang_path = '')
@@ -1487,7 +1465,7 @@ class PHPMailer
* Original written by philippe. * Original written by philippe.
* @param string $message The message to wrap * @param string $message The message to wrap
* @param integer $length The line length to wrap to * @param integer $length The line length to wrap to
* @param boolean $qp_mode Whether to run in Quoted-Printable mode * @param bool $qp_mode Whether to run in Quoted-Printable mode
* @access public * @access public
* @return string * @return string
*/ */
@@ -1576,8 +1554,8 @@ class PHPMailer
* Original written by Colin Brown. * Original written by Colin Brown.
* @access public * @access public
* @param string $encodedText utf-8 QP text * @param string $encodedText utf-8 QP text
* @param integer $maxLength find last character boundary prior to this length * @param int $maxLength find last character boundary prior to this length
* @return integer * @return int
*/ */
public function utf8CharBoundary($encodedText, $maxLength) public function utf8CharBoundary($encodedText, $maxLength)
{ {
@@ -1935,9 +1913,9 @@ class PHPMailer
if (!defined('PKCS7_TEXT')) { if (!defined('PKCS7_TEXT')) {
throw new phpmailerException($this->lang('signing') . ' OpenSSL extension missing.'); throw new phpmailerException($this->lang('signing') . ' OpenSSL extension missing.');
} }
// @TODO would be nice to use php://temp streams here, but need to wrap for PHP < 5.1 //TODO would be nice to use php://temp streams here, but need to wrap for PHP < 5.1
$file = tempnam(sys_get_temp_dir(), 'mail'); $file = tempnam(sys_get_temp_dir(), 'mail');
file_put_contents($file, $body); // @TODO check this worked file_put_contents($file, $body); //TODO check this worked
$signed = tempnam(sys_get_temp_dir(), 'signed'); $signed = tempnam(sys_get_temp_dir(), 'signed');
if (@openssl_pkcs7_sign( if (@openssl_pkcs7_sign(
$file, $file,
@@ -2018,17 +1996,17 @@ class PHPMailer
*/ */
protected function setMessageType() protected function setMessageType()
{ {
$type = array(); $this->message_type = array();
if ($this->alternativeExists()) { if ($this->alternativeExists()) {
$type[] = 'alt'; $this->message_type[] = 'alt';
} }
if ($this->inlineImageExists()) { if ($this->inlineImageExists()) {
$type[] = 'inline'; $this->message_type[] = 'inline';
} }
if ($this->attachmentExists()) { if ($this->attachmentExists()) {
$type[] = 'attach'; $this->message_type[] = 'attach';
} }
$this->message_type = implode('_', $type); $this->message_type = implode('_', $this->message_type);
if ($this->message_type == '') { if ($this->message_type == '') {
$this->message_type = 'plain'; $this->message_type = 'plain';
} }
@@ -2066,7 +2044,7 @@ class PHPMailer
* @param string $type File extension (MIME) type. * @param string $type File extension (MIME) type.
* @param string $disposition Disposition to use * @param string $disposition Disposition to use
* @throws phpmailerException * @throws phpmailerException
* @return boolean * @return bool
*/ */
public function addAttachment($path, $name = '', $encoding = 'base64', $type = '', $disposition = 'attachment') public function addAttachment($path, $name = '', $encoding = 'base64', $type = '', $disposition = 'attachment')
{ {
@@ -2181,19 +2159,18 @@ class PHPMailer
// Fixes a warning in IETF's msglint MIME checker // Fixes a warning in IETF's msglint MIME checker
// Allow for bypassing the Content-Disposition header totally // Allow for bypassing the Content-Disposition header totally
if (!(empty($disposition))) { if (!(empty($disposition))) {
$encoded_name = $this->encodeHeader($this->secureHeader($name)); if (preg_match('/[ \(\)<>@,;:\\"\/\[\]\?=]/', $name)) {
if (preg_match('/[ \(\)<>@,;:\\"\/\[\]\?=]/', $encoded_name)) {
$mime[] = sprintf( $mime[] = sprintf(
'Content-Disposition: %s; filename="%s"%s', 'Content-Disposition: %s; filename="%s"%s',
$disposition, $disposition,
$encoded_name, $this->encodeHeader($this->secureHeader($name)),
$this->LE . $this->LE $this->LE . $this->LE
); );
} else { } else {
$mime[] = sprintf( $mime[] = sprintf(
'Content-Disposition: %s; filename=%s%s', 'Content-Disposition: %s; filename=%s%s',
$disposition, $disposition,
$encoded_name, $this->encodeHeader($this->secureHeader($name)),
$this->LE . $this->LE $this->LE . $this->LE
); );
} }
@@ -2242,11 +2219,8 @@ class PHPMailer
$magic_quotes = get_magic_quotes_runtime(); $magic_quotes = get_magic_quotes_runtime();
if ($magic_quotes) { if ($magic_quotes) {
if (version_compare(PHP_VERSION, '5.3.0', '<')) { if (version_compare(PHP_VERSION, '5.3.0', '<')) {
set_magic_quotes_runtime(false); set_magic_quotes_runtime(0);
} else { } else {
//Doesn't exist in PHP 5.4, but we don't need to check because
//get_magic_quotes_runtime always returns false in 5.4+
//so it will never get here
ini_set('magic_quotes_runtime', 0); ini_set('magic_quotes_runtime', 0);
} }
} }
@@ -2256,7 +2230,7 @@ class PHPMailer
if (version_compare(PHP_VERSION, '5.3.0', '<')) { if (version_compare(PHP_VERSION, '5.3.0', '<')) {
set_magic_quotes_runtime($magic_quotes); set_magic_quotes_runtime($magic_quotes);
} else { } else {
ini_set('magic_quotes_runtime', ($magic_quotes?'1':'0')); ini_set('magic_quotes_runtime', $magic_quotes);
} }
} }
return $file_buffer; return $file_buffer;
@@ -2371,7 +2345,7 @@ class PHPMailer
* Check if a string contains multi-byte characters. * Check if a string contains multi-byte characters.
* @access public * @access public
* @param string $str multi-byte text to wrap encode * @param string $str multi-byte text to wrap encode
* @return boolean * @return bool
*/ */
public function hasMultiBytes($str) public function hasMultiBytes($str)
{ {
@@ -2385,11 +2359,11 @@ class PHPMailer
/** /**
* Does a string contain any 8-bit chars (in any charset)? * Does a string contain any 8-bit chars (in any charset)?
* @param string $text * @param string $text
* @return boolean * @return bool
*/ */
public function has8bitChars($text) public function has8bitChars($text)
{ {
return (boolean)preg_match('/[\x80-\xFF]/', $text); return (bool)preg_match('/[\x80-\xFF]/', $text);
} }
/** /**
@@ -2465,7 +2439,7 @@ class PHPMailer
* @access public * @access public
* @param string $string * @param string $string
* @param integer $line_max * @param integer $line_max
* @param boolean $space_conv * @param bool $space_conv
* @return string * @return string
* @deprecated Use encodeQP instead. * @deprecated Use encodeQP instead.
*/ */
@@ -2575,7 +2549,7 @@ class PHPMailer
* @param string $encoding File encoding (see $Encoding). * @param string $encoding File encoding (see $Encoding).
* @param string $type File MIME type. * @param string $type File MIME type.
* @param string $disposition Disposition to use * @param string $disposition Disposition to use
* @return boolean True on successfully adding an attachment * @return bool True on successfully adding an attachment
*/ */
public function addEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = '', $disposition = 'inline') public function addEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = '', $disposition = 'inline')
{ {
@@ -2620,7 +2594,7 @@ class PHPMailer
* @param string $encoding File encoding (see $Encoding). * @param string $encoding File encoding (see $Encoding).
* @param string $type MIME type. * @param string $type MIME type.
* @param string $disposition Disposition to use * @param string $disposition Disposition to use
* @return boolean True on successfully adding an attachment * @return bool True on successfully adding an attachment
*/ */
public function addStringEmbeddedImage( public function addStringEmbeddedImage(
$string, $string,
@@ -2652,7 +2626,7 @@ class PHPMailer
/** /**
* Check if an inline attachment is present. * Check if an inline attachment is present.
* @access public * @access public
* @return boolean * @return bool
*/ */
public function inlineImageExists() public function inlineImageExists()
{ {
@@ -2666,7 +2640,7 @@ class PHPMailer
/** /**
* Check if an attachment (non-inline) is present. * Check if an attachment (non-inline) is present.
* @return boolean * @return bool
*/ */
public function attachmentExists() public function attachmentExists()
{ {
@@ -2680,7 +2654,7 @@ class PHPMailer
/** /**
* Check if this message has an alternative body set. * Check if this message has an alternative body set.
* @return boolean * @return bool
*/ */
public function alternativeExists() public function alternativeExists()
{ {
@@ -2837,7 +2811,7 @@ class PHPMailer
/** /**
* Check if an error occurred. * Check if an error occurred.
* @access public * @access public
* @return boolean True if an error did occur. * @return bool True if an error did occur.
*/ */
public function isError() public function isError()
{ {
@@ -2889,7 +2863,7 @@ class PHPMailer
* @access public * @access public
* @param string $message HTML message string * @param string $message HTML message string
* @param string $basedir baseline directory for path * @param string $basedir baseline directory for path
* @param boolean $advanced Whether to use the advanced HTML to text converter * @param bool $advanced Whether to use the advanced HTML to text converter
* @return string $message * @return string $message
*/ */
public function msgHTML($message, $basedir = '', $advanced = false) public function msgHTML($message, $basedir = '', $advanced = false)
@@ -2897,24 +2871,8 @@ class PHPMailer
preg_match_all('/(src|background)=["\'](.*)["\']/Ui', $message, $images); preg_match_all('/(src|background)=["\'](.*)["\']/Ui', $message, $images);
if (isset($images[2])) { if (isset($images[2])) {
foreach ($images[2] as $imgindex => $url) { foreach ($images[2] as $imgindex => $url) {
// Convert data URIs into embedded images // do not change urls for absolute images (thanks to corvuscorax)
if (preg_match('#^data:(image[^;,]*)(;base64)?,#', $url, $match)) { if (!preg_match('#^[A-z]+://#', $url)) {
$data = substr($url, strpos($url, ','));
if ($match[2]) {
$data = base64_decode($data);
} else {
$data = rawurldecode($data);
}
$cid = md5($url) . '@phpmailer.0'; // RFC2392 S 2
if ($this->addStringEmbeddedImage($data, $cid, '', 'base64', $match[1])) {
$message = preg_replace(
'/' . $images[1][$imgindex] . '=["\']' . preg_quote($url, '/') . '["\']/Ui',
$images[1][$imgindex] . '="cid:' . $cid . '"',
$message
);
}
} elseif (!preg_match('#^[A-z]+://#', $url)) {
// Do not change urls for absolute images (thanks to corvuscorax)
$filename = basename($url); $filename = basename($url);
$directory = dirname($url); $directory = dirname($url);
if ($directory == '.') { if ($directory == '.') {
@@ -2932,7 +2890,7 @@ class PHPMailer
$cid, $cid,
$filename, $filename,
'base64', 'base64',
self::_mime_types((string)self::mb_pathinfo($filename, PATHINFO_EXTENSION)) self::_mime_types(self::mb_pathinfo($filename, PATHINFO_EXTENSION))
) )
) { ) {
$message = preg_replace( $message = preg_replace(
@@ -2958,7 +2916,7 @@ class PHPMailer
/** /**
* Convert an HTML string into plain text. * Convert an HTML string into plain text.
* @param string $html The HTML text to convert * @param string $html The HTML text to convert
* @param boolean $advanced Should this use the more complex html2text converter or just a simple one? * @param bool $advanced Should this use the more complex html2text converter or just a simple one?
* @return string * @return string
*/ */
public function html2text($html, $advanced = false) public function html2text($html, $advanced = false)
@@ -2986,7 +2944,6 @@ class PHPMailer
{ {
$mimes = array( $mimes = array(
'xl' => 'application/excel', 'xl' => 'application/excel',
'js' => 'application/javascript',
'hqx' => 'application/mac-binhex40', 'hqx' => 'application/mac-binhex40',
'cpt' => 'application/mac-compactpro', 'cpt' => 'application/mac-compactpro',
'bin' => 'application/macbinary', 'bin' => 'application/macbinary',
@@ -3023,6 +2980,7 @@ class PHPMailer
'php' => 'application/x-httpd-php', 'php' => 'application/x-httpd-php',
'phtml' => 'application/x-httpd-php', 'phtml' => 'application/x-httpd-php',
'phps' => 'application/x-httpd-php-source', 'phps' => 'application/x-httpd-php-source',
'js' => 'application/x-javascript',
'swf' => 'application/x-shockwave-flash', 'swf' => 'application/x-shockwave-flash',
'sit' => 'application/x-stuffit', 'sit' => 'application/x-stuffit',
'tar' => 'application/x-tar', 'tar' => 'application/x-tar',
@@ -3110,7 +3068,7 @@ class PHPMailer
{ {
$ret = array('dirname' => '', 'basename' => '', 'extension' => '', 'filename' => ''); $ret = array('dirname' => '', 'basename' => '', 'extension' => '', 'filename' => '');
$pathinfo = array(); $pathinfo = array();
if (preg_match('%^(.*?)[\\\\/]*(([^/\\\\]*?)(\.([^\.\\\\/]+?)|))[\\\\/\.]*$%im', $path, $pathinfo)) { preg_match('%^(.*?)[\\\\/]*(([^/\\\\]*?)(\.([^\.\\\\/]+?)|))[\\\\/\.]*$%im', $path, $pathinfo);
if (array_key_exists(1, $pathinfo)) { if (array_key_exists(1, $pathinfo)) {
$ret['dirname'] = $pathinfo[1]; $ret['dirname'] = $pathinfo[1];
} }
@@ -3123,20 +3081,23 @@ class PHPMailer
if (array_key_exists(3, $pathinfo)) { if (array_key_exists(3, $pathinfo)) {
$ret['filename'] = $pathinfo[3]; $ret['filename'] = $pathinfo[3];
} }
}
switch ($options) { switch ($options) {
case PATHINFO_DIRNAME: case PATHINFO_DIRNAME:
case 'dirname': case 'dirname':
return $ret['dirname']; return $ret['dirname'];
break;
case PATHINFO_BASENAME: case PATHINFO_BASENAME:
case 'basename': case 'basename':
return $ret['basename']; return $ret['basename'];
break;
case PATHINFO_EXTENSION: case PATHINFO_EXTENSION:
case 'extension': case 'extension':
return $ret['extension']; return $ret['extension'];
break;
case PATHINFO_FILENAME: case PATHINFO_FILENAME:
case 'filename': case 'filename':
return $ret['filename']; return $ret['filename'];
break;
default: default:
return $ret; return $ret;
} }
@@ -3153,8 +3114,8 @@ class PHPMailer
* @param mixed $value * @param mixed $value
* NOTE: will not work with arrays, there are no arrays to set/reset * NOTE: will not work with arrays, there are no arrays to set/reset
* @throws phpmailerException * @throws phpmailerException
* @return boolean * @return bool
* @TODO Should this not be using __set() magic function? * @todo Should this not be using __set() magic function?
*/ */
public function set($name, $value = '') public function set($name, $value = '')
{ {
@@ -3237,11 +3198,11 @@ class PHPMailer
/** /**
* Generate a DKIM signature. * Generate a DKIM signature.
* @access public * @access public
* @param string $signHeader * @param string $signheader Header
* @throws phpmailerException * @throws phpmailerException
* @return string * @return string
*/ */
public function DKIM_Sign($signHeader) public function DKIM_Sign($signheader)
{ {
if (!defined('PKCS7_TEXT')) { if (!defined('PKCS7_TEXT')) {
if ($this->exceptions) { if ($this->exceptions) {
@@ -3255,7 +3216,7 @@ class PHPMailer
} else { } else {
$privKey = $privKeyStr; $privKey = $privKeyStr;
} }
if (openssl_sign($signHeader, $signature, $privKey)) { if (openssl_sign($signheader, $signature, $privKey)) {
return base64_encode($signature); return base64_encode($signature);
} }
return ''; return '';
@@ -3264,21 +3225,21 @@ class PHPMailer
/** /**
* Generate a DKIM canonicalization header. * Generate a DKIM canonicalization header.
* @access public * @access public
* @param string $signHeader Header * @param string $signheader Header
* @return string * @return string
*/ */
public function DKIM_HeaderC($signHeader) public function DKIM_HeaderC($signheader)
{ {
$signHeader = preg_replace('/\r\n\s+/', ' ', $signHeader); $signheader = preg_replace('/\r\n\s+/', ' ', $signheader);
$lines = explode("\r\n", $signHeader); $lines = explode("\r\n", $signheader);
foreach ($lines as $key => $line) { foreach ($lines as $key => $line) {
list($heading, $value) = explode(':', $line, 2); list($heading, $value) = explode(':', $line, 2);
$heading = strtolower($heading); $heading = strtolower($heading);
$value = preg_replace('/\s+/', ' ', $value); // Compress useless spaces $value = preg_replace('/\s+/', ' ', $value); // Compress useless spaces
$lines[$key] = $heading . ':' . trim($value); // Don't forget to remove WSP around the value $lines[$key] = $heading . ':' . trim($value); // Don't forget to remove WSP around the value
} }
$signHeader = implode("\r\n", $lines); $signheader = implode("\r\n", $lines);
return $signHeader; return $signheader;
} }
/** /**
@@ -3420,15 +3381,15 @@ class PHPMailer
/** /**
* Perform a callback. * Perform a callback.
* @param boolean $isSent * @param bool $isSent
* @param array $to * @param string $to
* @param array $cc * @param string $cc
* @param array $bcc * @param string $bcc
* @param string $subject * @param string $subject
* @param string $body * @param string $body
* @param string $from * @param string $from
*/ */
protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from) protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from = null)
{ {
if (!empty($this->action_function) && is_callable($this->action_function)) { if (!empty($this->action_function) && is_callable($this->action_function)) {
$params = array($isSent, $to, $cc, $bcc, $subject, $body, $from); $params = array($isSent, $to, $cc, $bcc, $subject, $body, $from);

View File

@@ -34,18 +34,18 @@ class POP3
* @type string * @type string
* @access public * @access public
*/ */
public $Version = '5.2.9'; public $Version = '5.2.8';
/** /**
* Default POP3 port number. * Default POP3 port number.
* @type integer * @type int
* @access public * @access public
*/ */
public $POP3_PORT = 110; public $POP3_PORT = 110;
/** /**
* Default timeout in seconds. * Default timeout in seconds.
* @type integer * @type int
* @access public * @access public
*/ */
public $POP3_TIMEOUT = 30; public $POP3_TIMEOUT = 30;
@@ -61,7 +61,7 @@ class POP3
/** /**
* Debug display level. * Debug display level.
* Options: 0 = no, 1+ = yes * Options: 0 = no, 1+ = yes
* @type integer * @type int
* @access public * @access public
*/ */
public $do_debug = 0; public $do_debug = 0;
@@ -75,14 +75,14 @@ class POP3
/** /**
* POP3 port number. * POP3 port number.
* @type integer * @type int
* @access public * @access public
*/ */
public $port; public $port;
/** /**
* POP3 Timeout Value in seconds. * POP3 Timeout Value in seconds.
* @type integer * @type int
* @access public * @access public
*/ */
public $tval; public $tval;
@@ -110,32 +110,43 @@ class POP3
/** /**
* Are we connected? * Are we connected?
* @type boolean * @type bool
* @access private * @access private
*/ */
private $connected = false; private $connected;
/** /**
* Error container. * Error container.
* @type array * @type array
* @access private * @access private
*/ */
private $errors = array(); private $error;
/** /**
* Line break constant * Line break constant
*/ */
const CRLF = "\r\n"; const CRLF = "\r\n";
/**
* Constructor.
* @access public
*/
public function __construct()
{
$this->pop_conn = 0;
$this->connected = false;
$this->error = null;
}
/** /**
* Simple static wrapper for all-in-one POP before SMTP * Simple static wrapper for all-in-one POP before SMTP
* @param $host * @param $host
* @param boolean $port * @param bool $port
* @param boolean $tval * @param bool $tval
* @param string $username * @param string $username
* @param string $password * @param string $password
* @param integer $debug_level * @param int $debug_level
* @return boolean * @return bool
*/ */
public static function popBeforeSmtp( public static function popBeforeSmtp(
$host, $host,
@@ -154,34 +165,34 @@ class POP3
* A connect, login, disconnect sequence * A connect, login, disconnect sequence
* appropriate for POP-before SMTP authorisation. * appropriate for POP-before SMTP authorisation.
* @access public * @access public
* @param string $host The hostname to connect to * @param string $host
* @param integer|boolean $port The port number to connect to * @param bool|int $port
* @param integer|boolean $timeout The timeout value * @param bool|int $tval
* @param string $username * @param string $username
* @param string $password * @param string $password
* @param integer $debug_level * @param int $debug_level
* @return boolean * @return bool
*/ */
public function authorise($host, $port = false, $timeout = false, $username = '', $password = '', $debug_level = 0) public function authorise($host, $port = false, $tval = false, $username = '', $password = '', $debug_level = 0)
{ {
$this->host = $host; $this->host = $host;
// If no port value provided, use default // If no port value provided, use default
if ($port === false) { if ($port === false) {
$this->port = $this->POP3_PORT; $this->port = $this->POP3_PORT;
} else { } else {
$this->port = (integer)$port; $this->port = $port;
} }
// If no timeout value provided, use default // If no timeout value provided, use default
if ($timeout === false) { if ($tval === false) {
$this->tval = $this->POP3_TIMEOUT; $this->tval = $this->POP3_TIMEOUT;
} else { } else {
$this->tval = (integer)$timeout; $this->tval = $tval;
} }
$this->do_debug = $debug_level; $this->do_debug = $debug_level;
$this->username = $username; $this->username = $username;
$this->password = $password; $this->password = $password;
// Reset the error log // Refresh the error log
$this->errors = array(); $this->error = null;
// connect // connect
$result = $this->connect($this->host, $this->port, $this->tval); $result = $this->connect($this->host, $this->port, $this->tval);
if ($result) { if ($result) {
@@ -200,7 +211,7 @@ class POP3
* Connect to a POP3 server. * Connect to a POP3 server.
* @access public * @access public
* @param string $host * @param string $host
* @param integer|boolean $port * @param bool|int $port
* @param integer $tval * @param integer $tval
* @return boolean * @return boolean
*/ */
@@ -215,10 +226,6 @@ class POP3
//Rather than suppress it with @fsockopen, capture it cleanly instead //Rather than suppress it with @fsockopen, capture it cleanly instead
set_error_handler(array($this, 'catchWarning')); set_error_handler(array($this, 'catchWarning'));
if ($port === false) {
$port = $this->POP3_PORT;
}
// connect to the POP3 server // connect to the POP3 server
$this->pop_conn = fsockopen( $this->pop_conn = fsockopen(
$host, // POP3 Host $host, // POP3 Host
@@ -229,20 +236,34 @@ class POP3
); // Timeout (seconds) ); // Timeout (seconds)
// Restore the error handler // Restore the error handler
restore_error_handler(); restore_error_handler();
// Does the Error Log now contain anything?
if ($this->error && $this->do_debug >= 1) {
$this->displayErrors();
}
// Did we connect? // Did we connect?
if ($this->pop_conn === false) { if ($this->pop_conn == false) {
// It would appear not... // It would appear not...
$this->setError(array( $this->error = array(
'error' => "Failed to connect to server $host on port $port", 'error' => "Failed to connect to server $host on port $port",
'errno' => $errno, 'errno' => $errno,
'errstr' => $errstr 'errstr' => $errstr
)); );
if ($this->do_debug >= 1) {
$this->displayErrors();
}
return false; return false;
} }
// Increase the stream time-out // 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); 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 // Get the POP3 server response
$pop3_response = $this->getResponse(); $pop3_response = $this->getResponse();
@@ -265,8 +286,12 @@ class POP3
*/ */
public function login($username = '', $password = '') public function login($username = '', $password = '')
{ {
if (!$this->connected) { if ($this->connected == false) {
$this->setError('Not connected to POP3 server'); $this->error = 'Not connected to POP3 server';
if ($this->do_debug >= 1) {
$this->displayErrors();
}
} }
if (empty($username)) { if (empty($username)) {
$username = $this->username; $username = $this->username;
@@ -298,11 +323,7 @@ class POP3
$this->sendString('QUIT'); $this->sendString('QUIT');
//The QUIT command may cause the daemon to exit, which will kill our connection //The QUIT command may cause the daemon to exit, which will kill our connection
//So ignore errors here //So ignore errors here
try {
@fclose($this->pop_conn); @fclose($this->pop_conn);
} catch (Exception $e) {
//Do nothing
};
} }
/** /**
@@ -348,11 +369,14 @@ class POP3
private function checkResponse($string) private function checkResponse($string)
{ {
if (substr($string, 0, 3) !== '+OK') { if (substr($string, 0, 3) !== '+OK') {
$this->setError(array( $this->error = array(
'error' => "Server reported an error: $string", 'error' => "Server reported an error: $string",
'errno' => 0, 'errno' => 0,
'errstr' => '' 'errstr' => ''
)); );
if ($this->do_debug >= 1) {
$this->displayErrors();
}
return false; return false;
} else { } else {
return true; return true;
@@ -360,21 +384,17 @@ class POP3
} }
/** /**
* Add an error to the internal error store. * Display errors if debug is enabled.
* Also display debug output if it's enabled. * @access private
* @param $error
*/ */
private function setError($error) private function displayErrors()
{ {
$this->errors[] = $error;
if ($this->do_debug >= 1) {
echo '<pre>'; echo '<pre>';
foreach ($this->errors as $error) { foreach ($this->error as $single_error) {
print_r($error); print_r($single_error);
} }
echo '</pre>'; echo '</pre>';
} }
}
/** /**
* POP3 connection error handler. * POP3 connection error handler.
@@ -386,12 +406,12 @@ class POP3
*/ */
private function catchWarning($errno, $errstr, $errfile, $errline) private function catchWarning($errno, $errstr, $errfile, $errline)
{ {
$this->setError(array( $this->error[] = array(
'error' => "Connecting to the POP3 server raised a PHP warning: ", 'error' => "Connecting to the POP3 server raised a PHP warning: ",
'errno' => $errno, 'errno' => $errno,
'errstr' => $errstr, 'errstr' => $errstr,
'errfile' => $errfile, 'errfile' => $errfile,
'errline' => $errline 'errline' => $errline
)); );
} }
} }

View File

@@ -30,7 +30,7 @@ class SMTP
* The PHPMailer SMTP version number. * The PHPMailer SMTP version number.
* @type string * @type string
*/ */
const VERSION = '5.2.9'; const VERSION = '5.2.8';
/** /**
* SMTP line break constant. * SMTP line break constant.
@@ -40,53 +40,28 @@ class SMTP
/** /**
* The SMTP port to use if one is not specified. * The SMTP port to use if one is not specified.
* @type integer * @type int
*/ */
const DEFAULT_SMTP_PORT = 25; const DEFAULT_SMTP_PORT = 25;
/** /**
* The maximum line length allowed by RFC 2822 section 2.1.1 * The maximum line length allowed by RFC 2822 section 2.1.1
* @type integer * @type int
*/ */
const MAX_LINE_LENGTH = 998; const MAX_LINE_LENGTH = 998;
/**
* Debug level for no output
*/
const DEBUG_OFF = 0;
/**
* Debug level to show client -> server messages
*/
const DEBUG_CLIENT = 1;
/**
* Debug level to show client -> server and server -> client messages
*/
const DEBUG_SERVER = 2;
/**
* Debug level to show connection status, client -> server and server -> client messages
*/
const DEBUG_CONNECTION = 3;
/**
* Debug level to show all messages
*/
const DEBUG_LOWLEVEL = 4;
/** /**
* The PHPMailer SMTP Version number. * The PHPMailer SMTP Version number.
* @type string * @type string
* @deprecated Use the `VERSION` constant instead * @deprecated Use the constant instead
* @see SMTP::VERSION * @see SMTP::VERSION
*/ */
public $Version = '5.2.9'; public $Version = '5.2.8';
/** /**
* SMTP server port number. * SMTP server port number.
* @type integer * @type int
* @deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead * @deprecated This is only ever used as a default value, so use the constant instead
* @see SMTP::DEFAULT_SMTP_PORT * @see SMTP::DEFAULT_SMTP_PORT
*/ */
public $SMTP_PORT = 25; public $SMTP_PORT = 25;
@@ -94,7 +69,7 @@ class SMTP
/** /**
* SMTP reply line ending. * SMTP reply line ending.
* @type string * @type string
* @deprecated Use the `CRLF` constant instead * @deprecated Use the constant instead
* @see SMTP::CRLF * @see SMTP::CRLF
*/ */
public $CRLF = "\r\n"; public $CRLF = "\r\n";
@@ -102,27 +77,22 @@ class SMTP
/** /**
* Debug output level. * Debug output level.
* Options: * Options:
* * self::DEBUG_OFF (`0`) No debug output, default * * `0` No output
* * self::DEBUG_CLIENT (`1`) Client commands * * `1` Commands
* * self::DEBUG_SERVER (`2`) Client commands and server responses * * `2` Data and commands
* * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status * * `3` As 2 plus connection status
* * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages * * `4` Low-level data output
* @type integer * @type int
*/ */
public $do_debug = self::DEBUG_OFF; public $do_debug = 0;
/** /**
* How to handle debug output. * How to handle debug output.
* Options: * Options:
* * `echo` Output plain-text as-is, appropriate for CLI * * `echo` Output plain-text as-is, appropriate for CLI
* * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output * * `html` Output escaped, line breaks converted to <br>, appropriate for browser output
* * `error_log` Output to error log as configured in php.ini * * `error_log` Output to error log as configured in php.ini
* * @type string
* Alternatively, you can provide a callable expecting two params: a message string and the debug level:
* <code>
* $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
* </code>
* @type string|callable
*/ */
public $Debugoutput = 'echo'; public $Debugoutput = 'echo';
@@ -130,7 +100,7 @@ class SMTP
* Whether to use VERP. * Whether to use VERP.
* @link http://en.wikipedia.org/wiki/Variable_envelope_return_path * @link http://en.wikipedia.org/wiki/Variable_envelope_return_path
* @link http://www.postfix.org/VERP_README.html Info on VERP * @link http://www.postfix.org/VERP_README.html Info on VERP
* @type boolean * @type bool
*/ */
public $do_verp = false; public $do_verp = false;
@@ -139,16 +109,15 @@ class SMTP
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2 * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
* This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure. * This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.
* @link http://tools.ietf.org/html/rfc2821#section-4.5.3.2 * @link http://tools.ietf.org/html/rfc2821#section-4.5.3.2
* @type integer * @type int
*/ */
public $Timeout = 300; public $Timeout = 300;
/** /**
* How long to wait for commands to complete, in seconds. * The SMTP timelimit value for reads, in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2 * @type int
* @type integer
*/ */
public $Timelimit = 300; public $Timelimit = 30;
/** /**
* The socket for the server connection. * The socket for the server connection.
@@ -158,16 +127,15 @@ class SMTP
/** /**
* Error message, if any, for the last call. * Error message, if any, for the last call.
* @type array * @type string
*/ */
protected $error = array(); protected $error = '';
/** /**
* The reply the server sent to us for HELO. * The reply the server sent to us for HELO.
* If null, no HELO string has yet been received. * @type string
* @type string|null
*/ */
protected $helo_rply = null; protected $helo_rply = '';
/** /**
* The most recent reply received from the server. * The most recent reply received from the server.
@@ -175,23 +143,25 @@ class SMTP
*/ */
protected $last_reply = ''; protected $last_reply = '';
/**
* Constructor.
* @access public
*/
public function __construct()
{
$this->smtp_conn = 0;
$this->error = null;
$this->helo_rply = null;
$this->do_debug = 0;
}
/** /**
* Output debugging info via a user-selected method. * Output debugging info via a user-selected method.
* @see SMTP::$Debugoutput
* @see SMTP::$do_debug
* @param string $str Debug string to output * @param string $str Debug string to output
* @param integer $level The debug level of this message; see DEBUG_* constants
* @return void * @return void
*/ */
protected function edebug($str, $level = 0) protected function edebug($str)
{ {
if ($level > $this->do_debug) {
return;
}
if (is_callable($this->Debugoutput)) {
call_user_func($this->Debugoutput, $str, $this->do_debug);
return;
}
switch ($this->Debugoutput) { switch ($this->Debugoutput) {
case 'error_log': case 'error_log':
//Don't output, just log //Don't output, just log
@@ -208,35 +178,23 @@ class SMTP
break; break;
case 'echo': case 'echo':
default: default:
//Normalize line breaks echo gmdate('Y-m-d H:i:s')."\t".trim($str)."\n";
$str = preg_replace('/(\r\n|\r|\n)/ms', "\n", $str);
echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
"\n",
"\n \t ",
trim($str)
)."\n";
} }
} }
/** /**
* Connect to an SMTP server. * Connect to an SMTP server.
* @param string $host SMTP server IP or host name * @param string $host SMTP server IP or host name
* @param integer $port The port number to connect to * @param int $port The port number to connect to
* @param integer $timeout How long to wait for the connection to open * @param int $timeout How long to wait for the connection to open
* @param array $options An array of options for stream_context_create() * @param array $options An array of options for stream_context_create()
* @access public * @access public
* @return boolean * @return bool
*/ */
public function connect($host, $port = null, $timeout = 30, $options = array()) public function connect($host, $port = null, $timeout = 30, $options = array())
{ {
static $streamok;
//This is enabled by default since 5.0.0 but some providers disable it
//Check this once and cache the result
if (is_null($streamok)) {
$streamok = function_exists('stream_socket_client');
}
// Clear errors to avoid confusion // Clear errors to avoid confusion
$this->error = array(); $this->error = null;
// Make sure we are __not__ connected // Make sure we are __not__ connected
if ($this->connected()) { if ($this->connected()) {
// Already connected, generate error // Already connected, generate error
@@ -247,13 +205,11 @@ class SMTP
$port = self::DEFAULT_SMTP_PORT; $port = self::DEFAULT_SMTP_PORT;
} }
// Connect to the SMTP server // Connect to the SMTP server
$this->edebug( if ($this->do_debug >= 3) {
"Connection: opening to $host:$port, t=$timeout, opt=".var_export($options, true), $this->edebug('Connection: opening');
self::DEBUG_CONNECTION }
);
$errno = 0; $errno = 0;
$errstr = ''; $errstr = '';
if ($streamok) {
$socket_context = stream_context_create($options); $socket_context = stream_context_create($options);
//Suppress errors; connection failures are handled at a higher level //Suppress errors; connection failures are handled at a higher level
$this->smtp_conn = @stream_socket_client( $this->smtp_conn = @stream_socket_client(
@@ -264,35 +220,24 @@ class SMTP
STREAM_CLIENT_CONNECT, STREAM_CLIENT_CONNECT,
$socket_context $socket_context
); );
} else {
//Fall back to fsockopen which should work in more places, but is missing some features
$this->edebug(
"Connection: stream_socket_client not available, falling back to fsockopen",
self::DEBUG_CONNECTION
);
$this->smtp_conn = fsockopen(
$host,
$port,
$errno,
$errstr,
$timeout
);
}
// Verify we connected properly // Verify we connected properly
if (!is_resource($this->smtp_conn)) { if (empty($this->smtp_conn)) {
$this->error = array( $this->error = array(
'error' => 'Failed to connect to server', 'error' => 'Failed to connect to server',
'errno' => $errno, 'errno' => $errno,
'errstr' => $errstr 'errstr' => $errstr
); );
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'SMTP ERROR: ' . $this->error['error'] 'SMTP ERROR: ' . $this->error['error']
. ": $errstr ($errno)", . ": $errstr ($errno)"
self::DEBUG_CLIENT
); );
}
return false; return false;
} }
$this->edebug('Connection: opened', self::DEBUG_CONNECTION); if ($this->do_debug >= 3) {
$this->edebug('Connection: opened');
}
// SMTP server can take longer to respond, give longer timeout for first read // SMTP server can take longer to respond, give longer timeout for first read
// Windows does not have support for this timeout function // Windows does not have support for this timeout function
if (substr(PHP_OS, 0, 3) != 'WIN') { if (substr(PHP_OS, 0, 3) != 'WIN') {
@@ -304,14 +249,16 @@ class SMTP
} }
// Get any announcement // Get any announcement
$announce = $this->get_lines(); $announce = $this->get_lines();
$this->edebug('SERVER -> CLIENT: ' . $announce, self::DEBUG_SERVER); if ($this->do_debug >= 2) {
$this->edebug('SERVER -> CLIENT: ' . $announce);
}
return true; return true;
} }
/** /**
* Initiate a TLS (encrypted) session. * Initiate a TLS (encrypted) session.
* @access public * @access public
* @return boolean * @return bool
*/ */
public function startTLS() public function startTLS()
{ {
@@ -339,7 +286,7 @@ class SMTP
* @param string $realm The auth realm for NTLM * @param string $realm The auth realm for NTLM
* @param string $workstation The auth workstation for NTLM * @param string $workstation The auth workstation for NTLM
* @access public * @access public
* @return boolean True if successfully authenticated. * @return bool True if successfully authenticated.
*/ */
public function authenticate( public function authenticate(
$username, $username,
@@ -394,11 +341,12 @@ class SMTP
//Check that functions are available //Check that functions are available
if (!$ntlm_client->Initialize($temp)) { if (!$ntlm_client->Initialize($temp)) {
$this->error = array('error' => $temp->error); $this->error = array('error' => $temp->error);
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'You need to enable some modules in your php.ini file: ' 'You need to enable some modules in your php.ini file: '
. $this->error['error'], . $this->error['error']
self::DEBUG_CLIENT
); );
}
return false; return false;
} }
//msg1 //msg1
@@ -429,6 +377,7 @@ class SMTP
); );
// send encoded username // send encoded username
return $this->sendCommand('Username', base64_encode($msg3), 235); return $this->sendCommand('Username', base64_encode($msg3), 235);
break;
case 'CRAM-MD5': case 'CRAM-MD5':
// Start authentication // Start authentication
if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) { if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) {
@@ -442,6 +391,7 @@ class SMTP
// send encoded credentials // send encoded credentials
return $this->sendCommand('Username', base64_encode($response), 235); return $this->sendCommand('Username', base64_encode($response), 235);
break;
} }
return true; return true;
} }
@@ -467,7 +417,7 @@ class SMTP
// RFC 2104 HMAC implementation for php. // RFC 2104 HMAC implementation for php.
// Creates an md5 HMAC. // Creates an md5 HMAC.
// Eliminates the need to install mhash to compute a HMAC // Eliminates the need to install mhash to compute a HMAC
// by Lance Rushing // Hacked by Lance Rushing
$bytelen = 64; // byte length for md5 $bytelen = 64; // byte length for md5
if (strlen($key) > $bytelen) { if (strlen($key) > $bytelen) {
@@ -485,18 +435,19 @@ class SMTP
/** /**
* Check connection state. * Check connection state.
* @access public * @access public
* @return boolean True if connected. * @return bool True if connected.
*/ */
public function connected() public function connected()
{ {
if (is_resource($this->smtp_conn)) { if (!empty($this->smtp_conn)) {
$sock_status = stream_get_meta_data($this->smtp_conn); $sock_status = stream_get_meta_data($this->smtp_conn);
if ($sock_status['eof']) { if ($sock_status['eof']) {
// The socket is valid but we are not connected // the socket is valid but we are not connected
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'SMTP NOTICE: EOF caught while checking if connected', 'SMTP NOTICE: EOF caught while checking if connected'
self::DEBUG_CLIENT
); );
}
$this->close(); $this->close();
return false; return false;
} }
@@ -514,13 +465,15 @@ class SMTP
*/ */
public function close() public function close()
{ {
$this->error = array(); $this->error = null; // so there is no confusion
$this->helo_rply = null; $this->helo_rply = null;
if (is_resource($this->smtp_conn)) { if (!empty($this->smtp_conn)) {
// close the connection and cleanup // close the connection and cleanup
fclose($this->smtp_conn); fclose($this->smtp_conn);
$this->smtp_conn = null; //Makes for cleaner serialization if ($this->do_debug >= 3) {
$this->edebug('Connection: closed', self::DEBUG_CONNECTION); $this->edebug('Connection: closed');
}
$this->smtp_conn = 0;
} }
} }
@@ -534,15 +487,13 @@ class SMTP
* Implements rfc 821: DATA <CRLF> * Implements rfc 821: DATA <CRLF>
* @param string $msg_data Message data to send * @param string $msg_data Message data to send
* @access public * @access public
* @return boolean * @return bool
*/ */
public function data($msg_data) public function data($msg_data)
{ {
//This will use the standard timelimit
if (!$this->sendCommand('DATA', 'DATA', 354)) { if (!$this->sendCommand('DATA', 'DATA', 354)) {
return false; return false;
} }
/* The server is ready to accept data! /* The server is ready to accept data!
* According to rfc821 we should not send more than 1000 characters on a single line (including the CRLF) * According to rfc821 we should not send more than 1000 characters on a single line (including the CRLF)
* so we will break the data up into lines by \r and/or \n then if needed we will break each of those into * so we will break the data up into lines by \r and/or \n then if needed we will break each of those into
@@ -570,7 +521,7 @@ class SMTP
if ($in_headers and $line == '') { if ($in_headers and $line == '') {
$in_headers = false; $in_headers = false;
} }
//We need to break this line up into several smaller lines // ok we need to break this line up into several smaller lines
//This is a small micro-optimisation: isset($str[$len]) is equivalent to (strlen($str) > $len) //This is a small micro-optimisation: isset($str[$len]) is equivalent to (strlen($str) > $len)
while (isset($line[self::MAX_LINE_LENGTH])) { while (isset($line[self::MAX_LINE_LENGTH])) {
//Working backwards, try to find a space within the last MAX_LINE_LENGTH chars of the line to break on //Working backwards, try to find a space within the last MAX_LINE_LENGTH chars of the line to break on
@@ -587,7 +538,9 @@ class SMTP
//Move along by the amount we dealt with //Move along by the amount we dealt with
$line = substr($line, $pos + 1); $line = substr($line, $pos + 1);
} }
//If processing headers add a LWSP-char to the front of new line RFC822 section 3.1.1 /* If processing headers add a LWSP-char to the front of new line
* RFC822 section 3.1.1
*/
if ($in_headers) { if ($in_headers) {
$line = "\t" . $line; $line = "\t" . $line;
} }
@@ -605,13 +558,7 @@ class SMTP
} }
// Message data has been sent, complete the command // Message data has been sent, complete the command
//Increase timelimit for end of DATA command return $this->sendCommand('DATA END', '.', 250);
$savetimelimit = $this->Timelimit;
$this->Timelimit = $this->Timelimit * 2;
$result = $this->sendCommand('DATA END', '.', 250);
//Restore timelimit
$this->Timelimit = $savetimelimit;
return $result;
} }
/** /**
@@ -622,12 +569,12 @@ class SMTP
* and RFC 2821 EHLO. * and RFC 2821 EHLO.
* @param string $host The host name or IP to connect to * @param string $host The host name or IP to connect to
* @access public * @access public
* @return boolean * @return bool
*/ */
public function hello($host = '') public function hello($host = '')
{ {
// Try extended hello first (RFC 2821) // Try extended hello first (RFC 2821)
return (boolean)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host)); return (bool)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host));
} }
/** /**
@@ -637,7 +584,7 @@ class SMTP
* @param string $hello The HELO string * @param string $hello The HELO string
* @param string $host The hostname to say we are * @param string $host The hostname to say we are
* @access protected * @access protected
* @return boolean * @return bool
*/ */
protected function sendHello($hello, $host) protected function sendHello($hello, $host)
{ {
@@ -655,7 +602,7 @@ class SMTP
* Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF> * Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
* @param string $from Source address of this message * @param string $from Source address of this message
* @access public * @access public
* @return boolean * @return bool
*/ */
public function mail($from) public function mail($from)
{ {
@@ -671,9 +618,9 @@ class SMTP
* Send an SMTP QUIT command. * Send an SMTP QUIT command.
* Closes the socket if there is no error or the $close_on_error argument is true. * Closes the socket if there is no error or the $close_on_error argument is true.
* Implements from rfc 821: QUIT <CRLF> * Implements from rfc 821: QUIT <CRLF>
* @param boolean $close_on_error Should the connection close if an error occurs? * @param bool $close_on_error Should the connection close if an error occurs?
* @access public * @access public
* @return boolean * @return bool
*/ */
public function quit($close_on_error = true) public function quit($close_on_error = true)
{ {
@@ -693,7 +640,7 @@ class SMTP
* Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF> * Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
* @param string $toaddr The address the message is being sent to * @param string $toaddr The address the message is being sent to
* @access public * @access public
* @return boolean * @return bool
*/ */
public function recipient($toaddr) public function recipient($toaddr)
{ {
@@ -709,7 +656,7 @@ class SMTP
* Abort any transaction that is currently in progress. * Abort any transaction that is currently in progress.
* Implements rfc 821: RSET <CRLF> * Implements rfc 821: RSET <CRLF>
* @access public * @access public
* @return boolean True on success. * @return bool True on success.
*/ */
public function reset() public function reset()
{ {
@@ -720,9 +667,9 @@ class SMTP
* Send a command to an SMTP server and check its return code. * 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 $command The command name - not sent to the server
* @param string $commandstring The actual command to send * @param string $commandstring The actual command to send
* @param integer|array $expect One or more expected integer success codes * @param int|array $expect One or more expected integer success codes
* @access protected * @access protected
* @return boolean True on success. * @return bool True on success.
*/ */
protected function sendCommand($command, $commandstring, $expect) protected function sendCommand($command, $commandstring, $expect)
{ {
@@ -734,25 +681,30 @@ class SMTP
} }
$this->client_send($commandstring . self::CRLF); $this->client_send($commandstring . self::CRLF);
$this->last_reply = $this->get_lines(); $reply = $this->get_lines();
$code = substr($this->last_reply, 0, 3); $code = substr($reply, 0, 3);
$this->edebug('SERVER -> CLIENT: ' . $this->last_reply, self::DEBUG_SERVER); if ($this->do_debug >= 2) {
$this->edebug('SERVER -> CLIENT: ' . $reply);
}
if (!in_array($code, (array)$expect)) { if (!in_array($code, (array)$expect)) {
$this->last_reply = null;
$this->error = array( $this->error = array(
'error' => "$command command failed", 'error' => "$command command failed",
'smtp_code' => $code, 'smtp_code' => $code,
'detail' => substr($this->last_reply, 4) 'detail' => substr($reply, 4)
); );
if ($this->do_debug >= 1) {
$this->edebug( $this->edebug(
'SMTP ERROR: ' . $this->error['error'] . ': ' . $this->last_reply, 'SMTP ERROR: ' . $this->error['error'] . ': ' . $reply
self::DEBUG_CLIENT
); );
}
return false; return false;
} }
$this->error = array(); $this->last_reply = $reply;
$this->error = null;
return true; return true;
} }
@@ -767,7 +719,7 @@ class SMTP
* Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF> * Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
* @param string $from The address the message is from * @param string $from The address the message is from
* @access public * @access public
* @return boolean * @return bool
*/ */
public function sendAndMail($from) public function sendAndMail($from)
{ {
@@ -778,7 +730,7 @@ class SMTP
* Send an SMTP VRFY command. * Send an SMTP VRFY command.
* @param string $name The name to verify * @param string $name The name to verify
* @access public * @access public
* @return boolean * @return bool
*/ */
public function verify($name) public function verify($name)
{ {
@@ -789,7 +741,7 @@ class SMTP
* Send an SMTP NOOP command. * Send an SMTP NOOP command.
* Used to keep keep-alives alive, doesn't actually do anything * Used to keep keep-alives alive, doesn't actually do anything
* @access public * @access public
* @return boolean * @return bool
*/ */
public function noop() public function noop()
{ {
@@ -803,14 +755,16 @@ class SMTP
* and _may_ be implemented in future * and _may_ be implemented in future
* Implements from rfc 821: TURN <CRLF> * Implements from rfc 821: TURN <CRLF>
* @access public * @access public
* @return boolean * @return bool
*/ */
public function turn() public function turn()
{ {
$this->error = array( $this->error = array(
'error' => 'The SMTP TURN command is not implemented' 'error' => 'The SMTP TURN command is not implemented'
); );
$this->edebug('SMTP NOTICE: ' . $this->error['error'], self::DEBUG_CLIENT); if ($this->do_debug >= 1) {
$this->edebug('SMTP NOTICE: ' . $this->error['error']);
}
return false; return false;
} }
@@ -818,11 +772,13 @@ class SMTP
* Send raw data to the server. * Send raw data to the server.
* @param string $data The data to send * @param string $data The data to send
* @access public * @access public
* @return integer|boolean The number of bytes sent to the server or false on error * @return int|bool The number of bytes sent to the server or false on error
*/ */
public function client_send($data) public function client_send($data)
{ {
$this->edebug("CLIENT -> SERVER: $data", self::DEBUG_CLIENT); if ($this->do_debug >= 1) {
$this->edebug("CLIENT -> SERVER: $data");
}
return fwrite($this->smtp_conn, $data); return fwrite($this->smtp_conn, $data);
} }
@@ -869,10 +825,14 @@ class SMTP
} }
while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) { while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {
$str = @fgets($this->smtp_conn, 515); $str = @fgets($this->smtp_conn, 515);
$this->edebug("SMTP -> get_lines(): \$data was \"$data\"", self::DEBUG_LOWLEVEL); if ($this->do_debug >= 4) {
$this->edebug("SMTP -> get_lines(): \$str is \"$str\"", self::DEBUG_LOWLEVEL); $this->edebug("SMTP -> get_lines(): \$data was \"$data\"");
$this->edebug("SMTP -> get_lines(): \$str is \"$str\"");
}
$data .= $str; $data .= $str;
$this->edebug("SMTP -> get_lines(): \$data is \"$data\"", self::DEBUG_LOWLEVEL); if ($this->do_debug >= 4) {
$this->edebug("SMTP -> get_lines(): \$data is \"$data\"");
}
// If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen // If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen
if ((isset($str[3]) and $str[3] == ' ')) { if ((isset($str[3]) and $str[3] == ' ')) {
break; break;
@@ -880,19 +840,21 @@ class SMTP
// Timed-out? Log and break // Timed-out? Log and break
$info = stream_get_meta_data($this->smtp_conn); $info = stream_get_meta_data($this->smtp_conn);
if ($info['timed_out']) { if ($info['timed_out']) {
if ($this->do_debug >= 4) {
$this->edebug( $this->edebug(
'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)', 'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)'
self::DEBUG_LOWLEVEL
); );
}
break; break;
} }
// Now check if reads took too long // Now check if reads took too long
if ($endtime and time() > $endtime) { if ($endtime and time() > $endtime) {
if ($this->do_debug >= 4) {
$this->edebug( $this->edebug(
'SMTP -> get_lines(): timelimit reached ('. 'SMTP -> get_lines(): timelimit reached ('.
$this->Timelimit . ' sec)', $this->Timelimit . ' sec)'
self::DEBUG_LOWLEVEL
); );
}
break; break;
} }
} }
@@ -901,7 +863,7 @@ class SMTP
/** /**
* Enable or disable VERP address generation. * Enable or disable VERP address generation.
* @param boolean $enabled * @param bool $enabled
*/ */
public function setVerp($enabled = false) public function setVerp($enabled = false)
{ {
@@ -910,7 +872,7 @@ class SMTP
/** /**
* Get VERP address generation mode. * Get VERP address generation mode.
* @return boolean * @return bool
*/ */
public function getVerp() public function getVerp()
{ {
@@ -919,7 +881,7 @@ class SMTP
/** /**
* Set debug output method. * Set debug output method.
* @param string|callable $method The name of the mechanism to use for debugging output, or a callable to handle it. * @param string $method The function/method to use for debugging output.
*/ */
public function setDebugOutput($method = 'echo') public function setDebugOutput($method = 'echo')
{ {
@@ -937,7 +899,7 @@ class SMTP
/** /**
* Set debug output level. * Set debug output level.
* @param integer $level * @param int $level
*/ */
public function setDebugLevel($level = 0) public function setDebugLevel($level = 0)
{ {
@@ -946,7 +908,7 @@ class SMTP
/** /**
* Get debug output level. * Get debug output level.
* @return integer * @return int
*/ */
public function getDebugLevel() public function getDebugLevel()
{ {
@@ -955,7 +917,7 @@ class SMTP
/** /**
* Set SMTP timeout. * Set SMTP timeout.
* @param integer $timeout * @param int $timeout
*/ */
public function setTimeout($timeout = 0) public function setTimeout($timeout = 0)
{ {
@@ -964,7 +926,7 @@ class SMTP
/** /**
* Get SMTP timeout. * Get SMTP timeout.
* @return integer * @return int
*/ */
public function getTimeout() public function getTimeout()
{ {

View File

@@ -832,7 +832,7 @@ Following fields auto-filled in code as required:
*/ */
public function userStatusUpdate($action, $uid, $emailAddress = '') public function userStatusUpdate($action, $uid, $emailAddress = '')
{ {
$db = e107::getDb(); $db = e107::getDb('user');
$qry = ''; $qry = '';
$error = FALSE; // Assume no error to start with $error = FALSE; // Assume no error to start with
$uid = intval($uid); // Precautionary - should have already been done $uid = intval($uid); // Precautionary - should have already been done

View File

@@ -49,7 +49,7 @@ $action = e107::getParser()->toDB(varset($_GET['mode'],'makemail'));
break; break;
case 'prefs' : case 'prefs' :
$text = '<b>Configure mailshot options.</b><br /> $text = '<b>Configure mailshot options.</b><br />
A test email is sent using the current method and settings.<br /><br />'; A test email is sent using the current method and settings. If you are having problems with emails bouncing, try sending a test email to: <i>check-auth@verifier.port25.com</i> to ensure your server MX records are correct. Of course, be sure your site email address is correct before doing so.<br /><br />';
$text .= '<b>Emailing Method</b><br /> $text .= '<b>Emailing Method</b><br />
Use SMTP to send mail if possible. The settings will depend on your host\'s mail server.<br /><br />'; Use SMTP to send mail if possible. The settings will depend on your host\'s mail server.<br /><br />';
$text .= '<b>Default email format</b><br /> $text .= '<b>Default email format</b><br />
@@ -57,7 +57,7 @@ $action = e107::getParser()->toDB(varset($_GET['mode'],'makemail'));
security measures. If you select HTML, a separate plain text part is added.<br /><br />'; security measures. If you select HTML, a separate plain text part is added.<br /><br />';
$text .= '<b>Bulk mail controls</b><br /> $text .= '<b>Bulk mail controls</b><br />
The values you set here will depend on your host, and on the number of emails you send; it may be possible to set all values to zero so that the The values you set here will depend on your host, and on the number of emails you send; it may be possible to set all values to zero so that the
mail queue is emptied virtually instantly.<br /><br />'; mail queue is emptied virtually instantly. Typically it is best to send less than 500 emails per hour.<br /><br />';
$text .= '<b>Bounced Emails</b><br /> $text .= '<b>Bounced Emails</b><br />
You can specify an email address to receive the return response when an email is undeliverable. If you have control over your server, you can specify the You can specify an email address to receive the return response when an email is undeliverable. If you have control over your server, you can specify the
separate scheduler-driven auto-processing script; this receives bounce messages as they arrive, and updates status instantly. Otherwise you can specify a separate email account, separate scheduler-driven auto-processing script; this receives bounce messages as they arrive, and updates status instantly. Otherwise you can specify a separate email account,