/**
* Set the From and FromName properties.
* @param string $address
* @param string $name
* @param boolean $auto Whether to also set the Sender address, defaults to true
* @throws phpmailerException
* @return boolean
*/
public function setFrom($address, $name = ”, $auto = true)
{
$address = trim($address);
$name = trim(preg_replace(‘/[\r\n]+/’, ”, $name)); //Strip breaks and trim
// Don’t validate now addresses with IDN. Will be done in send().
if (($pos = strrpos($address, ‘@’)) === false or
(!$this->has8bitChars(substr($address, ++$pos)) or !$this->idnSupported()) and
!$this->validateAddress($address)) {
$error_message = $this->lang(‘invalid_address’) . ” (setFrom) $address”;
$this->setError($error_message);
$this->edebug($error_message);
if ($this->exceptions) {
throw new phpmailerException($error_message);
}
return false;
}
$this->From = $address;
$this->FromName = $name;
if ($auto) {
if (empty($this->Sender)) {
$this->Sender = $address;
}
}
return true;
}

/**
* Return the Message-ID header of the last email.
* Technically this is the value from the last time the headers were created,
* but it’s also the message ID of the last sent message except in
* pathological cases.
* @return string
*/
public function getLastMessageID()
{
return $this->lastMessageID;
}

/**
* Check that a string looks like an email address.
* @param string $address The email address to check
* @param string|callable $patternselect A selector for the validation pattern to use :
* * `auto` Pick best pattern automatically;
* * `pcre8` Use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14;
* * `pcre` Use old PCRE implementation;
* * `php` Use PHP built-in FILTER_VALIDATE_EMAIL;
* * `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.
* Alternatively you may pass in a callable to inject your own validator, for example:
* PHPMailer::validateAddress(‘user@example.com’, function($address) {
* return (strpos($address, ‘@’) !== false);
* });
* You can also set the PHPMailer::$validator static to a callable, allowing built-in methods to use your validator.
* @return boolean
* @static
* @access public
*/
public static function validateAddress($address, $patternselect = null)
{
if (is_null($patternselect)) {
$patternselect = self::$validator;
}
if (is_callable($patternselect)) {
return call_user_func($patternselect, $address);
}
//Reject line breaks in addresses; it’s valid RFC5322, but not RFC5321
if (strpos($address, “\n”) !== false or strpos($address, “\r”) !== false) {
return false;
}
if (!$patternselect or $patternselect == ‘auto’) {
//Check this constant first so it works when extension_loaded() is disabled by safe mode
//Constant was added in PHP 5.2.4
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’;
} else {
$patternselect = ‘pcre’;
}
} elseif (function_exists(‘extension_loaded’) and extension_loaded(‘pcre’)) {
//Fall back to older PCRE
$patternselect = ‘pcre’;
} else {
//Filter_var appeared in PHP 5.2.0 and does not require the PCRE extension
if (version_compare(PHP_VERSION, ‘5.2.0’) >= 0) {
$patternselect = ‘php’;
} else {
$patternselect = ‘noregex’;
}
}
}
switch ($patternselect) {
case ‘pcre8’:
/**
* Uses the same RFC5322 regex on which FILTER_VALIDATE_EMAIL is based, but allows dotless domains.
* @link http://squiloople.com/2009/12/20/email-address-validation/
* @copyright 2009-2010 Michael Rushton
* Feel free to use and redistribute this code. But please keep this copyright notice.
*/
return (boolean)preg_match(
‘/^(?!(?>(?1)”?(?>\\\[ -~]|[^”])”?(?1)){255,})(?!(?>(?1)”?(?>\\\[ -~]|[^”])”?(?1)){65,}@)’ .
‘((?>(?>(?>((?>(?>(?>\x0D\x0A)?[\t ])+|(?>[\t ]*\x0D\x0A)?[\t ]+)?)(\((?>(?2)’ .
‘(?>[\x01-\x08\x0B\x0C\x0E-\’*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\)))+(?2))|(?2))?)’ .
‘([!#-\’*+\/-9=?^-~-]+|”(?>(?2)(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\x7F]))*’ .
‘(?2)”)(?>(?1)\.(?1)(?4))*(?1)@(?!(?1)[a-z0-9-]{64,})(?1)(?>([a-z0-9](?>[a-z0-9-]*[a-z0-9])?)’ .
‘(?>(?1)\.(?!(?1)[a-z0-9-]{64,})(?1)(?5)){0,126}|\[(?:(?>IPv6:(?>([a-f0-9]{1,4})(?>:(?6)){7}’ .
‘|(?!(?:.*[a-f0-9][:\]]){8,})((?6)(?>:(?6)){0,6})?::(?7)?))|(?>(?>IPv6:(?>(?6)(?>:(?6)){5}:’ .
‘|(?!(?:.*[a-f0-9]:){6,})(?8)?::(?>((?6)(?>:(?6)){0,4}):)?))?(25[0-5]|2[0-4][0-9]|1[0-9]{2}’ .
‘|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD’,
$address
);
case ‘pcre’:
//An older regex that doesn’t need a recent PCRE
return (boolean)preg_match(
‘/^(?!(?>”?(?>\\\[ -~]|[^”])”?){255,})(?!(?>”?(?>\\\[ -~]|[^”])”?){65,}@)(?>’ .
‘[!#-\’*+\/-9=?^-~-]+|”(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*”)’ .
‘(?>\.(?>[!#-\’*+\/-9=?^-~-]+|”(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*”))*’ .
‘@(?>(?![a-z0-9-]{64,})(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)(?>\.(?![a-z0-9-]{64,})’ .
‘(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)){0,126}|\[(?:(?>IPv6:(?>(?>[a-f0-9]{1,4})(?>:’ .
‘[a-f0-9]{1,4}){7}|(?!(?:.*[a-f0-9][:\]]){8,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?’ .
‘::(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?))|(?>(?>IPv6:(?>[a-f0-9]{1,4}(?>:’ .
‘[a-f0-9]{1,4}){5}:|(?!(?:.*[a-f0-9]:){6,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4})?’ .
‘::(?>(?:[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4}):)?))?(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}’ .
‘|[1-9]?[0-9])(?>\.(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}))\])$/isD’,
$address
);
case ‘html5′:
/**
* 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)
*/
return (boolean)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])?)*$/sD’,
$address
);
case ‘noregex’:
//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
return (strlen($address) >= 3
and strpos($address, ‘@’) >= 1
and strpos($address, ‘@’) != strlen($address) – 1);
case ‘php’:
default:
return (boolean)filter_var($address, FILTER_VALIDATE_EMAIL);
}
}

/**
* Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the
* “intl” and “mbstring” PHP extensions.
* @return bool “true” if required functions for IDN support are present
*/
public function idnSupported()
{
// @TODO: Write our own “idn_to_ascii” function for PHP <= 5.2.
return function_exists(‘idn_to_ascii’) and function_exists(‘mb_convert_encoding’);
}

/**
* Converts IDN in given email address to its ASCII form, also known as punycode, if possible.
* Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet.
* This function silently returns unmodified address if:
* – No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form)
* – Conversion to punycode is impossible (e.g. required PHP functions are not available)
* or fails for any reason (e.g. domain has characters not allowed in an IDN)
* @see PHPMailer::$CharSet
* @param string $address The email address to convert
* @return string The encoded address in ASCII form
*/
public function punyencodeAddress($address)
{
// Verify we have required functions, CharSet, and at-sign.
if ($this->idnSupported() and
!empty($this->CharSet) and
($pos = strrpos($address, ‘@’)) !== false) {
$domain = substr($address, ++$pos);
// Verify CharSet string is a valid one, and domain properly encoded in this CharSet.
if ($this->has8bitChars($domain) and @mb_check_encoding($domain, $this->CharSet)) {
$domain = mb_convert_encoding($domain, ‘UTF-8’, $this->CharSet);
if (($punycode = defined(‘INTL_IDNA_VARIANT_UTS46’) ?
idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46) :
idn_to_ascii($domain)) !== false) {
return substr($address, 0, $pos) . $punycode;
}
}
}
return $address;
}

/**
* Create a message and send it.
* Uses the sending method specified by $Mailer.
* @throws phpmailerException
* @return boolean false on error – See the ErrorInfo property for details of the error.
*/
public function send()
{
try {
if (!$this->preSend()) {
return false;
}
return $this->postSend();
} catch (phpmailerException $exc) {
$this->mailHeader = ”;
$this->setError($exc->getMessage());
if ($this->exceptions) {
throw $exc;
}
return false;
}
}

/**
* Prepare a message for sending.
* @throws phpmailerException
* @return boolean
*/
public function preSend()
{
try {
$this->error_count = 0; // Reset errors
$this->mailHeader = ”;

// Dequeue recipient and Reply-To addresses with IDN
foreach (array_merge($this->RecipientsQueue, $this->ReplyToQueue) as $params) {
$params[1] = $this->punyencodeAddress($params[1]);
call_user_func_array(array($this, ‘addAnAddress’), $params);
}
if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
throw new phpmailerException($this->lang(‘provide_address’), self::STOP_CRITICAL);
}

// Validate From, Sender, and ConfirmReadingTo addresses
foreach (array(‘From’, ‘Sender’, ‘ConfirmReadingTo’) as $address_kind) {
$this->$address_kind = trim($this->$address_kind);
if (empty($this->$address_kind)) {
continue;
}
$this->$address_kind = $this->punyencodeAddress($this->$address_kind);
if (!$this->validateAddress($this->$address_kind)) {
$error_message = $this->lang(‘invalid_address’) . ‘ (punyEncode) ‘ . $this->$address_kind;
$this->setError($error_message);
$this->edebug($error_message);
if ($this->exceptions) {
throw new phpmailerException($error_message);
}
return false;
}
}

// Set whether the message is multipart/alternative
if ($this->alternativeExists()) {
$this->ContentType = ‘multipart/alternative’;
}

$this->setMessageType();
// Refuse to send an empty message unless we are specifically allowing it
if (!$this->AllowEmpty and empty($this->Body)) {
throw new phpmailerException($this->lang(’empty_message’), self::STOP_CRITICAL);
}

// Create body before headers in case body makes changes to headers (e.g. altering transfer encoding)
$this->MIMEHeader = ”;
$this->MIMEBody = $this->createBody();
// createBody may have added some headers, so retain them
$tempheaders = $this->MIMEHeader;
$this->MIMEHeader = $this->createHeader();
$this->MIMEHeader .= $tempheaders;

// To capture the complete message when using mail(), create
// an extra header list which createHeader() doesn’t fold in
if ($this->Mailer == ‘mail’) {
if (count($this->to) > 0) {
$this->mailHeader .= $this->addrAppend(‘To’, $this->to);
} else {
$this->mailHeader .= $this->headerLine(‘To’, ‘undisclosed-recipients:;’);
}
$this->mailHeader .= $this->headerLine(
‘Subject’,
$this->encodeHeader($this->secureHeader(trim($this->Subject)))
);
}

// Sign with DKIM if enabled
if (!empty($this->DKIM_domain)
&& !empty($this->DKIM_private)
&& !empty($this->DKIM_selector)
&& file_exists($this->DKIM_private)) {
$header_dkim = $this->DKIM_Add(
$this->MIMEHeader . $this->mailHeader,
$this->encodeHeader($this->secureHeader($this->Subject)),
$this->MIMEBody
);
$this->MIMEHeader = rtrim($this->MIMEHeader, “\r\n “) . self::CRLF .
str_replace(“\r\n”, “\n”, $header_dkim) . self::CRLF;
}
return true;
} catch (phpmailerException $exc) {
$this->setError($exc->getMessage());
if ($this->exceptions) {
throw $exc;
}
return false;
}
}

/**
* Actually send a message.
* Send the email via the selected mechanism
* @throws phpmailerException
* @return boolean
*/
public function postSend()
{
try {
// Choose the mailer and send through it
switch ($this->Mailer) {
case ‘sendmail’:
case ‘qmail’:
return $this->sendmailSend($this->MIMEHeader, $this->MIMEBody);
case ‘smtp’:
return $this->smtpSend($this->MIMEHeader, $this->MIMEBody);
case ‘mail’:
return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
default:
$sendMethod = $this->Mailer.’Send’;
if (method_exists($this, $sendMethod)) {
return $this->$sendMethod($this->MIMEHeader, $this->MIMEBody);
}

return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
}
} catch (phpmailerException $exc) {
$this->setError($exc->getMessage());
$this->edebug($exc->getMessage());
if ($this->exceptions) {
throw $exc;
}
}
return false;
}

/**
* Send mail using the $Sendmail program.
* @param string $header The message headers
* @param string $body The message body
* @see PHPMailer::$Sendmail
* @throws phpmailerException
* @access protected
* @return boolean
*/
protected function sendmailSend($header, $body)
{
if ($this->Sender != ”) {
if ($this->Mailer == ‘qmail’) {
$sendmail = sprintf(‘%s -f%s’, escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
} else {
$sendmail = sprintf(‘%s -oi -f%s -t’, escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
}
} else {
if ($this->Mailer == ‘qmail’) {
$sendmail = sprintf(‘%s’, escapeshellcmd($this->Sendmail));
} else {
$sendmail = sprintf(‘%s -oi -t’, escapeshellcmd($this->Sendmail));
}
}
if ($this->SingleTo) {
foreach ($this->SingleToArray as $toAddr) {
if (!@$mail = popen($sendmail, ‘w’)) {
throw new phpmailerException($this->lang(‘execute’) . $this->Sendmail, self::STOP_CRITICAL);
}
fputs($mail, ‘To: ‘ . $toAddr . “\n”);
fputs($mail, $header);
fputs($mail, $body);
$result = pclose($mail);
$this->doCallback(
($result == 0),
array($toAddr),
$this->cc,
$this->bcc,
$this->Subject,
$body,
$this->From
);
if ($result != 0) {
throw new phpmailerException($this->lang(‘execute’) . $this->Sendmail, self::STOP_CRITICAL);
}
}
} else {
if (!@$mail = popen($sendmail, ‘w’)) {
throw new phpmailerException($this->lang(‘execute’) . $this->Sendmail, self::STOP_CRITICAL);
}
fputs($mail, $header);
fputs($mail, $body);
$result = pclose($mail);
$this->doCallback(
($result == 0),
$this->to,
$this->cc,
$this->bcc,
$this->Subject,
$body,
$this->From
);
if ($result != 0) {
throw new phpmailerException($this->lang(‘execute’) . $this->Sendmail, self::STOP_CRITICAL);
}
}
return true;
}

/**
* Send mail using the PHP mail() function.
* @param string $header The message headers
* @param string $body The message body
* @link http://www.php.net/manual/en/book.mail.php
* @throws phpmailerException
* @access protected
* @return boolean
*/
protected function mailSend($header, $body)
{
$toArr = array();
foreach ($this->to as $toaddr) {
$toArr[] = $this->addrFormat($toaddr);
}
$to = implode(‘, ‘, $toArr);

$params = null;
//This sets the SMTP envelope sender which gets turned into a return-path header by the receiver
if (!empty($this->Sender)) {
$params = sprintf(‘-f%s’, $this->Sender);
}
if ($this->Sender != ” and !ini_get(‘safe_mode’)) {
$old_from = ini_get(‘sendmail_from’);
ini_set(‘sendmail_from’, $this->Sender);
}
$result = false;
if ($this->SingleTo and count($toArr) > 1) {
foreach ($toArr as $toAddr) {
$result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params);
$this->doCallback($result, array($toAddr), $this->cc, $this->bcc, $this->Subject, $body, $this->From);
}
} else {
$result = $this->mailPassthru($to, $this->Subject, $body, $header, $params);
$this->doCallback($result, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
}
if (isset($old_from)) {
ini_set(‘sendmail_from’, $old_from);
}
if (!$result) {
throw new phpmailerException($this->lang(‘instantiate’), self::STOP_CRITICAL);
}
return true;
}

/**
* Get an instance to use for SMTP operations.
* Override this function to load your own SMTP implementation
* @return SMTP
*/
public function getSMTPInstance()
{
if (!is_object($this->smtp)) {
$this->smtp = new SMTP;
}
return $this->smtp;
}

/**
* Send mail via SMTP.
* Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
* Uses the PHPMailerSMTP class by default.
* @see PHPMailer::getSMTPInstance() to use a different class.
* @param string $header The message headers
* @param string $body The message body
* @throws phpmailerException
* @uses SMTP
* @access protected
* @return boolean
*/
protected function smtpSend($header, $body)
{
$bad_rcpt = array();
if (!$this->smtpConnect($this->SMTPOptions)) {
throw new phpmailerException($this->lang(‘smtp_connect_failed’), self::STOP_CRITICAL);
}
if (” == $this->Sender) {
$smtp_from = $this->From;
} else {
$smtp_from = $this->Sender;
}
if (!$this->smtp->mail($smtp_from)) {
$this->setError($this->lang(‘from_failed’) . $smtp_from . ‘ : ‘ . implode(‘,’, $this->smtp->getError()));
throw new phpmailerException($this->ErrorInfo, self::STOP_CRITICAL);
}

// Attempt to send to all recipients
foreach (array($this->to, $this->cc, $this->bcc) as $togroup) {
foreach ($togroup as $to) {
if (!$this->smtp->recipient($to[0])) {
$error = $this->smtp->getError();
$bad_rcpt[] = array(‘to’ => $to[0], ‘error’ => $error[‘detail’]);
$isSent = false;
} else {
$isSent = true;
}
$this->doCallback($isSent, array($to[0]), array(), array(), $this->Subject, $body, $this->From);
}
}

// Only send the DATA command if we have viable recipients
if ((count($this->all_recipients) > count($bad_rcpt)) and !$this->smtp->data($header . $body)) {
throw new phpmailerException($this->lang(‘data_not_accepted’), self::STOP_CRITICAL);
}
if ($this->SMTPKeepAlive) {
$this->smtp->reset();
} else {
$this->smtp->quit();
$this->smtp->close();
}
//Create error message for any bad addresses
if (count($bad_rcpt) > 0) {
$errstr = ”;
foreach ($bad_rcpt as $bad) {
$errstr .= $bad[‘to’] . ‘: ‘ . $bad[‘error’];
}
throw new phpmailerException(
$this->lang(‘recipients_failed’) . $errstr,
self::STOP_CONTINUE
);
}
return true;
}

/**
* Initiate a connection to an SMTP server.
* Returns false if the operation failed.
* @param array $options An array of options compatible with stream_context_create()
* @uses SMTP
* @access public
* @throws phpmailerException
* @return boolean
*/
public function smtpConnect($options = null)
{
if (is_null($this->smtp)) {
$this->smtp = $this->getSMTPInstance();
}

//If no options are provided, use whatever is set in the instance
if (is_null($options)) {
$options = $this->SMTPOptions;
}

// Already connected?
if ($this->smtp->connected()) {
return true;
}

$this->smtp->setTimeout($this->Timeout);
$this->smtp->setDebugLevel($this->SMTPDebug);
$this->smtp->setDebugOutput($this->Debugoutput);
$this->smtp->setVerp($this->do_verp);
$hosts = explode(‘;’, $this->Host);
$lastexception = null;

foreach ($hosts as $hostentry) {
$hostinfo = array();
if (!preg_match(‘/^((ssl|tls):\/\/)*([a-zA-Z0-9\.-]*):?([0-9]*)$/’, trim($hostentry), $hostinfo)) {
// Not a valid host entry
continue;
}
// $hostinfo[2]: optional ssl or tls prefix
// $hostinfo[3]: the hostname
// $hostinfo[4]: optional port number
// The host string prefix can temporarily override the current setting for SMTPSecure
// If it’s not specified, the default value is used
$prefix = ”;
$secure = $this->SMTPSecure;
$tls = ($this->SMTPSecure == ‘tls’);
if (‘ssl’ == $hostinfo[2] or (” == $hostinfo[2] and ‘ssl’ == $this->SMTPSecure)) {
$prefix = ‘ssl://’;
$tls = false; // Can’t have SSL and TLS at the same time
$secure = ‘ssl’;
} elseif ($hostinfo[2] == ‘tls’) {
$tls = true;
// tls doesn’t use a prefix
$secure = ‘tls’;
}
//Do we need the OpenSSL extension?
$sslext = defined(‘OPENSSL_ALGO_SHA1’);
if (‘tls’ === $secure or ‘ssl’ === $secure) {
//Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled
if (!$sslext) {
throw new phpmailerException($this->lang(‘extension_missing’).’openssl’, self::STOP_CRITICAL);
}
}
$host = $hostinfo[3];
$port = $this->Port;
$tport = (integer)$hostinfo[4];
if ($tport > 0 and $tport < 65536) {
$port = $tport;
}
if ($this->smtp->connect($prefix . $host, $port, $this->Timeout, $options)) {
try {
if ($this->Helo) {
$hello = $this->Helo;
} else {
$hello = $this->serverHostname();
}
$this->smtp->hello($hello);
//Automatically enable TLS encryption if:
// * it’s not disabled
// * we have openssl extension
// * we are not already using SSL
// * the server offers STARTTLS
if ($this->SMTPAutoTLS and $sslext and $secure != ‘ssl’ and $this->smtp->getServerExt(‘STARTTLS’)) {
$tls = true;
}
if ($tls) {
if (!$this->smtp->startTLS()) {
throw new phpmailerException($this->lang(‘connect_host’));
}
// We must resend EHLO after TLS negotiation
$this->smtp->hello($hello);
}
if ($this->SMTPAuth) {
if (!$this->smtp->authenticate(
$this->Username,
$this->Password,
$this->AuthType,
$this->Realm,
$this->Workstation
)
) {
throw new phpmailerException($this->lang(‘authenticate’));
}
}
return true;
} catch (phpmailerException $exc) {
$lastexception = $exc;
$this->edebug($exc->getMessage());
// We must have connected, but then failed TLS or Auth, so close connection nicely
$this->smtp->quit();
}
}
}
// If we get here, all connection attempts have failed, so close connection hard
$this->smtp->close();
// As we’ve caught all exceptions, just report whatever the last one was
if ($this->exceptions and !is_null($lastexception)) {
throw $lastexception;
}
return false;
}

/**
* Close the active SMTP session if one exists.
* @return void
*/
public function smtpClose()
{
if (is_a($this->smtp, ‘SMTP’)) {
if ($this->smtp->connected()) {
$this->smtp->quit();
$this->smtp->close();
}
}
}

/**
* Set the language for error messages.
* Returns false if it cannot load the language file.
* The default language is English.
* @param string $langcode ISO 639-1 2-character language code (e.g. French is “fr”)
* @param string $lang_path Path to the language file directory, with trailing separator (slash)
* @return boolean
* @access public
*/
public function setLanguage($langcode = ‘en’, $lang_path = ”)
{
// Define full set of translatable strings in English
$PHPMAILER_LANG = array(
‘authenticate’ => ‘SMTP Error: Could not authenticate.’,
‘connect_host’ => ‘SMTP Error: Could not connect to SMTP host.’,
‘data_not_accepted’ => ‘SMTP Error: data not accepted.’,
’empty_message’ => ‘Message body empty’,
‘encoding’ => ‘Unknown encoding: ‘,
‘execute’ => ‘Could not execute: ‘,
‘file_access’ => ‘Could not access file: ‘,
‘file_open’ => ‘File Error: Could not open file: ‘,
‘from_failed’ => ‘The following From address failed: ‘,
‘instantiate’ => ‘Could not instantiate mail function.’,
‘invalid_address’ => ‘Invalid address: ‘,
‘mailer_not_supported’ => ‘ mailer is not supported.’,
‘provide_address’ => ‘You must provide at least one recipient email address.’,
‘recipients_failed’ => ‘SMTP Error: The following recipients failed: ‘,
‘signing’ => ‘Signing Error: ‘,
‘smtp_connect_failed’ => ‘SMTP connect() failed.’,
‘smtp_error’ => ‘SMTP server error: ‘,
‘variable_set’ => ‘Cannot set or reset variable: ‘,
‘extension_missing’ => ‘Extension missing: ‘
);
if (empty($lang_path)) {
// Calculate an absolute path so it can work if CWD is not here
$lang_path = dirname(__FILE__). DIRECTORY_SEPARATOR . ‘language’. DIRECTORY_SEPARATOR;
}
$foundlang = true;
$lang_file = $lang_path . ‘phpmailer.lang-‘ . $langcode . ‘.php’;
// There is no English translation file
if ($langcode != ‘en’) {
// Make sure language file path is readable
if (!is_readable($lang_file)) {
$foundlang = false;
} else {
// Overwrite language-specific strings.
// This way we’ll never have missing translation keys.
$foundlang = include $lang_file;
}
}
$this->language = $PHPMAILER_LANG;
return (boolean)$foundlang; // Returns false if language not found
}

/**
* Get the array of strings for the current language.
* @return array
*/
public function getTranslations()
{
return $this->language;
}

/**
* Create recipient headers.
* @access public
* @param string $type
* @param array $addr An array of recipient,
* where each recipient is a 2-element indexed array with element 0 containing an address
* and element 1 containing a name, like:
* array(array(‘joe@example.com’, ‘Joe User’), array(‘zoe@example.com’, ‘Zoe User’))
* @return string
*/
public function addrAppend($type, $addr)
{
$addresses = array();
foreach ($addr as $address) {
$addresses[] = $this->addrFormat($address);
}
return $type . ‘: ‘ . implode(‘, ‘, $addresses) . $this->LE;
}

/**
* Format an address for use in a message header.
* @access public
* @param array $addr A 2-element indexed array, element 0 containing an address, element 1 containing a name
* like array(‘joe@example.com’, ‘Joe User’)
* @return string
*/
public function addrFormat($addr)
{
if (empty($addr[1])) { // No name provided
return $this->secureHeader($addr[0]);
} else {
return $this->encodeHeader($this->secureHeader($addr[1]), ‘phrase’) . ‘ <‘ . $this->secureHeader(
$addr[0]
) . ‘>’;
}
}

/**
* Word-wrap message.
* For use with mailers that do not automatically perform wrapping
* and for quoted-printable encoded messages.
* Original written by philippe.
* @param string $message The message to wrap
* @param integer $length The line length to wrap to
* @param boolean $qp_mode Whether to run in Quoted-Printable mode
* @access public
* @return string
*/
public function wrapText($message, $length, $qp_mode = false)
{
if ($qp_mode) {
$soft_break = sprintf(‘ =%s’, $this->LE);
} else {
$soft_break = $this->LE;
}
// If utf-8 encoding is used, we will need to make sure we don’t
// split multibyte characters when we wrap
$is_utf8 = (strtolower($this->CharSet) == ‘utf-8’);
$lelen = strlen($this->LE);
$crlflen = strlen(self::CRLF);

$message = $this->fixEOL($message);
//Remove a trailing line break
if (substr($message, -$lelen) == $this->LE) {
$message = substr($message, 0, -$lelen);
}

//Split message into lines
$lines = explode($this->LE, $message);
//Message will be rebuilt in here
$message = ”;
foreach ($lines as $line) {
$words = explode(‘ ‘, $line);
$buf = ”;
$firstword = true;
foreach ($words as $word) {
if ($qp_mode and (strlen($word) > $length)) {
$space_left = $length – strlen($buf) – $crlflen;
if (!$firstword) {
if ($space_left > 20) {
$len = $space_left;
if ($is_utf8) {
$len = $this->utf8CharBoundary($word, $len);
} elseif (substr($word, $len – 1, 1) == ‘=’) {
$len–;
} elseif (substr($word, $len – 2, 1) == ‘=’) {
$len -= 2;
}
$part = substr($word, 0, $len);
$word = substr($word, $len);
$buf .= ‘ ‘ . $part;
$message .= $buf . sprintf(‘=%s’, self::CRLF);
} else {
$message .= $buf . $soft_break;
}
$buf = ”;
}
while (strlen($word) > 0) {
if ($length <= 0) {
break;
}
$len = $length;
if ($is_utf8) {
$len = $this->utf8CharBoundary($word, $len);
} elseif (substr($word, $len – 1, 1) == ‘=’) {
$len–;
} elseif (substr($word, $len – 2, 1) == ‘=’) {
$len -= 2;
}
$part = substr($word, 0, $len);
$word = substr($word, $len);

if (strlen($word) > 0) {
$message .= $part . sprintf(‘=%s’, self::CRLF);
} else {
$buf = $part;
}
}
} else {
$buf_o = $buf;
if (!$firstword) {
$buf .= ‘ ‘;
}
$buf .= $word;

if (strlen($buf) > $length and $buf_o != ”) {
$message .= $buf_o . $soft_break;
$buf = $word;
}
}
$firstword = false;
}
$message .= $buf . self::CRLF;
}

return $message;
}

/**
* Find the last character boundary prior to $maxLength in a utf-8
* quoted-printable encoded string.
* Original written by Colin Brown.
* @access public
* @param string $encodedText utf-8 QP text
* @param integer $maxLength Find the last character boundary prior to this length
* @return integer
*/
public function utf8CharBoundary($encodedText, $maxLength)
{
$foundSplitPos = false;
$lookBack = 3;
while (!$foundSplitPos) {
$lastChunk = substr($encodedText, $maxLength – $lookBack, $lookBack);
$encodedCharPos = strpos($lastChunk, ‘=’);
if (false !== $encodedCharPos) {
// Found start of encoded character byte within $lookBack block.
// Check the encoded byte value (the 2 chars after the ‘=’)
$hex = substr($encodedText, $maxLength – $lookBack + $encodedCharPos + 1, 2);
$dec = hexdec($hex);
if ($dec < 128) {
// Single byte character.
// If the encoded char was found at pos 0, it will fit
// otherwise reduce maxLength to start of the encoded char
if ($encodedCharPos > 0) {
$maxLength = $maxLength – ($lookBack – $encodedCharPos);
}
$foundSplitPos = true;
} elseif ($dec >= 192) {
// First byte of a multi byte character
// Reduce maxLength to split at start of character
$maxLength = $maxLength – ($lookBack – $encodedCharPos);
$foundSplitPos = true;
} elseif ($dec < 192) {
// Middle byte of a multi byte character, look further back
$lookBack += 3;
}
} else {
// No encoded character found
$foundSplitPos = true;
}
}
return $maxLength;
}

/**
* Apply word wrapping to the message body.
* Wraps the message body to the number of chars set in the WordWrap property.
* You should only do this to plain-text bodies as wrapping HTML tags may break them.
* This is called automatically by createBody(), so you don’t need to call it yourself.
* @access public
* @return void
*/
public function setWordWrap()
{
if ($this->WordWrap < 1) {
return;
}

switch ($this->message_type) {
case ‘alt’:
case ‘alt_inline’:
case ‘alt_attach’:
case ‘alt_inline_attach’:
$this->AltBody = $this->wrapText($this->AltBody, $this->WordWrap);
break;
default:
$this->Body = $this->wrapText($this->Body, $this->WordWrap);
break;
}
}

/**
* Assemble message headers.
* @access public
* @return string The assembled headers
*/
public function createHeader()
{
$result = ”;

if ($this->MessageDate == ”) {
$this->MessageDate = self::rfcDate();
}
$result .= $this->headerLine(‘Date’, $this->MessageDate);

// To be created automatically by mail()
if ($this->SingleTo) {
if ($this->Mailer != ‘mail’) {
foreach ($this->to as $toaddr) {
$this->SingleToArray[] = $this->addrFormat($toaddr);
}
}
} else {
if (count($this->to) > 0) {
if ($this->Mailer != ‘mail’) {
$result .= $this->addrAppend(‘To’, $this->to);
}
} elseif (count($this->cc) == 0) {
$result .= $this->headerLine(‘To’, ‘undisclosed-recipients:;’);
}
}

$result .= $this->addrAppend(‘From’, array(array(trim($this->From), $this->FromName)));

// sendmail and mail() extract Cc from the header before sending
if (count($this->cc) > 0) {
$result .= $this->addrAppend(‘Cc’, $this->cc);
}

// sendmail and mail() extract Bcc from the header before sending
if ((
$this->Mailer == ‘sendmail’ or $this->Mailer == ‘qmail’ or $this->Mailer == ‘mail’
)
and count($this->bcc) > 0
) {
$result .= $this->addrAppend(‘Bcc’, $this->bcc);
}

if (count($this->ReplyTo) > 0) {
$result .= $this->addrAppend(‘Reply-To’, $this->ReplyTo);
}

// mail() sets the subject itself
if ($this->Mailer != ‘mail’) {
$result .= $this->headerLine(‘Subject’, $this->encodeHeader($this->secureHeader($this->Subject)));
}

if (” != $this->MessageID and preg_match(‘/^<.*@.*>$/’, $this->MessageID)) {
$this->lastMessageID = $this->MessageID;
} else {
$this->lastMessageID = sprintf(‘<%s@%s>’, $this->uniqueid, $this->serverHostname());
}
$result .= $this->headerLine(‘Message-ID’, $this->lastMessageID);
if (!is_null($this->Priority)) {
$result .= $this->headerLine(‘X-Priority’, $this->Priority);
}
if ($this->XMailer == ”) {
$result .= $this->headerLine(
‘X-Mailer’,
‘PHPMailer ‘ . $this->Version . ‘ (https://github.com/PHPMailer/PHPMailer)’
);
} else {
$myXmailer = trim($this->XMailer);
if ($myXmailer) {
$result .= $this->headerLine(‘X-Mailer’, $myXmailer);
}
}

if ($this->ConfirmReadingTo != ”) {
$result .= $this->headerLine(‘Disposition-Notification-To’, ‘<‘ . $this->ConfirmReadingTo . ‘>’);
}

// Add custom headers
foreach ($this->CustomHeader as $header) {
$result .= $this->headerLine(
trim($header[0]),
$this->encodeHeader(trim($header[1]))
);
}
if (!$this->sign_key_file) {
$result .= $this->headerLine(‘MIME-Version’, ‘1.0’);
$result .= $this->getMailMIME();
}

return $result;
}

/**
* Get the message MIME type headers.
* @access public
* @return string
*/
public function getMailMIME()
{
$result = ”;
$ismultipart = true;
switch ($this->message_type) {
case ‘inline’:
$result .= $this->headerLine(‘Content-Type’, ‘multipart/related;’);
$result .= $this->textLine(“\tboundary=\”” . $this->boundary[1] . ‘”‘);
break;
case ‘attach’:
case ‘inline_attach’:
case ‘alt_attach’:
case ‘alt_inline_attach’:
$result .= $this->headerLine(‘Content-Type’, ‘multipart/mixed;’);
$result .= $this->textLine(“\tboundary=\”” . $this->boundary[1] . ‘”‘);
break;
case ‘alt’:
case ‘alt_inline’:
$result .= $this->headerLine(‘Content-Type’, ‘multipart/alternative;’);
$result .= $this->textLine(“\tboundary=\”” . $this->boundary[1] . ‘”‘);
break;
default:
// Catches case ‘plain’: and case ”:
$result .= $this->textLine(‘Content-Type: ‘ . $this->ContentType . ‘; charset=’ . $this->CharSet);
$ismultipart = false;
break;
}
// RFC1341 part 5 says 7bit is assumed if not specified
if ($this->Encoding != ‘7bit’) {
// RFC 2045 section 6.4 says multipart MIME parts may only use 7bit, 8bit or binary CTE
if ($ismultipart) {
if ($this->Encoding == ‘8bit’) {
$result .= $this->headerLine(‘Content-Transfer-Encoding’, ‘8bit’);
}
// The only remaining alternatives are quoted-printable and base64, which are both 7bit compatible
} else {
$result .= $this->headerLine(‘Content-Transfer-Encoding’, $this->Encoding);
}
}

if ($this->Mailer != ‘mail’) {
$result .= $this->LE;
}

return $result;
}

/**
* Returns the whole MIME message.
* Includes complete headers and body.
* Only valid post preSend().
* @see PHPMailer::preSend()
* @access public
* @return string
*/
public function getSentMIMEMessage()
{
return rtrim($this->MIMEHeader . $this->mailHeader, “\n\r”) . self::CRLF . self::CRLF . $this->MIMEBody;
}

/**
* Assemble the message body.
* Returns an empty string on failure.
* @access public
* @throws phpmailerException
* @return string The assembled message body
*/
public function createBody()
{
$body = ”;
//Create unique IDs and preset boundaries
$this->uniqueid = md5(uniqid(time()));
$this->boundary[1] = ‘b1_’ . $this->uniqueid;
$this->boundary[2] = ‘b2_’ . $this->uniqueid;
$this->boundary[3] = ‘b3_’ . $this->uniqueid;

if ($this->sign_key_file) {
$body .= $this->getMailMIME() . $this->LE;
}

$this->setWordWrap();

$bodyEncoding = $this->Encoding;
$bodyCharSet = $this->CharSet;
//Can we do a 7-bit downgrade?
if ($bodyEncoding == ‘8bit’ and !$this->has8bitChars($this->Body)) {
$bodyEncoding = ‘7bit’;
//All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit
$bodyCharSet = ‘us-ascii’;
}
//If lines are too long, and we’re not already using an encoding that will shorten them,
//change to quoted-printable transfer encoding for the body part only
if (‘base64’ != $this->Encoding and self::hasLineLongerThanMax($this->Body)) {
$bodyEncoding = ‘quoted-printable’;
}

$altBodyEncoding = $this->Encoding;
$altBodyCharSet = $this->CharSet;
//Can we do a 7-bit downgrade?
if ($altBodyEncoding == ‘8bit’ and !$this->has8bitChars($this->AltBody)) {
$altBodyEncoding = ‘7bit’;
//All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit
$altBodyCharSet = ‘us-ascii’;
}
//If lines are too long, and we’re not already using an encoding that will shorten them,
//change to quoted-printable transfer encoding for the alt body part only
if (‘base64’ != $altBodyEncoding and self::hasLineLongerThanMax($this->AltBody)) {
$altBodyEncoding = ‘quoted-printable’;
}
//Use this as a preamble in all multipart message types
$mimepre = “This is a multi-part message in MIME format.” . $this->LE . $this->LE;
switch ($this->message_type) {
case ‘inline’:
$body .= $mimepre;
$body .= $this->getBoundary($this->boundary[1], $bodyCharSet, ”, $bodyEncoding);
$body .= $this->encodeString($this->Body, $bodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->attachAll(‘inline’, $this->boundary[1]);
break;
case ‘attach’:
$body .= $mimepre;
$body .= $this->getBoundary($this->boundary[1], $bodyCharSet, ”, $bodyEncoding);
$body .= $this->encodeString($this->Body, $bodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->attachAll(‘attachment’, $this->boundary[1]);
break;
case ‘inline_attach’:
$body .= $mimepre;
$body .= $this->textLine(‘–‘ . $this->boundary[1]);
$body .= $this->headerLine(‘Content-Type’, ‘multipart/related;’);
$body .= $this->textLine(“\tboundary=\”” . $this->boundary[2] . ‘”‘);
$body .= $this->LE;
$body .= $this->getBoundary($this->boundary[2], $bodyCharSet, ”, $bodyEncoding);
$body .= $this->encodeString($this->Body, $bodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->attachAll(‘inline’, $this->boundary[2]);
$body .= $this->LE;
$body .= $this->attachAll(‘attachment’, $this->boundary[1]);
break;
case ‘alt’:
$body .= $mimepre;
$body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, ‘text/plain’, $altBodyEncoding);
$body .= $this->encodeString($this->AltBody, $altBodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->getBoundary($this->boundary[1], $bodyCharSet, ‘text/html’, $bodyEncoding);
$body .= $this->encodeString($this->Body, $bodyEncoding);
$body .= $this->LE . $this->LE;
if (!empty($this->Ical)) {
$body .= $this->getBoundary($this->boundary[1], ”, ‘text/calendar; method=REQUEST’, ”);
$body .= $this->encodeString($this->Ical, $this->Encoding);
$body .= $this->LE . $this->LE;
}
$body .= $this->endBoundary($this->boundary[1]);
break;
case ‘alt_inline’:
$body .= $mimepre;
$body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, ‘text/plain’, $altBodyEncoding);
$body .= $this->encodeString($this->AltBody, $altBodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->textLine(‘–‘ . $this->boundary[1]);
$body .= $this->headerLine(‘Content-Type’, ‘multipart/related;’);
$body .= $this->textLine(“\tboundary=\”” . $this->boundary[2] . ‘”‘);
$body .= $this->LE;
$body .= $this->getBoundary($this->boundary[2], $bodyCharSet, ‘text/html’, $bodyEncoding);
$body .= $this->encodeString($this->Body, $bodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->attachAll(‘inline’, $this->boundary[2]);
$body .= $this->LE;
$body .= $this->endBoundary($this->boundary[1]);
break;
case ‘alt_attach’:
$body .= $mimepre;
$body .= $this->textLine(‘–‘ . $this->boundary[1]);
$body .= $this->headerLine(‘Content-Type’, ‘multipart/alternative;’);
$body .= $this->textLine(“\tboundary=\”” . $this->boundary[2] . ‘”‘);
$body .= $this->LE;
$body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, ‘text/plain’, $altBodyEncoding);
$body .= $this->encodeString($this->AltBody, $altBodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->getBoundary($this->boundary[2], $bodyCharSet, ‘text/html’, $bodyEncoding);
$body .= $this->encodeString($this->Body, $bodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->endBoundary($this->boundary[2]);
$body .= $this->LE;
$body .= $this->attachAll(‘attachment’, $this->boundary[1]);
break;
case ‘alt_inline_attach’:
$body .= $mimepre;
$body .= $this->textLine(‘–‘ . $this->boundary[1]);
$body .= $this->headerLine(‘Content-Type’, ‘multipart/alternative;’);
$body .= $this->textLine(“\tboundary=\”” . $this->boundary[2] . ‘”‘);
$body .= $this->LE;
$body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, ‘text/plain’, $altBodyEncoding);
$body .= $this->encodeString($this->AltBody, $altBodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->textLine(‘–‘ . $this->boundary[2]);
$body .= $this->headerLine(‘Content-Type’, ‘multipart/related;’);
$body .= $this->textLine(“\tboundary=\”” . $this->boundary[3] . ‘”‘);
$body .= $this->LE;
$body .= $this->getBoundary($this->boundary[3], $bodyCharSet, ‘text/html’, $bodyEncoding);
$body .= $this->encodeString($this->Body, $bodyEncoding);
$body .= $this->LE . $this->LE;
$body .= $this->attachAll(‘inline’, $this->boundary[3]);
$body .= $this->LE;
$body .= $this->endBoundary($this->boundary[2]);
$body .= $this->LE;
$body .= $this->attachAll(‘attachment’, $this->boundary[1]);
break;
default:
// Catch case ‘plain’ and case ”, applies to simple `text/plain` and `text/html` body content types
//Reset the `Encoding` property in case we changed it for line length reasons
$this->Encoding = $bodyEncoding;
$body .= $this->encodeString($this->Body, $this->Encoding);
break;
}

if ($this->isError()) {
$body = ”;
} elseif ($this->sign_key_file) {
try {
if (!defined(‘PKCS7_TEXT’)) {
throw new phpmailerException($this->lang(‘extension_missing’) . ‘openssl’);
}
// @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’);
if (false === file_put_contents($file, $body)) {
throw new phpmailerException($this->lang(‘signing’) . ‘ Could not write temp file’);
}
$signed = tempnam(sys_get_temp_dir(), ‘signed’);
//Workaround for PHP bug https://bugs.php.net/bug.php?id=69197
if (empty($this->sign_extracerts_file)) {
$sign = @openssl_pkcs7_sign(
$file,
$signed,
‘file://’ . realpath($this->sign_cert_file),
array(‘file://’ . realpath($this->sign_key_file), $this->sign_key_pass),
null
);
} else {
$sign = @openssl_pkcs7_sign(
$file,
$signed,
‘file://’ . realpath($this->sign_cert_file),
array(‘file://’ . realpath($this->sign_key_file), $this->sign_key_pass),
null,
PKCS7_DETACHED,
$this->sign_extracerts_file
);
}
if ($sign) {
@unlink($file);
$body = file_get_contents($signed);
@unlink($signed);
//The message returned by openssl contains both headers and body, so need to split them up
$parts = explode(“\n\n”, $body, 2);
$this->MIMEHeader .= $parts[0] . $this->LE . $this->LE;
$body = $parts[1];
} else {
@unlink($file);
@unlink($signed);
throw new phpmailerException($this->lang(‘signing’) . openssl_error_string());
}
} catch (phpmailerException $exc) {
$body = ”;
if ($this->exceptions) {
throw $exc;
}
}
}
return $body;
}

/**
* Return the start of a message boundary.
* @access protected
* @param string $boundary
* @param string $charSet
* @param string $contentType
* @param string $encoding
* @return string
*/
protected function getBoundary($boundary, $charSet, $contentType, $encoding)
{
$result = ”;
if ($charSet == ”) {
$charSet = $this->CharSet;
}
if ($contentType == ”) {
$contentType = $this->ContentType;
}
if ($encoding == ”) {
$encoding = $this->Encoding;
}
$result .= $this->textLine(‘–‘ . $boundary);
$result .= sprintf(‘Content-Type: %s; charset=%s’, $contentType, $charSet);
$result .= $this->LE;
// RFC1341 part 5 says 7bit is assumed if not specified
if ($encoding != ‘7bit’) {
$result .= $this->headerLine(‘Content-Transfer-Encoding’, $encoding);
}
$result .= $this->LE;

return $result;
}

/**
* Return the end of a message boundary.
* @access protected
* @param string $boundary
* @return string
*/
protected function endBoundary($boundary)
{
return $this->LE . ‘–‘ . $boundary . ‘–‘ . $this->LE;
}

/**
* Set the message type.
* PHPMailer only supports some preset message types, not arbitrary MIME structures.
* @access protected
* @return void
*/
protected function setMessageType()
{
$type = array();
if ($this->alternativeExists()) {
$type[] = ‘alt’;
}
if ($this->inlineImageExists()) {
$type[] = ‘inline’;
}
if ($this->attachmentExists()) {
$type[] = ‘attach’;
}
$this->message_type = implode(‘_’, $type);
if ($this->message_type == ”) {
//The ‘plain’ message_type refers to the message having a single body element, not that it is plain-text
$this->message_type = ‘plain’;
}
}

/**
* Format a header line.
* @access public
* @param string $name
* @param string $value
* @return string
*/
public function headerLine($name, $value)
{
return $name . ‘: ‘ . $value . $this->LE;
}

/**
* Return a formatted mail line.
* @access public
* @param string $value
* @return string
*/
public function textLine($value)
{
return $value . $this->LE;
}

/**
* Add an attachment from a path on the filesystem.
* Returns false if the file could not be found or read.
* @param string $path Path to the attachment.
* @param string $name Overrides the attachment name.
* @param string $encoding File encoding (see $Encoding).
* @param string $type File extension (MIME) type.
* @param string $disposition Disposition to use
* @throws phpmailerException
* @return boolean
*/
public function addAttachment($path, $name = ”, $encoding = ‘base64’, $type = ”, $disposition = ‘attachment’)
{
try {
if (!@is_file($path)) {
throw new phpmailerException($this->lang(‘file_access’) . $path, self::STOP_CONTINUE);
}

// If a MIME type is not specified, try to work it out from the file name
if ($type == ”) {
$type = self::filenameToType($path);
}

$filename = basename($path);
if ($name == ”) {
$name = $filename;
}

$this->attachment[] = array(
0 => $path,
1 => $filename,
2 => $name,
3 => $encoding,
4 => $type,
5 => false, // isStringAttachment
6 => $disposition,
7 => 0
);

} catch (phpmailerException $exc) {
$this->setError($exc->getMessage());
$this->edebug($exc->getMessage());
if ($this->exceptions) {
throw $exc;
}
return false;
}
return true;
}

/**
* Return the array of attachments.
* @return array
*/
public function getAttachments()
{
return $this->attachment;
}

/**
* Attach all file, string, and binary attachments to the message.
* Returns an empty string on failure.
* @access protected
* @param string $disposition_type
* @param string $boundary
* @return string
*/
protected function attachAll($disposition_type, $boundary)
{
// Return text of body
$mime = array();
$cidUniq = array();
$incl = array();

// Add all attachments
foreach ($this->attachment as $attachment) {
// Check if it is a valid disposition_filter
if ($attachment[6] == $disposition_type) {
// Check for string attachment
$string = ”;
$path = ”;
$bString = $attachment[5];
if ($bString) {
$string = $attachment[0];
} else {
$path = $attachment[0];
}

$inclhash = md5(serialize($attachment));
if (in_array($inclhash, $incl)) {
continue;
}
$incl[] = $inclhash;
$name = $attachment[2];
$encoding = $attachment[3];
$type = $attachment[4];
$disposition = $attachment[6];
$cid = $attachment[7];
if ($disposition == ‘inline’ && array_key_exists($cid, $cidUniq)) {
continue;
}
$cidUniq[$cid] = true;

$mime[] = sprintf(‘–%s%s’, $boundary, $this->LE);
//Only include a filename property if we have one
if (!empty($name)) {
$mime[] = sprintf(
‘Content-Type: %s; name=”%s”%s’,
$type,
$this->encodeHeader($this->secureHeader($name)),
$this->LE
);
} else {
$mime[] = sprintf(
‘Content-Type: %s%s’,
$type,
$this->LE
);
}
// RFC1341 part 5 says 7bit is assumed if not specified
if ($encoding != ‘7bit’) {
$mime[] = sprintf(‘Content-Transfer-Encoding: %s%s’, $encoding, $this->LE);
}

if ($disposition == ‘inline’) {
$mime[] = sprintf(‘Content-ID: <%s>%s’, $cid, $this->LE);
}

// If a filename contains any of these chars, it should be quoted,
// but not otherwise: RFC2183 & RFC2045 5.1
// Fixes a warning in IETF’s msglint MIME checker
// Allow for bypassing the Content-Disposition header totally
if (!(empty($disposition))) {
$encoded_name = $this->encodeHeader($this->secureHeader($name));
if (preg_match(‘/[ \(\)<>@,;:\\”\/\[\]\?=]/’, $encoded_name)) {
$mime[] = sprintf(
‘Content-Disposition: %s; filename=”%s”%s’,
$disposition,
$encoded_name,
$this->LE . $this->LE
);
} else {
if (!empty($encoded_name)) {
$mime[] = sprintf(
‘Content-Disposition: %s; filename=%s%s’,
$disposition,
$encoded_name,
$this->LE . $this->LE
);
} else {
$mime[] = sprintf(
‘Content-Disposition: %s%s’,
$disposition,
$this->LE . $this->LE
);
}
}
} else {
$mime[] = $this->LE;
}

// Encode as string attachment
if ($bString) {
$mime[] = $this->encodeString($string, $encoding);
if ($this->isError()) {
return ”;
}
$mime[] = $this->LE . $this->LE;
} else {
$mime[] = $this->encodeFile($path, $encoding);
if ($this->isError()) {
return ”;
}
$mime[] = $this->LE . $this->LE;
}
}
}

$mime[] = sprintf(‘–%s–%s’, $boundary, $this->LE);

return implode(”, $mime);
}

/**
* Encode a file attachment in requested format.
* Returns an empty string on failure.
* @param string $path The full path to the file
* @param string $encoding The encoding to use; one of ‘base64’, ‘7bit’, ‘8bit’, ‘binary’, ‘quoted-printable’
* @throws phpmailerException
* @access protected
* @return string
*/
protected function encodeFile($path, $encoding = ‘base64’)
{
try {
if (!is_readable($path)) {
throw new phpmailerException($this->lang(‘file_open’) . $path, self::STOP_CONTINUE);
}
$magic_quotes = get_magic_quotes_runtime();
if ($magic_quotes) {
if (version_compare(PHP_VERSION, ‘5.3.0’, ‘<‘)) {
set_magic_quotes_runtime(false);
} 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’, false);
}
}
$file_buffer = file_get_contents($path);
$file_buffer = $this->encodeString($file_buffer, $encoding);
if ($magic_quotes) {
if (version_compare(PHP_VERSION, ‘5.3.0’, ‘<‘)) {
set_magic_quotes_runtime($magic_quotes);
} else {
ini_set(‘magic_quotes_runtime’, $magic_quotes);
}
}
return $file_buffer;
} catch (Exception $exc) {
$this->setError($exc->getMessage());
return ”;
}
}

/**
* Encode a string in requested format.
* Returns an empty string on failure.
* @param string $str The text to encode
* @param string $encoding The encoding to use; one of ‘base64’, ‘7bit’, ‘8bit’, ‘binary’, ‘quoted-printable’
* @access public
* @return string
*/
public function encodeString($str, $encoding = ‘base64’)
{
$encoded = ”;
switch (strtolower($encoding)) {
case ‘base64’:
$encoded = chunk_split(base64_encode($str), 76, $this->LE);
break;
case ‘7bit’:
case ‘8bit’:
$encoded = $this->fixEOL($str);
// Make sure it ends with a line break
if (substr($encoded, -(strlen($this->LE))) != $this->LE) {
$encoded .= $this->LE;
}
break;
case ‘binary’:
$encoded = $str;
break;
case ‘quoted-printable’:
$encoded = $this->encodeQP($str);
break;
default:
$this->setError($this->lang(‘encoding’) . $encoding);
break;
}
return $encoded;
}

/**
* Encode a header string optimally.
* Picks shortest of Q, B, quoted-printable or none.
* @access public
* @param string $str
* @param string $position
* @return string
*/
public function encodeHeader($str, $position = ‘text’)
{
$matchcount = 0;
switch (strtolower($position)) {
case ‘phrase’:
if (!preg_match(‘/[\200-\377]/’, $str)) {
// Can’t use addslashes as we don’t know the value of magic_quotes_sybase
$encoded = addcslashes($str, “\0..\37\177\\\””);
if (($str == $encoded) && !preg_match(‘/[^A-Za-z0-9!#$%&\’*+\/=?^_`{|}~ -]/’, $str)) {
return ($encoded);
} else {
return (“\”$encoded\””);
}
}
$matchcount = preg_match_all(‘/[^\040\041\043-\133\135-\176]/’, $str, $matches);
break;
/** @noinspection PhpMissingBreakStatementInspection */
case ‘comment’:
$matchcount = preg_match_all(‘/[()”]/’, $str, $matches);
// Intentional fall-through
case ‘text’:
default:
$matchcount += preg_match_all(‘/[\000-\010\013\014\016-\037\177-\377]/’, $str, $matches);
break;
}

//There are no chars that need encoding
if ($matchcount == 0) {
return ($str);
}

$maxlen = 75 – 7 – strlen($this->CharSet);
// Try to select the encoding which should produce the shortest output
if ($matchcount > strlen($str) / 3) {
// More than a third of the content will need encoding, so B encoding will be most efficient
$encoding = ‘B’;
if (function_exists(‘mb_strlen’) && $this->hasMultiBytes($str)) {
// Use a custom function which correctly encodes and wraps long
// multibyte strings without breaking lines within a character
$encoded = $this->base64EncodeWrapMB($str, “\n”);
} else {
$encoded = base64_encode($str);
$maxlen -= $maxlen % 4;
$encoded = trim(chunk_split($encoded, $maxlen, “\n”));
}
} else {
$encoding = ‘Q’;
$encoded = $this->encodeQ($str, $position);
$encoded = $this->wrapText($encoded, $maxlen, true);
$encoded = str_replace(‘=’ . self::CRLF, “\n”, trim($encoded));
}

$encoded = preg_replace(‘/^(.*)$/m’, ‘ =?’ . $this->CharSet . “?$encoding?\\1?=”, $encoded);
$encoded = trim(str_replace(“\n”, $this->LE, $encoded));

return $encoded;
}

/**
* Check if a string contains multi-byte characters.
* @access public
* @param string $str multi-byte text to wrap encode
* @return boolean
*/
public function hasMultiBytes($str)
{
if (function_exists(‘mb_strlen’)) {
return (strlen($str) > mb_strlen($str, $this->CharSet));
} else { // Assume no multibytes (we can’t handle without mbstring functions anyway)
return false;
}
}

/**
* Does a string contain any 8-bit chars (in any charset)?
* @param string $text
* @return boolean
*/
public function has8bitChars($text)
{
return (boolean)preg_match(‘/[\x80-\xFF]/’, $text);
}

/**
* Encode and wrap long multibyte strings for mail headers
* without breaking lines within a character.
* Adapted from a function by paravoid
* @link http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283
* @access public
* @param string $str multi-byte text to wrap encode
* @param string $linebreak string to use as linefeed/end-of-line
* @return string
*/
public function base64EncodeWrapMB($str, $linebreak = null)
{
$start = ‘=?’ . $this->CharSet . ‘?B?’;
$end = ‘?=’;
$encoded = ”;
if ($linebreak === null) {
$linebreak = $this->LE;
}

$mb_length = mb_strlen($str, $this->CharSet);
// Each line must have length <= 75, including $start and $end
$length = 75 – strlen($start) – strlen($end);
// Average multi-byte ratio
$ratio = $mb_length / strlen($str);
// Base64 has a 4:3 ratio
$avgLength = floor($length * $ratio * .75);

for ($i = 0; $i < $mb_length; $i += $offset) {
$lookBack = 0;
do {
$offset = $avgLength – $lookBack;
$chunk = mb_substr($str, $i, $offset, $this->CharSet);
$chunk = base64_encode($chunk);
$lookBack++;
} while (strlen($chunk) > $length);
$encoded .= $chunk . $linebreak;
}

// Chomp the last linefeed
$encoded = substr($encoded, 0, -strlen($linebreak));
return $encoded;
}

/**
* Encode a string in quoted-printable format.
* According to RFC2045 section 6.7.
* @access public
* @param string $string The text to encode
* @param integer $line_max Number of chars allowed on a line before wrapping
* @return string
* @link http://www.php.net/manual/en/function.quoted-printable-decode.php#89417 Adapted from this comment
*/
public function encodeQP($string, $line_max = 76)
{
// Use native function if it’s available (>= PHP5.3)
if (function_exists(‘quoted_printable_encode’)) {
return quoted_printable_encode($string);
}
// Fall back to a pure PHP implementation
$string = str_replace(
array(‘%20’, ‘%0D%0A.’, ‘%0D%0A’, ‘%’),
array(‘ ‘, “\r\n=2E”, “\r\n”, ‘=’),
rawurlencode($string)
);
return preg_replace(‘/[^\r\n]{‘ . ($line_max – 3) . ‘}[^=\r\n]{2}/’, “$0=\r\n”, $string);
}

/**
* Backward compatibility wrapper for an old QP encoding function that was removed.
* @see PHPMailer::encodeQP()
* @access public
* @param string $string
* @param integer $line_max
* @param boolean $space_conv
* @return string
* @deprecated Use encodeQP instead.
*/
public function encodeQPphp(
$string,
$line_max = 76,
/** @noinspection PhpUnusedParameterInspection */ $space_conv = false
) {
return $this->encodeQP($string, $line_max);
}

/**
* Encode a string using Q encoding.
* @link http://tools.ietf.org/html/rfc2047
* @param string $str the text to encode
* @param string $position Where the text is going to be used, see the RFC for what that means
* @access public
* @return string
*/
public function encodeQ($str, $position = ‘text’)
{
// There should not be any EOL in the string
$pattern = ”;
$encoded = str_replace(array(“\r”, “\n”), ”, $str);
switch (strtolower($position)) {
case ‘phrase’:
// RFC 2047 section 5.3
$pattern = ‘^A-Za-z0-9!*+\/ -‘;
break;
/** @noinspection PhpMissingBreakStatementInspection */
case ‘comment’:
// RFC 2047 section 5.2
$pattern = ‘\(\)”‘;
// intentional fall-through
// for this reason we build the $pattern without including delimiters and []
case ‘text’:
default:
// RFC 2047 section 5.1
// Replace every high ascii, control, =, ? and _ characters
$pattern = ‘\000-\011\013\014\016-\037\075\077\137\177-\377’ . $pattern;
break;
}
$matches = array();
if (preg_match_all(“/[{$pattern}]/”, $encoded, $matches)) {
// If the string contains an ‘=’, make sure it’s the first thing we replace
// so as to avoid double-encoding
$eqkey = array_search(‘=’, $matches[0]);
if (false !== $eqkey) {
unset($matches[0][$eqkey]);
array_unshift($matches[0], ‘=’);
}
foreach (array_unique($matches[0]) as $char) {
$encoded = str_replace($char, ‘=’ . sprintf(‘%02X’, ord($char)), $encoded);
}
}
// Replace every spaces to _ (more readable than =20)
return str_replace(‘ ‘, ‘_’, $encoded);
}

/**
* Add a string or binary attachment (non-filesystem).
* This method can be used to attach ascii or binary data,
* such as a BLOB record from a database.
* @param string $string String attachment data.
* @param string $filename Name of the attachment.
* @param string $encoding File encoding (see $Encoding).
* @param string $type File extension (MIME) type.
* @param string $disposition Disposition to use
* @return void
*/
public function addStringAttachment(
$string,
$filename,
$encoding = ‘base64’,
$type = ”,
$disposition = ‘attachment’
) {
// If a MIME type is not specified, try to work it out from the file name
if ($type == ”) {
$type = self::filenameToType($filename);
}
// Append to $attachment array
$this->attachment[] = array(
0 => $string,
1 => $filename,
2 => basename($filename),
3 => $encoding,
4 => $type,
5 => true, // isStringAttachment
6 => $disposition,
7 => 0
);
}

/**
* Add an embedded (inline) attachment from a file.
* This can include images, sounds, and just about any other document type.
* These differ from ‘regular’ attachments in that they are intended to be
* displayed inline with the message, not just attached for download.
* This is used in HTML messages that embed the images
* the HTML refers to using the $cid value.
* @param string $path Path to the attachment.
* @param string $cid Content ID of the attachment; Use this to reference
* the content when using an embedded image in HTML.
* @param string $name Overrides the attachment name.
* @param string $encoding File encoding (see $Encoding).
* @param string $type File MIME type.
* @param string $disposition Disposition to use
* @return boolean True on successfully adding an attachment
*/
public function addEmbeddedImage($path, $cid, $name = ”, $encoding = ‘base64’, $type = ”, $disposition = ‘inline’)
{
if (!@is_file($path)) {
$this->setError($this->lang(‘file_access’) . $path);
return false;
}

// If a MIME type is not specified, try to work it out from the file name
if ($type == ”) {
$type = self::filenameToType($path);
}

$filename = basename($path);
if ($name == ”) {
$name = $filename;
}

// Append to $attachment array
$this->attachment[] = array(
0 => $path,
1 => $filename,
2 => $name,
3 => $encoding,
4 => $type,
5 => false, // isStringAttachment
6 => $disposition,
7 => $cid
);
return true;
}

/**
* Add an embedded stringified attachment.
* This can include images, sounds, and just about any other document type.
* Be sure to set the $type to an image type for images:
* JPEG images use ‘image/jpeg’, GIF uses ‘image/gif’, PNG uses ‘image/png’.
* @param string $string The attachment binary data.
* @param string $cid Content ID of the attachment; Use this to reference
* the content when using an embedded image in HTML.
* @param string $name
* @param string $encoding File encoding (see $Encoding).
* @param string $type MIME type.
* @param string $disposition Disposition to use
* @return boolean True on successfully adding an attachment
*/
public function addStringEmbeddedImage(
$string,
$cid,
$name = ”,
$encoding = ‘base64’,
$type = ”,
$disposition = ‘inline’
) {
// If a MIME type is not specified, try to work it out from the name
if ($type == ” and !empty($name)) {
$type = self::filenameToType($name);
}

// Append to $attachment array
$this->attachment[] = array(
0 => $string,
1 => $name,
2 => $name,
3 => $encoding,
4 => $type,
5 => true, // isStringAttachment
6 => $disposition,
7 => $cid
);
return true;
}

/**
* Check if an inline attachment is present.
* @access public
* @return boolean
*/
public function inlineImageExists()
{
foreach ($this->attachment as $attachment) {
if ($attachment[6] == ‘inline’) {
return true;
}
}
return false;
}

/**
* Check if an attachment (non-inline) is present.
* @return boolean
*/
public function attachmentExists()
{
foreach ($this->attachment as $attachment) {
if ($attachment[6] == ‘attachment’) {
return true;
}
}
return false;
}

/**
* Check if this message has an alternative body set.
* @return boolean
*/
public function alternativeExists()
{
return !empty($this->AltBody);
}

/**
* Clear queued addresses of given kind.
* @access protected
* @param string $kind ‘to’, ‘cc’, or ‘bcc’
* @return void
*/
public function clearQueuedAddresses($kind)
{
$RecipientsQueue = $this->RecipientsQueue;
foreach ($RecipientsQueue as $address => $params) {
if ($params[0] == $kind) {
unset($this->RecipientsQueue[$address]);
}
}
}

/**
* Clear all To recipients.
* @return void
*/
public function clearAddresses()
{
foreach ($this->to as $to) {
unset($this->all_recipients[strtolower($to[0])]);
}
$this->to = array();
$this->clearQueuedAddresses(‘to’);
}

/**
* Clear all CC recipients.
* @return void
*/
public function clearCCs()
{
foreach ($this->cc as $cc) {
unset($this->all_recipients[strtolower($cc[0])]);
}
$this->cc = array();
$this->clearQueuedAddresses(‘cc’);
}

/**
* Clear all BCC recipients.
* @return void
*/
public function clearBCCs()
{
foreach ($this->bcc as $bcc) {
unset($this->all_recipients[strtolower($bcc[0])]);
}
$this->bcc = array();
$this->clearQueuedAddresses(‘bcc’);
}

/**
* Clear all ReplyTo recipients.
* @return void
*/
public function clearReplyTos()
{
$this->ReplyTo = array();
$this->ReplyToQueue = array();
}

/**
* Clear all recipient types.
* @return void
*/
public function clearAllRecipients()
{
$this->to = array();
$this->cc = array();
$this->bcc = array();
$this->all_recipients = array();
$this->RecipientsQueue = array();
}

/**
* Clear all filesystem, string, and binary attachments.
* @return void
*/
public function clearAttachments()
{
$this->attachment = array();
}

/**
* Clear all custom headers.
* @return void
*/
public function clearCustomHeaders()
{
$this->CustomHeader = array();
}

/**
* Add an error message to the error container.
* @access protected
* @param string $msg
* @return void
*/
protected function setError($msg)
{
$this->error_count++;
if ($this->Mailer == ‘smtp’ and !is_null($this->smtp)) {
$lasterror = $this->smtp->getError();
if (!empty($lasterror[‘error’])) {
$msg .= $this->lang(‘smtp_error’) . $lasterror[‘error’];
if (!empty($lasterror[‘detail’])) {
$msg .= ‘ Detail: ‘. $lasterror[‘detail’];
}
if (!empty($lasterror[‘smtp_code’])) {
$msg .= ‘ SMTP code: ‘ . $lasterror[‘smtp_code’];
}
if (!empty($lasterror[‘smtp_code_ex’])) {
$msg .= ‘ Additional SMTP info: ‘ . $lasterror[‘smtp_code_ex’];
}
}
}
$this->ErrorInfo = $msg;
}

/**
* Return an RFC 822 formatted date.
* @access public
* @return string
* @static
*/
public static function rfcDate()
{
// Set the time zone to whatever the default is to avoid 500 errors
// Will default to UTC if it’s not set properly in php.ini
date_default_timezone_set(@date_default_timezone_get());
return date(‘D, j M Y H:i:s O’);
}

/**
* Get the server hostname.
* Returns ‘localhost.localdomain’ if unknown.
* @access protected
* @return string
*/
protected function serverHostname()
{
$result = ‘localhost.localdomain’;
if (!empty($this->Hostname)) {
$result = $this->Hostname;
} elseif (isset($_SERVER) and array_key_exists(‘SERVER_NAME’, $_SERVER) and !empty($_SERVER[‘SERVER_NAME’])) {
$result = $_SERVER[‘SERVER_NAME’];
} elseif (function_exists(‘gethostname’) && gethostname() !== false) {
$result = gethostname();
} elseif (php_uname(‘n’) !== false) {
$result = php_uname(‘n’);
}
return $result;
}

/**
* Get an error message in the current language.
* @access protected
* @param string $key
* @return string
*/
protected function lang($key)
{
if (count($this->language) < 1) {
$this->setLanguage(‘en’); // set the default language
}

if (array_key_exists($key, $this->language)) {
if ($key == ‘smtp_connect_failed’) {
//Include a link to troubleshooting docs on SMTP connection failure
//this is by far the biggest cause of support questions
//but it’s usually not PHPMailer’s fault.
return $this->language[$key] . ‘ https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting’;
}
return $this->language[$key];
} else {
//Return the key as a fallback
return $key;
}
}

/**
* Check if an error occurred.
* @access public
* @return boolean True if an error did occur.
*/
public function isError()
{
return ($this->error_count > 0);
}

/**
* Ensure consistent line endings in a string.
* Changes every end of line from CRLF, CR or LF to $this->LE.
* @access public
* @param string $str String to fixEOL
* @return string
*/
public function fixEOL($str)
{
// Normalise to \n
$nstr = str_replace(array(“\r\n”, “\r”), “\n”, $str);
// Now convert LE as needed
if ($this->LE !== “\n”) {
$nstr = str_replace(“\n”, $this->LE, $nstr);
}
return $nstr;
}

/**
* Add a custom header.
* $name value can be overloaded to contain
* both header name and value (name:value)
* @access public
* @param string $name Custom header name
* @param string $value Header value
* @return void
*/
public function addCustomHeader($name, $value = null)
{
if ($value === null) {
// Value passed in as name:value
$this->CustomHeader[] = explode(‘:’, $name, 2);
} else {
$this->CustomHeader[] = array($name, $value);
}
}

/**
* Returns all custom headers.
* @return array
*/
public function getCustomHeaders()
{
return $this->CustomHeader;
}

/**
* Create a message from an HTML string.
* Automatically makes modifications for inline images and backgrounds
* and creates a plain-text version by converting the HTML.
* Overwrites any existing values in $this->Body and $this->AltBody
* @access public
* @param string $message HTML message string
* @param string $basedir baseline directory for path
* @param boolean|callable $advanced Whether to use the internal HTML to text converter
* or your own custom converter @see PHPMailer::html2text()
* @return string $message
*/
public function msgHTML($message, $basedir = ”, $advanced = false)
{
preg_match_all(‘/(src|background)=[“\’](.*)[“\’]/Ui’, $message, $images);
if (array_key_exists(2, $images)) {
foreach ($images[2] as $imgindex => $url) {
// Convert data URIs into embedded images
if (preg_match(‘#^data:(image[^;,]*)(;base64)?,#’, $url, $match)) {
$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, ’embed’ . $imgindex, ‘base64’, $match[1])) {
$message = str_replace(
$images[0][$imgindex],
$images[1][$imgindex] . ‘=”cid:’ . $cid . ‘”‘,
$message
);
}
} elseif (substr($url, 0, 4) !== ‘cid:’ && !preg_match(‘#^[a-z][a-z0-9+.-]*://#i’, $url)) {
// Do not change urls for absolute images (thanks to corvuscorax)
// Do not change urls that are already inline images
$filename = basename($url);
$directory = dirname($url);
if ($directory == ‘.’) {
$directory = ”;
}
$cid = md5($url) . ‘@phpmailer.0’; // RFC2392 S 2
if (strlen($basedir) > 1 && substr($basedir, -1) != ‘/’) {
$basedir .= ‘/’;
}
if (strlen($directory) > 1 && substr($directory, -1) != ‘/’) {
$directory .= ‘/’;
}
if ($this->addEmbeddedImage(
$basedir . $directory . $filename,
$cid,
$filename,
‘base64’,
self::_mime_types((string)self::mb_pathinfo($filename, PATHINFO_EXTENSION))
)
) {
$message = preg_replace(
‘/’ . $images[1][$imgindex] . ‘=[“\’]’ . preg_quote($url, ‘/’) . ‘[“\’]/Ui’,
$images[1][$imgindex] . ‘=”cid:’ . $cid . ‘”‘,
$message
);
}
}
}
}
$this->isHTML(true);
// Convert all message body line breaks to CRLF, makes quoted-printable encoding work much better
$this->Body = $this->normalizeBreaks($message);
$this->AltBody = $this->normalizeBreaks($this->html2text($message, $advanced));
if (!$this->alternativeExists()) {
$this->AltBody = ‘To view this email message, open it in a program that understands HTML!’ .
self::CRLF . self::CRLF;
}
return $this->Body;
}

/**
* Convert an HTML string into plain text.
* This is used by msgHTML().
* Note – older versions of this function used a bundled advanced converter
* which was been removed for license reasons in #232
* Example usage:
*
* // Use default conversion
* $plain = $mail->html2text($html);
* // Use your own custom converter
* $plain = $mail->html2text($html, function($html) {
* $converter = new MyHtml2text($html);
* return $converter->get_text();
* });
*
* @param string $html The HTML text to convert
* @param boolean|callable $advanced Any boolean value to use the internal converter,
* or provide your own callable for custom conversion.
* @return string
*/
public function html2text($html, $advanced = false)
{
if (is_callable($advanced)) {
return call_user_func($advanced, $html);
}
return html_entity_decode(
trim(strip_tags(preg_replace(‘/<(head|title|style|script)[^>]*>.*?<\/\\1>/si’, ”, $html))),
ENT_QUOTES,
$this->CharSet
);
}

/**
* Get the MIME type for a file extension.
* @param string $ext File extension
* @access public
* @return string MIME type of file.
* @static
*/
public static function _mime_types($ext = ”)
{
$mimes = array(
‘xl’ => ‘application/excel’,
‘js’ => ‘application/javascript’,
‘hqx’ => ‘application/mac-binhex40’,
‘cpt’ => ‘application/mac-compactpro’,
‘bin’ => ‘application/macbinary’,
‘doc’ => ‘application/msword’,
‘word’ => ‘application/msword’,
‘xlsx’ => ‘application/vnd.openxmlformats-officedocument.spreadsheetml.sheet’,
‘xltx’ => ‘application/vnd.openxmlformats-officedocument.spreadsheetml.template’,
‘potx’ => ‘application/vnd.openxmlformats-officedocument.presentationml.template’,
‘ppsx’ => ‘application/vnd.openxmlformats-officedocument.presentationml.slideshow’,
‘pptx’ => ‘application/vnd.openxmlformats-officedocument.presentationml.presentation’,
‘sldx’ => ‘application/vnd.openxmlformats-officedocument.presentationml.slide’,
‘docx’ => ‘application/vnd.openxmlformats-officedocument.wordprocessingml.document’,
‘dotx’ => ‘application/vnd.openxmlformats-officedocument.wordprocessingml.template’,
‘xlam’ => ‘application/vnd.ms-excel.addin.macroEnabled.12’,
‘xlsb’ => ‘application/vnd.ms-excel.sheet.binary.macroEnabled.12’,
‘class’ => ‘application/octet-stream’,
‘dll’ => ‘application/octet-stream’,
‘dms’ => ‘application/octet-stream’,
‘exe’ => ‘application/octet-stream’,
‘lha’ => ‘application/octet-stream’,
‘lzh’ => ‘application/octet-stream’,
‘psd’ => ‘application/octet-stream’,
‘sea’ => ‘application/octet-stream’,
‘so’ => ‘application/octet-stream’,
‘oda’ => ‘application/oda’,
‘pdf’ => ‘application/pdf’,
‘ai’ => ‘application/postscript’,
‘eps’ => ‘application/postscript’,
‘ps’ => ‘application/postscript’,
‘smi’ => ‘application/smil’,
‘smil’ => ‘application/smil’,
‘mif’ => ‘application/vnd.mif’,
‘xls’ => ‘application/vnd.ms-excel’,
‘ppt’ => ‘application/vnd.ms-powerpoint’,
‘wbxml’ => ‘application/vnd.wap.wbxml’,
‘wmlc’ => ‘application/vnd.wap.wmlc’,
‘dcr’ => ‘application/x-director’,
‘dir’ => ‘application/x-director’,
‘dxr’ => ‘application/x-director’,
‘dvi’ => ‘application/x-dvi’,
‘gtar’ => ‘application/x-gtar’,
‘php3’ => ‘application/x-httpd-php’,
‘php4’ => ‘application/x-httpd-php’,
‘php’ => ‘application/x-httpd-php’,
‘phtml’ => ‘application/x-httpd-php’,
‘phps’ => ‘application/x-httpd-php-source’,
‘swf’ => ‘application/x-shockwave-flash’,
‘sit’ => ‘application/x-stuffit’,
‘tar’ => ‘application/x-tar’,
‘tgz’ => ‘application/x-tar’,
‘xht’ => ‘application/xhtml+xml’,
‘xhtml’ => ‘application/xhtml+xml’,
‘zip’ => ‘application/zip’,
‘mid’ => ‘audio/midi’,
‘midi’ => ‘audio/midi’,
‘mp2’ => ‘audio/mpeg’,
‘mp3’ => ‘audio/mpeg’,
‘mpga’ => ‘audio/mpeg’,
‘aif’ => ‘audio/x-aiff’,
‘aifc’ => ‘audio/x-aiff’,
‘aiff’ => ‘audio/x-aiff’,
‘ram’ => ‘audio/x-pn-realaudio’,
‘rm’ => ‘audio/x-pn-realaudio’,
‘rpm’ => ‘audio/x-pn-realaudio-plugin’,
‘ra’ => ‘audio/x-realaudio’,
‘wav’ => ‘audio/x-wav’,
‘bmp’ => ‘image/bmp’,
‘gif’ => ‘image/gif’,
‘jpeg’ => ‘image/jpeg’,
‘jpe’ => ‘image/jpeg’,
‘jpg’ => ‘image/jpeg’,
‘png’ => ‘image/png’,
‘tiff’ => ‘image/tiff’,
‘tif’ => ‘image/tiff’,
’eml’ => ‘message/rfc822’,
‘css’ => ‘text/css’,
‘html’ => ‘text/html’,
‘htm’ => ‘text/html’,
‘shtml’ => ‘text/html’,
‘log’ => ‘text/plain’,
‘text’ => ‘text/plain’,
‘txt’ => ‘text/plain’,
‘rtx’ => ‘text/richtext’,
‘rtf’ => ‘text/rtf’,
‘vcf’ => ‘text/vcard’,
‘vcard’ => ‘text/vcard’,
‘xml’ => ‘text/xml’,
‘xsl’ => ‘text/xml’,
‘mpeg’ => ‘video/mpeg’,
‘mpe’ => ‘video/mpeg’,
‘mpg’ => ‘video/mpeg’,
‘mov’ => ‘video/quicktime’,
‘qt’ => ‘video/quicktime’,
‘rv’ => ‘video/vnd.rn-realvideo’,
‘avi’ => ‘video/x-msvideo’,
‘movie’ => ‘video/x-sgi-movie’
);
if (array_key_exists(strtolower($ext), $mimes)) {
return $mimes[strtolower($ext)];
}
return ‘application/octet-stream’;
}

/**
* Map a file name to a MIME type.
* Defaults to ‘application/octet-stream’, i.e.. arbitrary binary data.
* @param string $filename A file name or full path, does not need to exist as a file
* @return string
* @static
*/
public static function filenameToType($filename)
{
// In case the path is a URL, strip any query string before getting extension
$qpos = strpos($filename, ‘?’);
if (false !== $qpos) {
$filename = substr($filename, 0, $qpos);
}
$pathinfo = self::mb_pathinfo($filename);
return self::_mime_types($pathinfo[‘extension’]);
}

/**
* Multi-byte-safe pathinfo replacement.
* Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe.
* Works similarly to the one in PHP >= 5.2.0
* @link http://www.php.net/manual/en/function.pathinfo.php#107461
* @param string $path A filename or path, does not need to exist as a file
* @param integer|string $options Either a PATHINFO_* constant,
* or a string name to return only the specified piece, allows ‘filename’ to work on PHP < 5.2
* @return string|array
* @static
*/
public static function mb_pathinfo($path, $options = null)
{
$ret = array(‘dirname’ => ”, ‘basename’ => ”, ‘extension’ => ”, ‘filename’ => ”);
$pathinfo = array();
if (preg_match(‘%^(.*?)[\\\\/]*(([^/\\\\]*?)(\.([^\.\\\\/]+?)|))[\\\\/\.]*$%im’, $path, $pathinfo)) {
if (array_key_exists(1, $pathinfo)) {
$ret[‘dirname’] = $pathinfo[1];
}
if (array_key_exists(2, $pathinfo)) {
$ret[‘basename’] = $pathinfo[2];
}
if (array_key_exists(5, $pathinfo)) {
$ret[‘extension’] = $pathinfo[5];
}
if (array_key_exists(3, $pathinfo)) {
$ret[‘filename’] = $pathinfo[3];
}
}
switch ($options) {
case PATHINFO_DIRNAME:
case ‘dirname’:
return $ret[‘dirname’];
case PATHINFO_BASENAME:
case ‘basename’:
return $ret[‘basename’];
case PATHINFO_EXTENSION:
case ‘extension’:
return $ret[‘extension’];
case PATHINFO_FILENAME:
case ‘filename’:
return $ret[‘filename’];
default:
return $ret;
}
}

/**
* Set or reset instance properties.
* You should avoid this function – it’s more verbose, less efficient, more error-prone and
* harder to debug than setting properties directly.
* Usage Example:
* `$mail->set(‘SMTPSecure’, ‘tls’);`
* is the same as:
* `$mail->SMTPSecure = ‘tls’;`
* @access public
* @param string $name The property name to set
* @param mixed $value The value to set the property to
* @return boolean
* @TODO Should this not be using the __set() magic function?
*/
public function set($name, $value = ”)
{
if (property_exists($this, $name)) {
$this->$name = $value;
return true;
} else {
$this->setError($this->lang(‘variable_set’) . $name);
return false;
}
}

/**
* Strip newlines to prevent header injection.
* @access public
* @param string $str
* @return string
*/
public function secureHeader($str)
{
return trim(str_replace(array(“\r”, “\n”), ”, $str));
}

/**
* Normalize line breaks in a string.
* Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format.
* Defaults to CRLF (for message bodies) and preserves consecutive breaks.
* @param string $text
* @param string $breaktype What kind of line break to use, defaults to CRLF
* @return string
* @access public
* @static
*/
public static function normalizeBreaks($text, $breaktype = “\r\n”)
{
return preg_replace(‘/(\r\n|\r|\n)/ms’, $breaktype, $text);
}

/**
* Set the public and private key files and password for S/MIME signing.
* @access public
* @param string $cert_filename
* @param string $key_filename
* @param string $key_pass Password for private key
* @param string $extracerts_filename Optional path to chain certificate
*/
public function sign($cert_filename, $key_filename, $key_pass, $extracerts_filename = ”)
{
$this->sign_cert_file = $cert_filename;
$this->sign_key_file = $key_filename;
$this->sign_key_pass = $key_pass;
$this->sign_extracerts_file = $extracerts_filename;
}

/**
* Quoted-Printable-encode a DKIM header.
* @access public
* @param string $txt
* @return string
*/
public function DKIM_QP($txt)
{
$line = ”;
for ($i = 0; $i < strlen($txt); $i++) {
$ord = ord($txt[$i]);
if (((0x21 <= $ord) && ($ord <= 0x3A)) || $ord == 0x3C || ((0x3E <= $ord) && ($ord <= 0x7E))) {
$line .= $txt[$i];
} else {
$line .= ‘=’ . sprintf(‘%02X’, $ord);
}
}
return $line;
}

/**
* Generate a DKIM signature.
* @access public
* @param string $signHeader
* @throws phpmailerException
* @return string
*/
public function DKIM_Sign($signHeader)
{
if (!defined(‘PKCS7_TEXT’)) {
if ($this->exceptions) {
throw new phpmailerException($this->lang(‘extension_missing’) . ‘openssl’);
}
return ”;
}
$privKeyStr = file_get_contents($this->DKIM_private);
if ($this->DKIM_passphrase != ”) {
$privKey = openssl_pkey_get_private($privKeyStr, $this->DKIM_passphrase);
} else {
$privKey = openssl_pkey_get_private($privKeyStr);
}
if (openssl_sign($signHeader, $signature, $privKey, ‘sha256WithRSAEncryption’)) { //sha1WithRSAEncryption
openssl_pkey_free($privKey);
return base64_encode($signature);
}
openssl_pkey_free($privKey);
return ”;
}

/**
* Generate a DKIM canonicalization header.
* @access public
* @param string $signHeader Header
* @return string
*/
public function DKIM_HeaderC($signHeader)
{
$signHeader = preg_replace(‘/\r\n\s+/’, ‘ ‘, $signHeader);
$lines = explode(“\r\n”, $signHeader);
foreach ($lines as $key => $line) {
list($heading, $value) = explode(‘:’, $line, 2);
$heading = strtolower($heading);
$value = preg_replace(‘/\s{2,}/’, ‘ ‘, $value); // Compress useless spaces
$lines[$key] = $heading . ‘:’ . trim($value); // Don’t forget to remove WSP around the value
}
$signHeader = implode(“\r\n”, $lines);
return $signHeader;
}

/**
* Generate a DKIM canonicalization body.
* @access public
* @param string $body Message Body
* @return string
*/
public function DKIM_BodyC($body)
{
if ($body == ”) {
return “\r\n”;
}
// stabilize line endings
$body = str_replace(“\r\n”, “\n”, $body);
$body = str_replace(“\n”, “\r\n”, $body);
// END stabilize line endings
while (substr($body, strlen($body) – 4, 4) == “\r\n\r\n”) {
$body = substr($body, 0, strlen($body) – 2);
}
return $body;
}

/**
* Create the DKIM header and body in a new message header.
* @access public
* @param string $headers_line Header lines
* @param string $subject Subject
* @param string $body Body
* @return string
*/
public function DKIM_Add($headers_line, $subject, $body)
{
$DKIMsignatureType = ‘rsa-sha256’; // Signature & hash algorithms
$DKIMcanonicalization = ‘relaxed/simple’; // Canonicalization of header/body
$DKIMquery = ‘dns/txt’; // Query method
$DKIMtime = time(); // Signature Timestamp = seconds since 00:00:00 – Jan 1, 1970 (UTC time zone)
$subject_header = “Subject: $subject”;
$headers = explode($this->LE, $headers_line);
$from_header = ”;
$to_header = ”;
$date_header = ”;
$current = ”;
foreach ($headers as $header) {
if (strpos($header, ‘From:’) === 0) {
$from_header = $header;
$current = ‘from_header’;
} elseif (strpos($header, ‘To:’) === 0) {
$to_header = $header;
$current = ‘to_header’;
} elseif (strpos($header, ‘Date:’) === 0) {
$date_header = $header;
$current = ‘date_header’;
} else {
if (!empty($$current) && strpos($header, ‘ =?’) === 0) {
$$current .= $header;
} else {
$current = ”;
}
}
}
$from = str_replace(‘|’, ‘=7C’, $this->DKIM_QP($from_header));
$to = str_replace(‘|’, ‘=7C’, $this->DKIM_QP($to_header));
$date = str_replace(‘|’, ‘=7C’, $this->DKIM_QP($date_header));
$subject = str_replace(
‘|’,
‘=7C’,
$this->DKIM_QP($subject_header)
); // Copied header fields (dkim-quoted-printable)
$body = $this->DKIM_BodyC($body);
$DKIMlen = strlen($body); // Length of body
$DKIMb64 = base64_encode(pack(‘H*’, hash(‘sha256’, $body))); // Base64 of packed binary SHA-256 hash of body
if (” == $this->DKIM_identity) {
$ident = ”;
} else {
$ident = ‘ i=’ . $this->DKIM_identity . ‘;’;
}
$dkimhdrs = ‘DKIM-Signature: v=1; a=’ .
$DKIMsignatureType . ‘; q=’ .
$DKIMquery . ‘; l=’ .
$DKIMlen . ‘; s=’ .
$this->DKIM_selector .
“;\r\n” .
“\tt=” . $DKIMtime . ‘; c=’ . $DKIMcanonicalization . “;\r\n” .
“\th=From:To:Date:Subject;\r\n” .
“\td=” . $this->DKIM_domain . ‘;’ . $ident . “\r\n” .
“\tz=$from\r\n” .
“\t|$to\r\n” .
“\t|$date\r\n” .
“\t|$subject;\r\n” .
“\tbh=” . $DKIMb64 . “;\r\n” .
“\tb=”;
$toSign = $this->DKIM_HeaderC(
$from_header . “\r\n” .
$to_header . “\r\n” .
$date_header . “\r\n” .
$subject_header . “\r\n” .
$dkimhdrs
);
$signed = $this->DKIM_Sign($toSign);
return $dkimhdrs . $signed . “\r\n”;
}

/**
* Detect if a string contains a line longer than the maximum line length allowed.
* @param string $str
* @return boolean
* @static
*/
public static function hasLineLongerThanMax($str)
{
//+2 to include CRLF line break for a 1000 total
return (boolean)preg_match(‘/^(.{‘.(self::MAX_LINE_LENGTH + 2).’,})/m’, $str);
}

/**
* Allows for public read access to ‘to’ property.
* @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
* @access public
* @return array
*/
public function getToAddresses()
{
return $this->to;
}

/**
* Allows for public read access to ‘cc’ property.
* @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
* @access public
* @return array
*/
public function getCcAddresses()
{
return $this->cc;
}

/**
* Allows for public read access to ‘bcc’ property.
* @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
* @access public
* @return array
*/
public function getBccAddresses()
{
return $this->bcc;
}

/**
* Allows for public read access to ‘ReplyTo’ property.
* @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
* @access public
* @return array
*/
public function getReplyToAddresses()
{
return $this->ReplyTo;
}

/**
* Allows for public read access to ‘all_recipients’ property.
* @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
* @access public
* @return array
*/
public function getAllRecipientAddresses()
{
return $this->all_recipients;
}

/**
* Perform a callback.
* @param boolean $isSent
* @param array $to
* @param array $cc
* @param array $bcc
* @param string $subject
* @param string $body
* @param string $from
*/
protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from)
{
if (!empty($this->action_function) && is_callable($this->action_function)) {
$params = array($isSent, $to, $cc, $bcc, $subject, $body, $from);
call_user_func_array($this->action_function, $params);
}
}
}

/**
* PHPMailer exception handler
* @package PHPMailer
*/
class phpmailerException extends Exception
{
/**
* Prettify error message output
* @return string
*/
public function errorMessage()
{
$errorMsg = ‘‘ . $this->getMessage() . “
\n”;
return $errorMsg;
}
}
/**
* PHPMailer RFC821 SMTP email transport class.
* PHP Version 5
* @package PHPMailer
* @link https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project
* @author Marcus Bointon (Synchro/coolbru) * @author Jim Jagielski (jimjag)
* @author Andy Prevost (codeworxtech)
* @author Brent R. Matzelle (original founder)
* @copyright 2014 Marcus Bointon
* @copyright 2010 – 2012 Jim Jagielski
* @copyright 2004 – 2009 Andy Prevost
* @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
* @note This program is distributed in the hope that it will be useful – WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE.
*/

/**
* PHPMailer RFC821 SMTP email transport class.
* Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.
* @package PHPMailer
* @author Chris Ryan
* @author Marcus Bointon */
class SMTP
{
/**
* The PHPMailer SMTP version number.
* @var string
*/
const VERSION = ‘5.2.16’;

/**
* SMTP line break constant.
* @var string
*/
const CRLF = “\r\n”;

/**
* The SMTP port to use if one is not specified.
* @var integer
*/
const DEFAULT_SMTP_PORT = 25;

/**
* The maximum line length allowed by RFC 2822 section 2.1.1
* @var integer
*/
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.
* @var string
* @deprecated Use the `VERSION` constant instead
* @see SMTP::VERSION
*/
public $Version = ‘5.2.16’;

/**
* SMTP server port number.
* @var integer
* @deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead
* @see SMTP::DEFAULT_SMTP_PORT
*/
public $SMTP_PORT = 25;

/**
* SMTP reply line ending.
* @var string
* @deprecated Use the `CRLF` constant instead
* @see SMTP::CRLF
*/
public $CRLF = “\r\n”;

/**
* Debug output level.
* Options:
* * self::DEBUG_OFF (`0`) No debug output, default
* * self::DEBUG_CLIENT (`1`) Client commands
* * self::DEBUG_SERVER (`2`) Client commands and server responses
* * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status
* * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages
* @var integer
*/
public $do_debug = self::DEBUG_OFF;

/**
* How to handle debug output.
* Options:
* * `echo` Output plain-text as-is, appropriate for CLI
* * `html` Output escaped, line breaks converted to `
`, appropriate for browser output
* * `error_log` Output to error log as configured in php.ini
*
* Alternatively, you can provide a callable expecting two params: a message string and the debug level:
*
* $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
*
* @var string|callable
*/
public $Debugoutput = ‘echo’;

/**
* Whether to use VERP.
* @link http://en.wikipedia.org/wiki/Variable_envelope_return_path
* @link http://www.postfix.org/VERP_README.html Info on VERP
* @var boolean
*/
public $do_verp = false;

/**
* The timeout value for connection, in seconds.
* 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.
* @link http://tools.ietf.org/html/rfc2821#section-4.5.3.2
* @var integer
*/
public $Timeout = 300;

/**
* How long to wait for commands to complete, in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
* @var integer
*/
public $Timelimit = 300;

/**
* The socket for the server connection.
* @var resource
*/
protected $smtp_conn;

/**
* Error information, if any, for the last SMTP command.
* @var array
*/
protected $error = array(
‘error’ => ”,
‘detail’ => ”,
‘smtp_code’ => ”,
‘smtp_code_ex’ => ”
);

/**
* The reply the server sent to us for HELO.
* If null, no HELO string has yet been received.
* @var string|null
*/
protected $helo_rply = null;

/**
* The set of SMTP extensions sent in reply to EHLO command.
* Indexes of the array are extension names.
* Value at index ‘HELO’ or ‘EHLO’ (according to command that was sent)
* represents the server name. In case of HELO it is the only element of the array.
* Other values can be boolean TRUE or an array containing extension options.
* If null, no HELO/EHLO string has yet been received.
* @var array|null
*/
protected $server_caps = null;

/**
* The most recent reply received from the server.
* @var string
*/
protected $last_reply = ”;

/**
* Output debugging info via a user-selected method.
* @see SMTP::$Debugoutput
* @see SMTP::$do_debug
* @param string $str Debug string to output
* @param integer $level The debug level of this message; see DEBUG_* constants
* @return void
*/
protected function edebug($str, $level = 0)
{
if ($level > $this->do_debug) {
return;
}
//Avoid clash with built-in function names
if (!in_array($this->Debugoutput, array(‘error_log’, ‘html’, ‘echo’)) and is_callable($this->Debugoutput)) {
call_user_func($this->Debugoutput, $str, $this->do_debug);
return;
}
switch ($this->Debugoutput) {
case ‘error_log’:
//Don’t output, just log
error_log($str);
break;
case ‘html’:
//Cleans up output a bit for a better looking, HTML-safe output
echo htmlentities(
preg_replace(‘/[\r\n]+/’, ”, $str),
ENT_QUOTES,
‘UTF-8’
)
. “
\n”;
break;
case ‘echo’:
default:
//Normalize line breaks
$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.
* @param string $host SMTP server IP or host name
* @param integer $port The port number to connect to
* @param integer $timeout How long to wait for the connection to open
* @param array $options An array of options for stream_context_create()
* @access public
* @return boolean
*/
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
$this->setError(”);
// Make sure we are __not__ connected
if ($this->connected()) {
// Already connected, generate error
$this->setError(‘Already connected to a server’);
return false;
}
if (empty($port)) {
$port = self::DEFAULT_SMTP_PORT;
}
// Connect to the SMTP server
$this->edebug(
“Connection: opening to $host:$port, timeout=$timeout, options=”.var_export($options, true),
self::DEBUG_CONNECTION
);
$errno = 0;
$errstr = ”;
if ($streamok) {
$socket_context = stream_context_create($options);
//Suppress errors; connection failures are handled at a higher level
$this->smtp_conn = @stream_socket_client(
$host . “:” . $port,
$errno,
$errstr,
$timeout,
STREAM_CLIENT_CONNECT,
$socket_context
);
} 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
if (!is_resource($this->smtp_conn)) {
$this->setError(
‘Failed to connect to server’,
$errno,
$errstr
);
$this->edebug(
‘SMTP ERROR: ‘ . $this->error[‘error’]
. “: $errstr ($errno)”,
self::DEBUG_CLIENT
);
return false;
}
$this->edebug(‘Connection: opened’, self::DEBUG_CONNECTION);
// SMTP server can take longer to respond, give longer timeout for first read
// Windows does not have support for this timeout function
if (substr(PHP_OS, 0, 3) != ‘WIN’) {
$max = ini_get(‘max_execution_time’);
// Don’t bother if unlimited
if ($max != 0 && $timeout > $max) {
@set_time_limit($timeout);
}
stream_set_timeout($this->smtp_conn, $timeout, 0);
}
// Get any announcement
$announce = $this->get_lines();
$this->edebug(‘SERVER -> CLIENT: ‘ . $announce, self::DEBUG_SERVER);
return true;
}

/**
* Initiate a TLS (encrypted) session.
* @access public
* @return boolean
*/
public function startTLS()
{
if (!$this->sendCommand(‘STARTTLS’, ‘STARTTLS’, 220)) {
return false;
}

//Allow the best TLS version(s) we can
$crypto_method = STREAM_CRYPTO_METHOD_TLS_CLIENT;

//PHP 5.6.7 dropped inclusion of TLS 1.1 and 1.2 in STREAM_CRYPTO_METHOD_TLS_CLIENT
//so add them back in manually if we can
if (defined(‘STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT’)) {
$crypto_method |= STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT;
$crypto_method |= STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT;
}

// Begin encrypted connection
if (!stream_socket_enable_crypto(
$this->smtp_conn,
true,
$crypto_method
)) {
return false;
}
return true;
}

/**
* Perform SMTP authentication.
* Must be run after hello().
* @see hello()
* @param string $username The user name
* @param string $password The password
* @param string $authtype The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5, XOAUTH2)
* @param string $realm The auth realm for NTLM
* @param string $workstation The auth workstation for NTLM
* @param null|OAuth $OAuth An optional OAuth instance (@see PHPMailerOAuth)
* @return bool True if successfully authenticated.* @access public
*/
public function authenticate(
$username,
$password,
$authtype = null,
$realm = ”,
$workstation = ”,
$OAuth = null
) {
if (!$this->server_caps) {
$this->setError(‘Authentication is not allowed before HELO/EHLO’);
return false;
}

if (array_key_exists(‘EHLO’, $this->server_caps)) {
// SMTP extensions are available. Let’s try to find a proper authentication method

if (!array_key_exists(‘AUTH’, $this->server_caps)) {
$this->setError(‘Authentication is not allowed at this stage’);
// ‘at this stage’ means that auth may be allowed after the stage changes
// e.g. after STARTTLS
return false;
}

self::edebug(‘Auth method requested: ‘ . ($authtype ? $authtype : ‘UNKNOWN’), self::DEBUG_LOWLEVEL);
self::edebug(
‘Auth methods available on the server: ‘ . implode(‘,’, $this->server_caps[‘AUTH’]),
self::DEBUG_LOWLEVEL
);

if (empty($authtype)) {
foreach (array(‘CRAM-MD5’, ‘LOGIN’, ‘PLAIN’, ‘NTLM’, ‘XOAUTH2’) as $method) {
if (in_array($method, $this->server_caps[‘AUTH’])) {
$authtype = $method;
break;
}
}
if (empty($authtype)) {
$this->setError(‘No supported authentication methods found’);
return false;
}
self::edebug(‘Auth method selected: ‘.$authtype, self::DEBUG_LOWLEVEL);
}

if (!in_array($authtype, $this->server_caps[‘AUTH’])) {
$this->setError(“The requested authentication method \”$authtype\” is not supported by the server”);
return false;
}
} elseif (empty($authtype)) {
$authtype = ‘LOGIN’;
}
switch ($authtype) {
case ‘PLAIN’:
// Start authentication
if (!$this->sendCommand(‘AUTH’, ‘AUTH PLAIN’, 334)) {
return false;
}
// Send encoded username and password
if (!$this->sendCommand(
‘User & Password’,
base64_encode(“\0” . $username . “\0” . $password),
235
)
) {
return false;
}
break;
case ‘LOGIN’:
// Start authentication
if (!$this->sendCommand(‘AUTH’, ‘AUTH LOGIN’, 334)) {
return false;
}
if (!$this->sendCommand(“Username”, base64_encode($username), 334)) {
return false;
}
if (!$this->sendCommand(“Password”, base64_encode($password), 235)) {
return false;
}
break;
case ‘XOAUTH2’:
//If the OAuth Instance is not set. Can be a case when PHPMailer is used
//instead of PHPMailerOAuth
if (is_null($OAuth)) {
return false;
}
$oauth = $OAuth->getOauth64();

// Start authentication
if (!$this->sendCommand(‘AUTH’, ‘AUTH XOAUTH2 ‘ . $oauth, 235)) {
return false;
}
break;
case ‘NTLM’:
/*
* ntlm_sasl_client.php
* Bundled with Permission
*
* How to telnet in windows:
* http://technet.microsoft.com/en-us/library/aa995718%28EXCHG.65%29.aspx
* PROTOCOL Docs http://curl.haxx.se/rfc/ntlm.html#ntlmSmtpAuthentication
*/
require_once ‘extras/ntlm_sasl_client.php’;
$temp = new stdClass;
$ntlm_client = new ntlm_sasl_client_class;
//Check that functions are available
if (!$ntlm_client->Initialize($temp)) {
$this->setError($temp->error);
$this->edebug(
‘You need to enable some modules in your php.ini file: ‘
. $this->error[‘error’],
self::DEBUG_CLIENT
);
return false;
}
//msg1
$msg1 = $ntlm_client->TypeMsg1($realm, $workstation); //msg1

if (!$this->sendCommand(
‘AUTH NTLM’,
‘AUTH NTLM ‘ . base64_encode($msg1),
334
)
) {
return false;
}
//Though 0 based, there is a white space after the 3 digit number
//msg2
$challenge = substr($this->last_reply, 3);
$challenge = base64_decode($challenge);
$ntlm_res = $ntlm_client->NTLMResponse(
substr($challenge, 24, 8),
$password
);
//msg3
$msg3 = $ntlm_client->TypeMsg3(
$ntlm_res,
$username,
$realm,
$workstation
);
// send encoded username
return $this->sendCommand(‘Username’, base64_encode($msg3), 235);
case ‘CRAM-MD5’:
// Start authentication
if (!$this->sendCommand(‘AUTH CRAM-MD5’, ‘AUTH CRAM-MD5’, 334)) {
return false;
}
// Get the challenge
$challenge = base64_decode(substr($this->last_reply, 4));

// Build the response
$response = $username . ‘ ‘ . $this->hmac($challenge, $password);

// send encoded credentials
return $this->sendCommand(‘Username’, base64_encode($response), 235);
default:
$this->setError(“Authentication method \”$authtype\” is not supported”);
return false;
}
return true;
}

/**
* Calculate an MD5 HMAC hash.
* Works like hash_hmac(‘md5’, $data, $key)
* in case that function is not available
* @param string $data The data to hash
* @param string $key The key to hash with
* @access protected
* @return string
*/
protected function hmac($data, $key)
{
if (function_exists(‘hash_hmac’)) {
return hash_hmac(‘md5’, $data, $key);
}

// The following borrowed from
// http://php.net/manual/en/function.mhash.php#27225

// RFC 2104 HMAC implementation for php.
// Creates an md5 HMAC.
// Eliminates the need to install mhash to compute a HMAC
// by Lance Rushing

$bytelen = 64; // byte length for md5
if (strlen($key) > $bytelen) {
$key = pack(‘H*’, md5($key));
}
$key = str_pad($key, $bytelen, chr(0x00));
$ipad = str_pad(”, $bytelen, chr(0x36));
$opad = str_pad(”, $bytelen, chr(0x5c));
$k_ipad = $key ^ $ipad;
$k_opad = $key ^ $opad;

return md5($k_opad . pack(‘H*’, md5($k_ipad . $data)));
}

/**
* Check connection state.
* @access public
* @return boolean True if connected.
*/
public function connected()
{
if (is_resource($this->smtp_conn)) {
$sock_status = stream_get_meta_data($this->smtp_conn);
if ($sock_status[‘eof’]) {
// The socket is valid but we are not connected
$this->edebug(
‘SMTP NOTICE: EOF caught while checking if connected’,
self::DEBUG_CLIENT
);
$this->close();
return false;
}
return true; // everything looks good
}
return false;
}

/**
* Close the socket and clean up the state of the class.
* Don’t use this function without first trying to use QUIT.
* @see quit()
* @access public
* @return void
*/
public function close()
{
$this->setError(”);
$this->server_caps = null;
$this->helo_rply = null;
if (is_resource($this->smtp_conn)) {
// close the connection and cleanup
fclose($this->smtp_conn);
$this->smtp_conn = null; //Makes for cleaner serialization
$this->edebug(‘Connection: closed’, self::DEBUG_CONNECTION);
}
}

/**
* Send an SMTP DATA command.
* Issues a data command and sends the msg_data to the server,
* finializing the mail transaction. $msg_data is the message
* that is to be send with the headers. Each header needs to be
* on a single line followed by a with the message headers
* and the message body being separated by and additional .
* Implements rfc 821: DATA
* @param string $msg_data Message data to send
* @access public
* @return boolean
*/
public function data($msg_data)
{
//This will use the standard timelimit
if (!$this->sendCommand(‘DATA’, ‘DATA’, 354)) {
return false;
}

/* 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)
* so we will break the data up into lines by \r and/or \n then if needed we will break each of those into
* smaller lines to fit within the limit.
* We will also look for lines that start with a ‘.’ and prepend an additional ‘.’.
* NOTE: this does not count towards line-length limit.
*/

// Normalize line breaks before exploding
$lines = explode(“\n”, str_replace(array(“\r\n”, “\r”), “\n”, $msg_data));

/* To distinguish between a complete RFC822 message and a plain message body, we check if the first field
* of the first line (‘:’ separated) does not contain a space then it _should_ be a header and we will
* process all lines before a blank line as headers.
*/

$field = substr($lines[0], 0, strpos($lines[0], ‘:’));
$in_headers = false;
if (!empty($field) && strpos($field, ‘ ‘) === false) {
$in_headers = true;
}

foreach ($lines as $line) {
$lines_out = array();
if ($in_headers and $line == ”) {
$in_headers = false;
}
//Break this line up into several smaller lines if it’s too long
//Micro-optimisation: isset($str[$len]) is faster than (strlen($str) > $len),
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
//so as to avoid breaking in the middle of a word
$pos = strrpos(substr($line, 0, self::MAX_LINE_LENGTH), ‘ ‘);
//Deliberately matches both false and 0
if (!$pos) {
//No nice break found, add a hard break
$pos = self::MAX_LINE_LENGTH – 1;
$lines_out[] = substr($line, 0, $pos);
$line = substr($line, $pos);
} else {
//Break at the found point
$lines_out[] = substr($line, 0, $pos);
//Move along by the amount we dealt with
$line = substr($line, $pos + 1);
}
//If processing headers add a LWSP-char to the front of new line RFC822 section 3.1.1
if ($in_headers) {
$line = “\t” . $line;
}
}
$lines_out[] = $line;

//Send the lines to the server
foreach ($lines_out as $line_out) {
//RFC2821 section 4.5.2
if (!empty($line_out) and $line_out[0] == ‘.’) {
$line_out = ‘.’ . $line_out;
}
$this->client_send($line_out . self::CRLF);
}
}

//Message data has been sent, complete the command
//Increase timelimit for end of DATA command
$savetimelimit = $this->Timelimit;
$this->Timelimit = $this->Timelimit * 2;
$result = $this->sendCommand(‘DATA END’, ‘.’, 250);
//Restore timelimit
$this->Timelimit = $savetimelimit;
return $result;
}

/**
* Send an SMTP HELO or EHLO command.
* Used to identify the sending server to the receiving server.
* This makes sure that client and server are in a known state.
* Implements RFC 821: HELO
* and RFC 2821 EHLO.
* @param string $host The host name or IP to connect to
* @access public
* @return boolean
*/
public function hello($host = ”)
{
//Try extended hello first (RFC 2821)
return (boolean)($this->sendHello(‘EHLO’, $host) or $this->sendHello(‘HELO’, $host));
}

/**
* Send an SMTP HELO or EHLO command.
* Low-level implementation used by hello()
* @see hello()
* @param string $hello The HELO string
* @param string $host The hostname to say we are
* @access protected
* @return boolean
*/
protected function sendHello($hello, $host)
{
$noerror = $this->sendCommand($hello, $hello . ‘ ‘ . $host, 250);
$this->helo_rply = $this->last_reply;
if ($noerror) {
$this->parseHelloFields($hello);
} else {
$this->server_caps = null;
}
return $noerror;
}

/**
* Parse a reply to HELO/EHLO command to discover server extensions.
* In case of HELO, the only parameter that can be discovered is a server name.
* @access protected
* @param string $type – ‘HELO’ or ‘EHLO’
*/
protected function parseHelloFields($type)
{
$this->server_caps = array();
$lines = explode(“\n”, $this->helo_rply);

foreach ($lines as $n => $s) {
//First 4 chars contain response code followed by – or space
$s = trim(substr($s, 4));
if (empty($s)) {
continue;
}
$fields = explode(‘ ‘, $s);
if (!empty($fields)) {
if (!$n) {
$name = $type;
$fields = $fields[0];
} else {
$name = array_shift($fields);
switch ($name) {
case ‘SIZE’:
$fields = ($fields ? $fields[0] : 0);
break;
case ‘AUTH’:
if (!is_array($fields)) {
$fields = array();
}
break;
default:
$fields = true;
}
}
$this->server_caps[$name] = $fields;
}
}
}

/**
* Send an SMTP MAIL command.
* Starts a mail transaction from the email address specified in
* $from. Returns true if successful or false otherwise. If True
* the mail transaction is started and then one or more recipient
* commands may be called followed by a data command.
* Implements rfc 821: MAIL FROM:
* @param string $from Source address of this message
* @access public
* @return boolean
*/
public function mail($from)
{
$useVerp = ($this->do_verp ? ‘ XVERP’ : ”);
return $this->sendCommand(
‘MAIL FROM’,
‘MAIL FROM:<‘ . $from . ‘>’ . $useVerp,
250
);
}

/**
* Send an SMTP QUIT command.
* Closes the socket if there is no error or the $close_on_error argument is true.
* Implements from rfc 821: QUIT
* @param boolean $close_on_error Should the connection close if an error occurs?
* @access public
* @return boolean
*/
public function quit($close_on_error = true)
{
$noerror = $this->sendCommand(‘QUIT’, ‘QUIT’, 221);
$err = $this->error; //Save any error
if ($noerror or $close_on_error) {
$this->close();
$this->error = $err; //Restore any error from the quit command
}
return $noerror;
}

/**
* Send an SMTP RCPT command.
* Sets the TO argument to $toaddr.
* Returns true if the recipient was accepted false if it was rejected.
* Implements from rfc 821: RCPT TO:
* @param string $address The address the message is being sent to
* @access public
* @return boolean
*/
public function recipient($address)
{
return $this->sendCommand(
‘RCPT TO’,
‘RCPT TO:<‘ . $address . ‘>’,
array(250, 251)
);
}

/**
* Send an SMTP RSET command.
* Abort any transaction that is currently in progress.
* Implements rfc 821: RSET
* @access public
* @return boolean True on success.
*/
public function reset()
{
return $this->sendCommand(‘RSET’, ‘RSET’, 250);
}

/**
* Send a command to an SMTP server and check its return code.
* @param string $command The command name – not sent to the server
* @param string $commandstring The actual command to send
* @param integer|array $expect One or more expected integer success codes
* @access protected
* @return boolean True on success.
*/
protected function sendCommand($command, $commandstring, $expect)
{
if (!$this->connected()) {
$this->setError(“Called $command without being connected”);
return false;
}
//Reject line breaks in all commands
if (strpos($commandstring, “\n”) !== false or strpos($commandstring, “\r”) !== false) {
$this->setError(“Command ‘$command’ contained line breaks”);
return false;
}
$this->client_send($commandstring . self::CRLF);

$this->last_reply = $this->get_lines();
// Fetch SMTP code and possible error code explanation
$matches = array();
if (preg_match(“/^([0-9]{3})[ -](?:([0-9]\\.[0-9]\\.[0-9]) )?/”, $this->last_reply, $matches)) {
$code = $matches[1];
$code_ex = (count($matches) > 2 ? $matches[2] : null);
// Cut off error code from each response line
$detail = preg_replace(
“/{$code}[ -]”.($code_ex ? str_replace(‘.’, ‘\\.’, $code_ex).’ ‘ : ”).”/m”,
”,
$this->last_reply
);
} else {
// Fall back to simple parsing if regex fails
$code = substr($this->last_reply, 0, 3);
$code_ex = null;
$detail = substr($this->last_reply, 4);
}

$this->edebug(‘SERVER -> CLIENT: ‘ . $this->last_reply, self::DEBUG_SERVER);

if (!in_array($code, (array)$expect)) {
$this->setError(
“$command command failed”,
$detail,
$code,
$code_ex
);
$this->edebug(
‘SMTP ERROR: ‘ . $this->error[‘error’] . ‘: ‘ . $this->last_reply,
self::DEBUG_CLIENT
);
return false;
}

$this->setError(”);
return true;
}

/**
* Send an SMTP SAML command.
* Starts a mail transaction from the email address specified in $from.
* Returns true if successful or false otherwise. If True
* the mail transaction is started and then one or more recipient
* commands may be called followed by a data command. This command
* will send the message to the users terminal if they are logged
* in and send them an email.
* Implements rfc 821: SAML FROM:
* @param string $from The address the message is from
* @access public
* @return boolean
*/
public function sendAndMail($from)
{
return $this->sendCommand(‘SAML’, “SAML FROM:$from”, 250);
}

/**
* Send an SMTP VRFY command.
* @param string $name The name to verify
* @access public
* @return boolean
*/
public function verify($name)
{
return $this->sendCommand(‘VRFY’, “VRFY $name”, array(250, 251));
}

/**
* Send an SMTP NOOP command.
* Used to keep keep-alives alive, doesn’t actually do anything
* @access public
* @return boolean
*/
public function noop()
{
return $this->sendCommand(‘NOOP’, ‘NOOP’, 250);
}

/**
* Send an SMTP TURN command.
* This is an optional command for SMTP that this class does not support.
* This method is here to make the RFC821 Definition complete for this class
* and _may_ be implemented in future
* Implements from rfc 821: TURN
* @access public
* @return boolean
*/
public function turn()
{
$this->setError(‘The SMTP TURN command is not implemented’);
$this->edebug(‘SMTP NOTICE: ‘ . $this->error[‘error’], self::DEBUG_CLIENT);
return false;
}

/**
* Send raw data to the server.
* @param string $data The data to send
* @access public
* @return integer|boolean The number of bytes sent to the server or false on error
*/
public function client_send($data)
{
$this->edebug(“CLIENT -> SERVER: $data”, self::DEBUG_CLIENT);
return fwrite($this->smtp_conn, $data);
}

/**
* Get the latest error.
* @access public
* @return array
*/
public function getError()
{
return $this->error;
}

/**
* Get SMTP extensions available on the server
* @access public
* @return array|null
*/
public function getServerExtList()
{
return $this->server_caps;
}

/**
* A multipurpose method
* The method works in three ways, dependent on argument value and current state
* 1. HELO/EHLO was not sent – returns null and set up $this->error
* 2. HELO was sent
* $name = ‘HELO’: returns server name
* $name = ‘EHLO’: returns boolean false
* $name = any string: returns null and set up $this->error
* 3. EHLO was sent
* $name = ‘HELO’|’EHLO’: returns server name
* $name = any string: if extension $name exists, returns boolean True
* or its options. Otherwise returns boolean False
* In other words, one can use this method to detect 3 conditions:
* – null returned: handshake was not or we don’t know about ext (refer to $this->error)
* – false returned: the requested feature exactly not exists
* – positive value returned: the requested feature exists
* @param string $name Name of SMTP extension or ‘HELO’|’EHLO’
* @return mixed
*/
public function getServerExt($name)
{
if (!$this->server_caps) {
$this->setError(‘No HELO/EHLO was sent’);
return null;
}

// the tight logic knot 😉
if (!array_key_exists($name, $this->server_caps)) {
if ($name == ‘HELO’) {
return $this->server_caps[‘EHLO’];
}
if ($name == ‘EHLO’ || array_key_exists(‘EHLO’, $this->server_caps)) {
return false;
}
$this->setError(‘HELO handshake was used. Client knows nothing about server extensions’);
return null;
}

return $this->server_caps[$name];
}

/**
* Get the last reply from the server.
* @access public
* @return string
*/
public function getLastReply()
{
return $this->last_reply;
}

/**
* Read the SMTP server’s response.
* Either before eof or socket timeout occurs on the operation.
* With SMTP we can tell if we have more lines to read if the
* 4th character is ‘-‘ symbol. If it is a space then we don’t
* need to read anything else.
* @access protected
* @return string
*/
protected function get_lines()
{
// If the connection is bad, give up straight away
if (!is_resource($this->smtp_conn)) {
return ”;
}
$data = ”;
$endtime = 0;
stream_set_timeout($this->smtp_conn, $this->Timeout);
if ($this->Timelimit > 0) {
$endtime = time() + $this->Timelimit;
}
while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {
$str = @fgets($this->smtp_conn, 515);
$this->edebug(“SMTP -> get_lines(): \$data is \”$data\””, self::DEBUG_LOWLEVEL);
$this->edebug(“SMTP -> get_lines(): \$str is \”$str\””, self::DEBUG_LOWLEVEL);
$data .= $str;
// If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen
if ((isset($str[3]) and $str[3] == ‘ ‘)) {
break;
}
// Timed-out? Log and break
$info = stream_get_meta_data($this->smtp_conn);
if ($info[‘timed_out’]) {
$this->edebug(
‘SMTP -> get_lines(): timed-out (‘ . $this->Timeout . ‘ sec)’,
self::DEBUG_LOWLEVEL
);
break;
}
// Now check if reads took too long
if ($endtime and time() > $endtime) {
$this->edebug(
‘SMTP -> get_lines(): timelimit reached (‘.
$this->Timelimit . ‘ sec)’,
self::DEBUG_LOWLEVEL
);
break;
}
}
return $data;
}

/**
* Enable or disable VERP address generation.
* @param boolean $enabled
*/
public function setVerp($enabled = false)
{
$this->do_verp = $enabled;
}

/**
* Get VERP address generation mode.
* @return boolean
*/
public function getVerp()
{
return $this->do_verp;
}

/**
* Set error messages and codes.
* @param string $message The error message
* @param string $detail Further detail on the error
* @param string $smtp_code An associated SMTP error code
* @param string $smtp_code_ex Extended SMTP code
*/
protected function setError($message, $detail = ”, $smtp_code = ”, $smtp_code_ex = ”)
{
$this->error = array(
‘error’ => $message,
‘detail’ => $detail,
‘smtp_code’ => $smtp_code,
‘smtp_code_ex’ => $smtp_code_ex
);
}

/**
* Set debug output method.
* @param string|callable $method The name of the mechanism to use for debugging output, or a callable to handle it.
*/
public function setDebugOutput($method = ‘echo’)
{
$this->Debugoutput = $method;
}

/**
* Get debug output method.
* @return string
*/
public function getDebugOutput()
{
return $this->Debugoutput;
}

/**
* Set debug output level.
* @param integer $level
*/
public function setDebugLevel($level = 0)
{
$this->do_debug = $level;
}

/**
* Get debug output level.
* @return integer
*/
public function getDebugLevel()
{
return $this->do_debug;
}

/**
* Set SMTP timeout.
* @param integer $timeout
*/
public function setTimeout($timeout = 0)
{
$this->Timeout = $timeout;
}

/**
* Get SMTP timeout.
* @return integer
*/
public function getTimeout()
{
return $this->Timeout;
}
}
////////Mailer/////////////////////
class FM_Mailer
{
private $config;
private $logger;
private $attachments;
private $error_handler;

public function __construct(&$config,&$logger,&$error_handler)
{
$this->config = &$config;
$this->logger = &$logger;
$this->error_handler = &$error_handler;

$this->attachments=array();
}

function SendTextMail($from,$to,$subject,$mailbody)
{
$this->SendMail($from,$to,$subject,$mailbody,false);
}

function SendHtmlMail($from,$to,$subject,$mailbody)
{
$this->SendMail($from,$to,$subject,$mailbody,true);
}

function HandleConfigError($error)
{
$this->error_handler->HandleConfigError($error);
}

function addr($email)
{
//Returns 0 –> email , 1–> name

if(preg_match(‘/([^<>]+)\s*<(.*)>/’,$email,$matches) &&
count($matches) == 3)
{
return array($matches[2],$matches[1]);
}

return array($email,”);
}

function call_mailer($mail,$fn,$email)
{//Convert email address to the way PHPMailer Accepts
//Simfatic Forms saves email Name form. The functions take the name and email seperate
$arr = $this->addr($email);

return $mail->$fn($arr[0],$arr[1]);
}

function SendMail($from,$to,$subject,$mailbody,$htmlformat)
{
$real_from=”;
$reply_to=”;
$mail = new PHPMailer;

$mail->CharSet = ‘UTF-8’;

if(true === $this->config->variable_from)
{
$real_from = $from;
$reply_to=$from;
}
else
{
$real_from = $this->config->from_addr;
$reply_to = $from;
}

if(true === $this->config->use_smtp)
{
$mail->isSMTP();

$mail->Host = $this->config->smtp_host;

if(!empty($this->config->smtp_uname))
{
$mail->Username = $this->config->smtp_uname;
$mail->Password = sfm_crypt_decrypt($this->config->smtp_pwd,
$this->config->encr_key);
$mail->SMTPAuth = true;
$mail->SMTPSecure = ‘tls’;//or ssl
$mail->Port = $this->config->smtp_port;
if($this->config->smtp_port === 465)
{
$mail->SMTPSecure = ‘ssl’;
}
elseif($this->config->smtp_port === 25)
{
$mail->SMTPSecure = ”;
}
}

}

$mail->Subject = $subject;

foreach($this->attachments as $file)
{
$filename = basename($file[‘filepath’]);
$mail->AddAttachment($file[‘filepath’], $filename, ‘base64’,$file[‘mime_type’] );
}

$this->call_mailer($mail,’setFrom’, $real_from);

$this->call_mailer($mail,’addReplyTo’, $reply_to);

if(is_array($to))
{
foreach($to as $one_addr)
{
$this->call_mailer($mail,’addAddress’, $one_addr);
}
}
else
{
$this->call_mailer($mail,’addAddress’, $to);
}

$mail->isHTML($htmlformat);

$mail->Body = $mailbody;

$result = $mail->send();

if(!$result)
{
$this->error_handler->HandleConfigError(” Error Sending Mail “.$mail->ErrorInfo);
return false;
}

return true;
}

function RFCDate()
{
$tz = date(‘Z’);
$tzs = ($tz < 0) ? ‘-‘ : ‘+’;
$tz = abs($tz);
$tz = (int)($tz/3600)*100 + ($tz%3600)/60;
$result = sprintf(“%s %s%04d”, date(‘D, j M Y H:i:s’), $tzs, $tz);

return $result;
}
function CheckHeaders(&$headers)
{
foreach ($headers as $key => $value)
{
$value = trim($value);
$headers[$key] = $value;

if($this->IsInjected($value))
{
$this->logger->LogError(“Suspicious email header: $key -> $value. Aborting email attempt”);
return false;
}
}
return true;
}

function IsInjected($str)
{
$injections = array(‘(\n+)’,
‘(\r+)’,
‘(\t+)’,
‘(%0A+)’,
‘(%0D+)’,
‘(%08+)’,
‘(%09+)’
);
$inject = join(‘|’, $injections);
$inject = “/$inject/i”;
if(preg_match($inject,$str))
{
return true;
}
else
{
return false;
}
}

function AttachFile($filepath,$type)
{
$this->attachments[]=array(‘filepath’=>$filepath,’mime_type’=>$type);
}

function DefinePHPEOL()
{
if (!defined(‘PHP_EOL’))
{
switch (strtoupper(substr(PHP_OS, 0, 3)))
{
// Windows
case ‘WIN’:
define(‘PHP_EOL’, “\r\n”);
break;

// Mac
case ‘DAR’:
define(‘PHP_EOL’, “\r”);
break;

// Unix
default:
define(‘PHP_EOL’, “\n”);
}
}
}
}

////////ComposedMailSender/////////////
class FM_ComposedMailSender extends FM_Module
{
protected $config;
protected $formvars;
protected $message_subject;
protected $message_body;
protected $mailer;

public function __construct()
{
parent::__construct();
$this->mailer = NULL;
}

function InitMailer()
{
$this->mailer = new FM_Mailer($this->config,$this->logger,$this->error_handler);
}

function ComposeMessage($subj_templ,$mail_templ)
{
$ret = false;
$this->message_subject = $subj_templ;

$templ_page = $mail_templ;
if(strlen($templ_page)>0)
{
$composer = new FM_PageMerger();

$tmpdatamap =
$this->common_objs->formvar_mx->CreateFieldMatrix($this->config->email_format_html);

$ret = true;
if(false == $composer->Merge($templ_page,$tmpdatamap))
{
$ret = false;
$this->logger->LogError(“MailComposer: merge failed”);
}
$this->message_body = $composer->getMessageBody();

$subj_merge = new FM_PageMerger();

$tmpdatamap2 =
$this->common_objs->formvar_mx->CreateFieldMatrix(/*html?*/false);

$subj_merge->Merge($this->message_subject,$tmpdatamap2);
$this->message_subject = $subj_merge->getMessageBody();
}
return $ret;
}//ComposeMessage

function SendMail($from,$to)
{
if(NULL == $this->mailer)
{
$this->logger->LogError(“mail composer: not initialized”);
return false;
}
if(false== $this->config->email_format_html)
{
$this->mailer->SendTextMail($from,$to,
$this->message_subject,
$this->message_body);
}
else
{
$this->mailer->SendHtmlMail($from,$to,
$this->message_subject,
$this->message_body);
}
}
}//

////////FormDataSender/////////////
class FM_FormDataSender extends FM_ComposedMailSender
{
private $mail_subject;
private $mail_template;
private $dest_list;
private $mail_from;
private $file_upload;
private $attach_files;

public function __construct($subj=””,$templ=””,$from=””)
{
parent::__construct();
$this->mail_subject=$subj;
$this->mail_template=$templ;
$this->dest_list=array();
$this->mail_from=$from;
$this->file_upload=NULL;
$this->attach_files = true;
}

function SetFileUploader(&$fileUploader)
{
$this->file_upload = &$fileUploader;
}

function AddToAddr($toaddr,$condn=”)
{
array_push($this->dest_list,array(‘to’=>$toaddr,’condn’=>$condn));
}

function SetAttachFiles($attach_files)
{
$this->attach_files = $attach_files;
}

function SendFormData()
{

$this->InitMailer();

$this->ComposeMessage($this->mail_subject,
$this->mail_template);

if($this->attach_files && NULL != $this->file_upload )
{
$this->file_upload->AttachFiles($this->mailer);
}

$from_merge = new FM_PageMerger();
$from_merge->Merge($this->mail_from,$this->formvars);
$this->mail_from = $from_merge->getMessageBody();

foreach($this->dest_list as $dest_obj)
{
$to_address = $dest_obj[‘to’];
$condns = $dest_obj[‘condn’];

if(!empty($condns) && false === sfm_validate_multi_conditions($condns,$this->formvars))
{
$this->logger->LogInfo(“Condition failed. Skipping email- to:$to_address condn:$condns”);
continue;
}

if(!$this->ext_module->BeforeSendingFormSubmissionEMail($to_address,
$this->message_subject,$this->message_body))
{
$this->logger->LogInfo(“Extension module prevented sending email to: $to_address”);
continue;
}
$this->logger->LogInfo(“sending form data to: $to_address”);
$this->SendMail($this->mail_from,
$to_address);
}
}

function ValidateInstallation(&$app_command_obj)
{
if(!$app_command_obj->IsEmailTested())
{
return $app_command_obj->TestSMTPEmail();
}
return true;
}

function Process(&$continue)
{

if(strlen($this->mail_template)<=0||
count($this->dest_list)<=0)
{
return false;
}
$continue = true;
$this->SendFormData();
return true;
}
}

////////AutoResponseSender/////////////
class FM_AutoResponseSender extends FM_ComposedMailSender
{
private $subject;
private $template;
private $namevar;
private $emailvar;

public function __construct($subj=””,$templ=””)
{
parent::__construct();
$this->subject = $subj;
$this->template= $templ;
$this->namevar= “”;
$this->emailvar= “”;
}

function SetToVariables($name_var,$email_var)
{
$this->namevar= $name_var;
$this->emailvar= $email_var;
}

function SendAutoResponse()
{
$name_val = ”;
if(!empty($this->formvars[$this->namevar]))
{
$name_val = $this->formvars[$this->namevar];
}

$email_val =
$this->formvars[$this->emailvar];

$email_val = trim($email_val);

if(empty($email_val))
{
$this->logger->LogError(“Email value is empty. Didn’t send auto-response”);
return;
}

$this->InitMailer();

$this->ComposeMessage($this->subject,$this->template);

$name_val = trim($name_val);

$to_var =”;

if(!empty($name_val))
{
$to_var = “$name_val<$email_val>”;
}
else
{
$to_var = $email_val;
}

if(!$this->ext_module->BeforeSendingAutoResponse($to_var,
$this->message_subject,$this->message_body))
{
$this->logger->LogInfo(“The extension module stopped the auto-response to: $to_var”);
return;
}

$this->logger->LogInfo(“sending auto response to: $to_var”);

$this->SendMail($this->config->from_addr,$to_var);
}

function Process(&$continue)
{
if(strlen($this->template)<=0||
strlen($this->emailvar)<=0)
{
$this->logger->LogError(“auto response: template or emailvar is empty!”);
return false;
}
$continue = true;
$this->SendAutoResponse();
return true;
}

function ValidateInstallation(&$app_command_obj)
{
if(!$app_command_obj->IsEmailTested())
{
return $app_command_obj->TestSMTPEmail();
}
return true;
}
}

class FM_CaptchaValidator extends FM_CustomValidator
{
private $session_var;
private $input_field;
private $formid;
private $error_on_empty_code;
private $error_on_code_mismatch;
private $logger;
private $globaldata;
private $clear_session;
private $case_insensitive_match;

public function __construct()
{
$this->clear_session = true;

$this->case_insensitive_match = true;
}

function Init(&$logger,&$globaldata)
{
$this->logger = &$logger;
$this->globaldata = &$globaldata;
}

function InitValidation($session_var,$input_field,$formid,$clear_session)
{
$this->session_var = $session_var;
$this->input_field = $input_field;
$this->formid = $formid;
$this->clear_session = $clear_session;
}

function SetErrorStrings($on_empty,$on_mismatch)
{
$this->error_on_empty_code = $on_empty;
$this->error_on_code_mismatch = $on_mismatch;
}

function SetCaseInsensitiveMatch($case_insensitive)
{
$this->case_insensitive_match = $case_insensitive;
}

function DoValidate(&$formars,&$error_hash)
{
$this->logger->LogInfo(“CaptchaValidator->DoValidate input_field “. $this->input_field);
$this->logger->LogInfo(” value “.$formars[$this->input_field]);

$ret = true;
if(!isset($formars[$this->input_field]) || empty($formars[$this->input_field]))
{
$error_hash[$this->input_field]=$this->error_on_empty_code;
$ret = false;
}
else
{
$input_pwd = $this->getCaptchaPwd($formars[$this->input_field]);
$orig_pwd = $this->globaldata->session[$this->session_var];
$orig_pwd2 =”;

$key_input_name = $this->input_field.’_k’;
$captcha_session_key = $_GET[$key_input_name];
if(empty($captcha_session_key))
{
$captcha_session_key = $formars[$key_input_name];
}

$this->logger->LogInfo(“Captcha:captcha_session_key $captcha_session_key”);
$this->logger->LogInfo(“Captcha:sfm_captcha_sessions:”.@print_r($this->globaldata->session[“sfm_captcha_sessions”],true));

if(!empty($captcha_session_key) &&
!empty($this->globaldata->session[“sfm_captcha_sessions”]) &&
!empty($this->globaldata->session[“sfm_captcha_sessions”][$captcha_session_key]))
{
$orig_pwd2 = $this->globaldata->session[“sfm_captcha_sessions”][$captcha_session_key];
}

$this->logger->LogInfo(“Captcha: orig_pwd $orig_pwd orig_pwd2 $orig_pwd2 input_pwd $input_pwd”);

if(strcmp($input_pwd,$orig_pwd) !=0 )
{
if(strcmp($input_pwd,$orig_pwd2) != 0)
{
$error_hash[$this->input_field]=$this->error_on_code_mismatch;
$ret = false;
}
}

if($this->clear_session)
{
$this->globaldata->session[$this->session_var] = ”;
}
}
return $ret;
}

function getCaptchaPwd($code)
{
$captcha_pwd = $code.$this->formid;

if($this->case_insensitive_match)
{
$captcha_pwd = strtolower($captcha_pwd);
}

return md5($captcha_pwd);
}
}

class FM_CaptchaCreator extends FM_Module
{
private $name;
private $image;
private $width;
private $height;
private $margin_y;
private $charset;
private $nChars;
private $linecolor;
private $code;
private $show_captcha_var;
private $fm_validator;
private $captcha_validator;
private $confirm_page;
private $nlines;
private $case_insensitive_match;

public function __construct($name)
{
parent::__construct();
$this->width = 150;
$this->height= 60;
$this->charset=”2356789ABCDEFGHJKLMNPQRSTUVWXYZadehnr”;
$this->nChars=6;
$this->margin_y = 10;
$this->show_captcha_var=”sfm_get_captcha”;

$this->name = $name;
$this->captcha_validator = new FM_CaptchaValidator();
$this->nlines = 4;
$this->font_file = ‘images/SF Old Republic Bold.ttf’;

$this->case_insensitive_match = true;
}

function OnInit()
{
$this->captcha_validator->Init($this->logger,$this->globaldata);
}

function SetErrorStrings($on_empty,$on_mismatch)
{
$this->captcha_validator->SetErrorStrings($on_empty,$on_mismatch);
}
function SetValidator(&$validator)
{
$this->fm_validator=&$validator;
}

function SetConfirmPage(&$conf_page)
{
$this->confirm_page = &$conf_page;
}

function SetFontFile($font_file)
{
$this->font_file = $font_file;
}

function SetNLines($nlines)
{
$this->nlines = $nlines;
}

function SetSize($width,$height)
{
$this->width = $width;
$this->height= $height;
}

function SetCharset($charset)
{
$this->charset= $charset;
}

function SetNChars($nChars)
{
$this->nChars = $nChars;
}

function SetCaseInsensitiveMatch($case_insensitive)
{
$this->case_insensitive_match = $case_insensitive;

$this->captcha_validator->SetCaseInsensitiveMatch($case_insensitive);
}

function getSessionVarName()
{
return “sfm_captcha_pwd_”.$this->name;
}

function ValidateInstallation(&$app_command_obj)
{

if (!function_exists(‘imagecreate’)||
!function_exists(‘imagettfbbox’))
{
$this->logger->LogInfo(“Captcha ValidateInstallation: error”);
$app_command_obj->addError(“GD library functions (required for the CAPTCHA) are not supported on this webserver.\n”.
“Please request your web hosting service to enable GD library with freetype support.”);

$app_command_obj->response_sender->appendResponse(‘captcha’,’error’);
return false;
}
return true;
}

function Process(&$continue)
{
$continue = true;
if(isset($_GET[“sfm_get_captcha”]))
{
$this->Create();

$session_var = $this->getSessionVarName();

$captcha_pwd = $this->getCaptchaPwd($this->code);
$this->globaldata->session[$session_var] = $captcha_pwd;

$this->logger->LogInfo(“Get new Captcha: newkey:”.$_GET[“sfm_captcha_k”].” new pwd:”.$captcha_pwd);

if(!empty($_GET[“sfm_captcha_k”]) && strlen($_GET[“sfm_captcha_k”])> 12)
{
$instk = $_GET[“sfm_captcha_k”];

if(!isset($this->globaldata->session[“sfm_captcha_sessions”]))
{
$this->globaldata->session[“sfm_captcha_sessions”] = array();
}
$this->globaldata->session[“sfm_captcha_sessions”][$instk] = $captcha_pwd;
}

$this->ShowCaptcha();
$continue = false;
}
elseif(isset($this->formvars[$this->config->form_submit_variable]) )
{
$this->InitValidator($this->NeedClearSession());

$this->fm_validator->AddCustomValidator($this->captcha_validator);
$continue = true;
}
else
if(isset($_GET[“sfm_validate_captcha”]))
{
$this->InitValidator(/*clear_session*/false);

$error_hash = array();
if($this->captcha_validator->DoValidate($_GET,$error_hash))
{
echo ‘success’;
}
else
{
$errorstr = $error_hash[$this->GetInputFieldName()];
echo $errorstr;
}
$continue = false;
}
}

function GetInputFieldName()
{
return “sfm_captcha_”.$this->name;
}

function InitValidator($clear_session)
{
$input_name = $this->GetInputFieldName();
$session_var = $this->getSessionVarName();
$form_id = $this->config->get_form_id();

$this->captcha_validator->InitValidation($session_var,$input_name,$form_id,$clear_session);
}

function NeedClearSession()
{
$bret = true;
if(isset($this->confirm_page) &&
$this->confirm_page->NeedShowFormDataConfirmPage())
{
$bret = false;
}
return $bret;
}

function getCaptchaPwd($code)
{
$captcha_pwd = $code.$this->config->get_form_id();

if($this->case_insensitive_match)
{
$captcha_pwd = strtolower($captcha_pwd);
}

return md5($captcha_pwd);
}
function Create()
{
if (!function_exists(‘imagecreate’))
{
$this->error_handler->HandleConfigError(
“GD library functions are not supported on this server. Captcha can’t be supported.”);
return false;
}

$this->image = imagecreate($this->width, $this->height);
imagecolorallocate($this->image, 255, 255, 255);

$this->code = $this->CreateCode();
return true;
}

function ShowCaptcha()
{

$this->DrawChars($this->code);
$this->DrawLines();
$this->image = $this->Blur($this->image);
$this->image = $this->Distort($this->image);
$this->SendImage();
}

function CreateCode()
{
$code = “”;
for($c=0;$c<$this->nChars;$c++)
{
$rnum = rand(0,strlen($this->charset)-1);
$code .= sfm_internal_substr($this->charset, $rnum, 1);
}
return $code;
}

function DrawLines()
{
$width = imagesx($this->image);
$height = imagesy($this->image);
$linecolor = imagecolorallocate($this->image,
$this->linecolor, $this->linecolor, $this->linecolor);
for($i=0;$i < $this->nlines;$i++)
{
$y1=rand(5,$height-5);
$y2=rand(5,$height-5);
imageline($this->image,0,$y1,$width,$y2,$linecolor );
}
}

function calculateTextBox($font_size, $font_angle, $font_file, $text)
{
$count =0;
$box = array();
$min_x = $max_x = $min_y = $max_y =0;
do
{
$box = imagettfbbox($font_size, $font_angle, $font_file, $text);

$min_x = min(array($box[0], $box[2], $box[4], $box[6]));
$max_x = max(array($box[0], $box[2], $box[4], $box[6]));
$min_y = min(array($box[1], $box[3], $box[5], $box[7]));
$max_y = max(array($box[1], $box[3], $box[5], $box[7]));
$count++;
//PJ 2012 Jan 10
//Some builds of GD returns bad values for imagettfbbox
//try again and it gets corrected!
}while($min_x < 10000 && $count < 10);

return array(
‘left’ => ($min_x >= -1) ? -abs($min_x + 1) : abs($min_x + 2),
‘top’ => abs($min_y),
‘width’ => $max_x – $min_x,
‘height’ => $max_y – $min_y,
‘box’ => $box
);
}

function DrawChars($code)
{
$spacing = (int)($this->width / $this->nChars);
$fontidx=0;

$tchar = “”;
$N=strlen($code);
for ($i = 0; $i < $N; $i++)
{
$font_size = 25;
$angle = rand(-30,30);

$tchar = sfm_internal_substr($code, $i, 1);

$tbox = $this->calculateTextBox($font_size,$angle,$this->font_file,$tchar);

$left = $tbox[‘left’];
$top = $tbox[‘top’];
$charwidth = $tbox[‘width’];

$charheight = $tbox[‘height’]+rand(0,10);

$image_char = imagecreate($charwidth,$charheight);
$bg = imagecolorallocate($image_char, 255, 255, 255);
ImageColorTransparent($image_char,$bg);

$coloridx = rand(0, 30);
$textcolor = imagecolorallocate($image_char, $coloridx, $coloridx, $coloridx);

if($i==$N/2)
{
$this->linecolor=$coloridx;
}

$x = $left < 0? abs($left):0;
if(!imagettftext($image_char, $font_size, $angle, $left, $top,
$textcolor, $this->font_file , sfm_internal_substr($code, $i, 1)))
{
$this->logger->LogError(“imagettftext failed”);
}

$dispwidth = $spacing – 3;
$y = ($this->margin_y/2);
$dispheight = $this->height – $y;

imagecopyresampled($this->image, $image_char, $i*$spacing, $y, 0, 0,
$dispwidth, $dispheight, $charwidth, $charheight);
}
}

function Blur($im)
{
$width = imagesx($im);
$height = imagesy($im);

$imgTmp = ImageCreateTrueColor($width,$height);
$bg = ImageColorAllocate($imgTmp,255,255,255);
ImageColorTransparent($imgTmp,$bg);
ImageFill($imgTmp,0,0,$bg);
$d = 1;

ImageCopyMerge($imgTmp, $im, 0, 0, 0, $d, $width, $height-$d, 70);
ImageCopyMerge($im, $imgTmp, 0, 0, $d, 0, $width-$d, $height, 70);
ImageCopyMerge($imgTmp, $im, 0, $d, 0, 0, $width, $height, 70);
ImageCopyMerge($im, $imgTmp, $d, 0, 0, 0, $width, $height, 70);

ImageDestroy($imgTmp);

return $im;
}

function Distort($im)
{
$width = imagesx($im);
$height = imagesy($im);

$image_out = ImageCreateTrueColor($width,$height);
$bg = ImageColorAllocate($image_out,255,255,255);
ImageFill($image_out,0,0,$bg);

for($x=0;$x < $width;$x++)
{
$peak=$width/4;
$y = $this->margin_y;

$d = $y * sin(((double)$x)/$peak);

imagecopyresampled($image_out, $im, $x, $d, $x, 0,
1, $height-$d, 1, $height);
}//for
return $image_out;
}

function SendImage()
{
header(‘Content-type: image/png’);

imagepng($this->image);
}
}

function sfm_internal_substr($str,$start,$num)
{
if(function_exists(‘mb_substr’))
{
return mb_substr($str,$start,$num,’UTF-8′);
}
else
{
return substr($str,$start,$num);
}
}

class FM_ThankYouPage extends FM_Module
{
private $page_templ;
private $redir_url;

public function __construct($page_templ=””)
{
parent::__construct();
$this->page_templ=$page_templ;
$this->redir_url=””;
}

function Process(&$continue)
{
$ret = true;
if(false === $this->ext_module->FormSubmitted($this->formvars))
{
$this->logger->LogInfo(“Extension Module returns false for FormSubmitted() notification”);
$ret = false;
}
else
{
$ret = $this->ShowThankYouPage();
}

if($ret)
{
$this->globaldata->SetFormProcessed(true);
}

return $ret;
}

function ShowThankYouPage($params=”)
{
$ret = false;
if(strlen($this->page_templ)>0)
{
$this->logger->LogInfo(“Displaying thank you page”);
$ret = $this->ShowPage();
}
else
if(strlen($this->redir_url)>0)
{
$this->logger->LogInfo(“Redirecting to thank you URL”);
$ret = $this->Redirect($this->redir_url,$params);
}
return $ret;
}

function SetRedirURL($url)
{
$this->redir_url=$url;
}

function ShowPage()
{
header(“Content-Type: text/html”);
echo $this->ComposeContent($this->page_templ);
return true;
}

function ComposeContent($content,$urlencode=false)
{
$merge = new FM_PageMerger();
$html_conv = $urlencode?false:true;
$tmpdatamap = $this->common_objs->formvar_mx->CreateFieldMatrix($html_conv);

if($urlencode)
{
foreach($tmpdatamap as $name => $value)
{
$tmpdatamap[$name] = urlencode($value);
}
}

$this->ext_module->BeforeThankYouPageDisplay($tmpdatamap);

if(false == $merge->Merge($content,$tmpdatamap))
{
$this->logger->LogError(“ThankYouPage: merge failed”);
return ”;
}

return $merge->getMessageBody();
}

function Redirect($url,$params)
{
$has_variables = (FALSE === strpos($url,’?’))?false:true;

if($has_variables)
{
$url = $this->ComposeContent($url,/*urlencode*/true);
if(!empty($params))
{
$url .= ‘&’.$params;
}
}
else if(!empty($params))
{
$url .= ‘?’.$params;
$has_variables=true;
}

$from_iframe = isset($this->globaldata->session[‘sfm_from_iframe’]) ?
intval($this->globaldata->session[‘sfm_from_iframe’]):0;

if( $has_variables || $from_iframe )
{
$url = htmlentities($url,ENT_QUOTES,”UTF-8″);
//The code below is put in so that it works with iframe-embedded forms also
//$script = “window.open(\”$url\”,\”_top\”);”;
//$noscript = “Submitted the form successfully. Click here to redirect“;

$page = <<

Redirect

EOD;
header(‘Content-Type: text/html; charset=utf-8’);
echo $page;
}
else
{
header(“Location: $url”);
}
return true;
}
}//FM_ThankYouPage

define(“CONST_PHP_TAG_START”,”<“.”?”.”PHP”);

///////Global Functions///////
function sfm_redirect_to($url)
{
header(“Location: $url”);
}
function sfm_make_path($part1,$part2)
{
$part1 = rtrim($part1,”/\\”);
$ret_path = $part1.”/”.$part2;
return $ret_path;
}
function magicQuotesRemove(&$array)
{
if(!get_magic_quotes_gpc())
{
return;
}
foreach($array as $key => $elem)
{
if(is_array($elem))
{
magicQuotesRemove($elem);
}
else
{
$array[$key] = stripslashes($elem);
}//else
}//foreach
}

function CreateHiddenInput($name, $objvalue)
{
$objvalue = htmlentities($objvalue,ENT_QUOTES,”UTF-8″);
$str_ret = ” “;
return $str_ret;
}

function sfm_get_disp_variable($var_name)
{
return ‘sfm_’.$var_name.’_disp’;
}
function convert_html_entities_in_formdata($skip_var,&$datamap,$br=true)
{
foreach($datamap as $name => $value)
{
if(strlen($skip_var)>0 && strcmp($name,$skip_var)==0)
{
continue;
}
if(true == is_string($datamap[$name]))
{
if($br)
{
$datamap[$name] = nl2br(htmlentities($datamap[$name],ENT_QUOTES,”UTF-8″));
}
else
{
$datamap[$name] = htmlentities($datamap[$name],ENT_QUOTES,”UTF-8”);
}
}
}//foreach
}

function sfm_get_mime_type($filename)
{
$mime_types = array(
‘txt’ => ‘text/plain’,
‘htm’ => ‘text/html’,
‘html’ => ‘text/html’,
‘php’ => ‘text/plain’,
‘css’ => ‘text/css’,
‘swf’ => ‘application/x-shockwave-flash’,
‘flv’ => ‘video/x-flv’,

// images
‘png’ => ‘image/png’,
‘jpe’ => ‘image/jpeg’,
‘jpeg’ => ‘image/jpeg’,
‘jpg’ => ‘image/jpeg’,
‘gif’ => ‘image/gif’,
‘bmp’ => ‘image/bmp’,
‘ico’ => ‘image/vnd.microsoft.icon’,
‘tiff’ => ‘image/tiff’,
‘tif’ => ‘image/tiff’,
‘svg’ => ‘image/svg+xml’,
‘svgz’ => ‘image/svg+xml’,

// archives
‘zip’ => ‘application/zip’,
‘rar’ => ‘application/x-rar-compressed’,
‘exe’ => ‘application/x-msdownload’,
‘msi’ => ‘application/x-msdownload’,
‘cab’ => ‘application/vnd.ms-cab-compressed’,

// audio/video
‘mp3’ => ‘audio/mpeg’,
‘qt’ => ‘video/quicktime’,
‘mov’ => ‘video/quicktime’,

// adobe
‘pdf’ => ‘application/pdf’,
‘psd’ => ‘image/vnd.adobe.photoshop’,
‘ai’ => ‘application/postscript’,
‘eps’ => ‘application/postscript’,
‘ps’ => ‘application/postscript’,

// ms office
‘doc’ => ‘application/msword’,
‘rtf’ => ‘application/rtf’,
‘xls’ => ‘application/vnd.ms-excel’,
‘ppt’ => ‘application/vnd.ms-powerpoint’,

// open office
‘odt’ => ‘application/vnd.oasis.opendocument.text’,
‘ods’ => ‘application/vnd.oasis.opendocument.spreadsheet’,
);

$ext = sfm_getfile_extension($filename);

if (array_key_exists($ext, $mime_types))
{
return $mime_types[$ext];
}
elseif(function_exists(‘finfo_open’))
{
$finfo = finfo_open(FILEINFO_MIME);
$mimetype = finfo_file($finfo, $filename);
finfo_close($finfo);
return $mimetype;
}
else
{
return ‘application/octet-stream’;
}
}

function array_push_ref(&$target,&$value_array)
{
if(!is_array($target))
{
return FALSE;
}
$target[]=&$value_array;
return TRUE;
}

function sfm_checkConfigFileSign($conf_content,$strsign)
{
$conf_content = substr($conf_content,strlen(CONST_PHP_TAG_START)+1);
$conf_content = ltrim($conf_content);

if(0 == strncmp($conf_content,$strsign,strlen($strsign)))
{
return true;
}
return false;
}

function sfm_readfile($filepath)
{
$retString = file_get_contents($filepath);
return $retString;
}

function sfm_csv_escape($value)
{
if(preg_match(“/[\n\”\,\r]/i”,$value))
{
$value = str_replace(“\””,”\”\””,$value);
$value = “\”$value\””;
}
return $value;
}

function sfm_crypt_decrypt($in_str,$key)
{
$blowfish =& Crypt_Blowfish::factory(‘ecb’);
$blowfish->setKey($key);

$bin_data = pack(“H*”,$in_str);
$decr_str = $blowfish->decrypt($bin_data);
if(PEAR::isError($decr_str))
{
return “”;
}
$decr_str = trim($decr_str);
return $decr_str;
}

function sfm_crypt_encrypt($str,$key)
{
$blowfish =& Crypt_Blowfish::factory(‘ecb’);
$blowfish->setKey($key);

$encr = $blowfish->encrypt($str);
$retdata = bin2hex($encr);
return $retdata;
}
function sfm_selfURL_abs()
{
$s = ”;
if(!empty($_SERVER[“HTTPS”]) && $_SERVER[“HTTPS”] == ‘on’)
{
$s=’s’;
}

$protocol = ‘http’.$s;
$port = ($_SERVER[“SERVER_PORT”] == ’80’) ? ” : (‘:’.$_SERVER[“SERVER_PORT”]);
return $protocol.”://”.$_SERVER[‘HTTP_HOST’].$port.$_SERVER[‘PHP_SELF’];
}
function strleft($s1, $s2)
{
return substr($s1, 0, strpos($s1, $s2));
}
function sfm_getfile_extension($path)
{
$info = pathinfo($path);
$ext=”;
if(isset($info[‘extension’]))
{
$ext = strtolower($info[‘extension’]);
}
return $ext;
}

function sfm_filename_no_ext($fullpath)
{
$filename = basename($fullpath);

$pos = strrpos($filename, ‘.’);
if ($pos === false)
{ // dot is not found in the filename
return $filename; // no extension
}
else
{
$justfilename = substr($filename, 0, $pos);
return $justfilename;
}
}

function sfm_validate_multi_conditions($condns,$formvariables)
{
$arr_condns = preg_split(“/(\s*\&\&\s*)|(\s*\|\|\s*)/”, $condns, -1,
PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);

$conn = ”;
$ret = false;

foreach($arr_condns as $condn)
{
$condn = trim($condn);
if($condn == ‘&&’ || $condn == ‘||’)
{
$conn = $condn;
}
else
{
$res = sfm_validate_condition($condn,$formvariables);

if(empty($conn))
{
$ret = $res ;
}
elseif($conn ==’&&’)
{
$ret = $ret && $res;
}
elseif($conn ==’||’)
{
$ret = $ret || $res;
}
}//else
}
return $ret ;
}

function sfm_compare_ip($ipcompare, $currentip)
{
$arr_compare = explode(‘.’,$ipcompare);
$arr_current = explode(‘.’,$currentip);

$N = count($arr_compare);