ZwiiCMS, le gestionnaire de site Web sans base de données à installer.
Conçu en 2008 par Rémi Jean, le développement a été repris par Frédéric Tempez en 2018.
zwii cms nosql json flat file
https://www.zwiicms.fr
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4821 lines
162 KiB
4821 lines
162 KiB
<?php |
|
/** |
|
* PHPMailer - PHP email creation and transport class. |
|
* PHP Version 5.5. |
|
* |
|
* @see https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project |
|
* |
|
* @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk> |
|
* @author Jim Jagielski (jimjag) <jimjag@gmail.com> |
|
* @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net> |
|
* @author Brent R. Matzelle (original founder) |
|
* @copyright 2012 - 2019 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. |
|
*/ |
|
|
|
namespace PHPMailer\PHPMailer; |
|
|
|
/** |
|
* PHPMailer - PHP email creation and transport class. |
|
* |
|
* @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk> |
|
* @author Jim Jagielski (jimjag) <jimjag@gmail.com> |
|
* @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net> |
|
* @author Brent R. Matzelle (original founder) |
|
*/ |
|
class PHPMailer |
|
{ |
|
const CHARSET_ASCII = 'us-ascii'; |
|
const CHARSET_ISO88591 = 'iso-8859-1'; |
|
const CHARSET_UTF8 = 'utf-8'; |
|
|
|
const CONTENT_TYPE_PLAINTEXT = 'text/plain'; |
|
const CONTENT_TYPE_TEXT_CALENDAR = 'text/calendar'; |
|
const CONTENT_TYPE_TEXT_HTML = 'text/html'; |
|
const CONTENT_TYPE_MULTIPART_ALTERNATIVE = 'multipart/alternative'; |
|
const CONTENT_TYPE_MULTIPART_MIXED = 'multipart/mixed'; |
|
const CONTENT_TYPE_MULTIPART_RELATED = 'multipart/related'; |
|
|
|
const ENCODING_7BIT = '7bit'; |
|
const ENCODING_8BIT = '8bit'; |
|
const ENCODING_BASE64 = 'base64'; |
|
const ENCODING_BINARY = 'binary'; |
|
const ENCODING_QUOTED_PRINTABLE = 'quoted-printable'; |
|
|
|
const ENCRYPTION_STARTTLS = 'tls'; |
|
const ENCRYPTION_SMTPS = 'ssl'; |
|
|
|
const ICAL_METHOD_REQUEST = 'REQUEST'; |
|
const ICAL_METHOD_PUBLISH = 'PUBLISH'; |
|
const ICAL_METHOD_REPLY = 'REPLY'; |
|
const ICAL_METHOD_ADD = 'ADD'; |
|
const ICAL_METHOD_CANCEL = 'CANCEL'; |
|
const ICAL_METHOD_REFRESH = 'REFRESH'; |
|
const ICAL_METHOD_COUNTER = 'COUNTER'; |
|
const ICAL_METHOD_DECLINECOUNTER = 'DECLINECOUNTER'; |
|
|
|
/** |
|
* Email priority. |
|
* Options: null (default), 1 = High, 3 = Normal, 5 = low. |
|
* When null, the header is not set at all. |
|
* |
|
* @var int|null |
|
*/ |
|
public $Priority; |
|
|
|
/** |
|
* The character set of the message. |
|
* |
|
* @var string |
|
*/ |
|
public $CharSet = self::CHARSET_ISO88591; |
|
|
|
/** |
|
* The MIME Content-type of the message. |
|
* |
|
* @var string |
|
*/ |
|
public $ContentType = self::CONTENT_TYPE_PLAINTEXT; |
|
|
|
/** |
|
* The message encoding. |
|
* Options: "8bit", "7bit", "binary", "base64", and "quoted-printable". |
|
* |
|
* @var string |
|
*/ |
|
public $Encoding = self::ENCODING_8BIT; |
|
|
|
/** |
|
* Holds the most recent mailer error message. |
|
* |
|
* @var string |
|
*/ |
|
public $ErrorInfo = ''; |
|
|
|
/** |
|
* The From email address for the message. |
|
* |
|
* @var string |
|
*/ |
|
public $From = 'root@localhost'; |
|
|
|
/** |
|
* The From name of the message. |
|
* |
|
* @var string |
|
*/ |
|
public $FromName = 'Root User'; |
|
|
|
/** |
|
* The envelope sender of the message. |
|
* This will usually be turned into a Return-Path header by the receiver, |
|
* and is the address that bounces will be sent to. |
|
* If not empty, will be passed via `-f` to sendmail or as the 'MAIL FROM' value over SMTP. |
|
* |
|
* @var string |
|
*/ |
|
public $Sender = ''; |
|
|
|
/** |
|
* The Subject of the message. |
|
* |
|
* @var string |
|
*/ |
|
public $Subject = ''; |
|
|
|
/** |
|
* An HTML or plain text message body. |
|
* If HTML then call isHTML(true). |
|
* |
|
* @var string |
|
*/ |
|
public $Body = ''; |
|
|
|
/** |
|
* The plain-text message body. |
|
* This body can be read by mail clients that do not have HTML email |
|
* capability such as mutt & Eudora. |
|
* Clients that can read HTML will view the normal Body. |
|
* |
|
* @var string |
|
*/ |
|
public $AltBody = ''; |
|
|
|
/** |
|
* An iCal message part body. |
|
* Only supported in simple alt or alt_inline message types |
|
* To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator. |
|
* |
|
* @see http://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/ |
|
* @see http://kigkonsult.se/iCalcreator/ |
|
* |
|
* @var string |
|
*/ |
|
public $Ical = ''; |
|
|
|
/** |
|
* Value-array of "method" in Contenttype header "text/calendar" |
|
* |
|
* @var string[] |
|
*/ |
|
protected static $IcalMethods = [ |
|
self::ICAL_METHOD_REQUEST, |
|
self::ICAL_METHOD_PUBLISH, |
|
self::ICAL_METHOD_REPLY, |
|
self::ICAL_METHOD_ADD, |
|
self::ICAL_METHOD_CANCEL, |
|
self::ICAL_METHOD_REFRESH, |
|
self::ICAL_METHOD_COUNTER, |
|
self::ICAL_METHOD_DECLINECOUNTER, |
|
]; |
|
|
|
/** |
|
* The complete compiled MIME message body. |
|
* |
|
* @var string |
|
*/ |
|
protected $MIMEBody = ''; |
|
|
|
/** |
|
* The complete compiled MIME message headers. |
|
* |
|
* @var string |
|
*/ |
|
protected $MIMEHeader = ''; |
|
|
|
/** |
|
* Extra headers that createHeader() doesn't fold in. |
|
* |
|
* @var string |
|
*/ |
|
protected $mailHeader = ''; |
|
|
|
/** |
|
* Word-wrap the message body to this number of chars. |
|
* Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance. |
|
* |
|
* @see static::STD_LINE_LENGTH |
|
* |
|
* @var int |
|
*/ |
|
public $WordWrap = 0; |
|
|
|
/** |
|
* Which method to use to send mail. |
|
* Options: "mail", "sendmail", or "smtp". |
|
* |
|
* @var string |
|
*/ |
|
public $Mailer = 'mail'; |
|
|
|
/** |
|
* The path to the sendmail program. |
|
* |
|
* @var string |
|
*/ |
|
public $Sendmail = '/usr/sbin/sendmail'; |
|
|
|
/** |
|
* Whether mail() uses a fully sendmail-compatible MTA. |
|
* One which supports sendmail's "-oi -f" options. |
|
* |
|
* @var bool |
|
*/ |
|
public $UseSendmailOptions = true; |
|
|
|
/** |
|
* The email address that a reading confirmation should be sent to, also known as read receipt. |
|
* |
|
* @var string |
|
*/ |
|
public $ConfirmReadingTo = ''; |
|
|
|
/** |
|
* The hostname to use in the Message-ID header and as default HELO string. |
|
* If empty, PHPMailer attempts to find one with, in order, |
|
* $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value |
|
* 'localhost.localdomain'. |
|
* |
|
* @see PHPMailer::$Helo |
|
* |
|
* @var string |
|
*/ |
|
public $Hostname = ''; |
|
|
|
/** |
|
* An ID to be used in the Message-ID header. |
|
* If empty, a unique id will be generated. |
|
* You can set your own, but it must be in the format "<id@domain>", |
|
* as defined in RFC5322 section 3.6.4 or it will be ignored. |
|
* |
|
* @see https://tools.ietf.org/html/rfc5322#section-3.6.4 |
|
* |
|
* @var string |
|
*/ |
|
public $MessageID = ''; |
|
|
|
/** |
|
* The message Date to be used in the Date header. |
|
* If empty, the current date will be added. |
|
* |
|
* @var string |
|
*/ |
|
public $MessageDate = ''; |
|
|
|
/** |
|
* SMTP hosts. |
|
* Either a single hostname or multiple semicolon-delimited hostnames. |
|
* You can also specify a different port |
|
* for each host by using this format: [hostname:port] |
|
* (e.g. "smtp1.example.com:25;smtp2.example.com"). |
|
* You can also specify encryption type, for example: |
|
* (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465"). |
|
* Hosts will be tried in order. |
|
* |
|
* @var string |
|
*/ |
|
public $Host = 'localhost'; |
|
|
|
/** |
|
* The default SMTP server port. |
|
* |
|
* @var int |
|
*/ |
|
public $Port = 25; |
|
|
|
/** |
|
* The SMTP HELO/EHLO name used for the SMTP connection. |
|
* Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find |
|
* one with the same method described above for $Hostname. |
|
* |
|
* @see PHPMailer::$Hostname |
|
* |
|
* @var string |
|
*/ |
|
public $Helo = ''; |
|
|
|
/** |
|
* What kind of encryption to use on the SMTP connection. |
|
* Options: '', static::ENCRYPTION_STARTTLS, or static::ENCRYPTION_SMTPS. |
|
* |
|
* @var string |
|
*/ |
|
public $SMTPSecure = ''; |
|
|
|
/** |
|
* Whether to enable TLS encryption automatically if a server supports it, |
|
* even if `SMTPSecure` is not set to 'tls'. |
|
* Be aware that in PHP >= 5.6 this requires that the server's certificates are valid. |
|
* |
|
* @var bool |
|
*/ |
|
public $SMTPAutoTLS = true; |
|
|
|
/** |
|
* Whether to use SMTP authentication. |
|
* Uses the Username and Password properties. |
|
* |
|
* @see PHPMailer::$Username |
|
* @see PHPMailer::$Password |
|
* |
|
* @var bool |
|
*/ |
|
public $SMTPAuth = false; |
|
|
|
/** |
|
* Options array passed to stream_context_create when connecting via SMTP. |
|
* |
|
* @var array |
|
*/ |
|
public $SMTPOptions = []; |
|
|
|
/** |
|
* SMTP username. |
|
* |
|
* @var string |
|
*/ |
|
public $Username = ''; |
|
|
|
/** |
|
* SMTP password. |
|
* |
|
* @var string |
|
*/ |
|
public $Password = ''; |
|
|
|
/** |
|
* SMTP auth type. |
|
* Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2, attempted in that order if not specified. |
|
* |
|
* @var string |
|
*/ |
|
public $AuthType = ''; |
|
|
|
/** |
|
* An instance of the PHPMailer OAuth class. |
|
* |
|
* @var OAuth |
|
*/ |
|
protected $oauth; |
|
|
|
/** |
|
* The SMTP server timeout in seconds. |
|
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2. |
|
* |
|
* @var int |
|
*/ |
|
public $Timeout = 300; |
|
|
|
/** |
|
* Comma separated list of DSN notifications |
|
* 'NEVER' under no circumstances a DSN must be returned to the sender. |
|
* If you use NEVER all other notifications will be ignored. |
|
* 'SUCCESS' will notify you when your mail has arrived at its destination. |
|
* 'FAILURE' will arrive if an error occurred during delivery. |
|
* 'DELAY' will notify you if there is an unusual delay in delivery, but the actual |
|
* delivery's outcome (success or failure) is not yet decided. |
|
* |
|
* @see https://tools.ietf.org/html/rfc3461 See section 4.1 for more information about NOTIFY |
|
*/ |
|
public $dsn = ''; |
|
|
|
/** |
|
* SMTP class debug output mode. |
|
* Debug output level. |
|
* Options: |
|
* * SMTP::DEBUG_OFF: No output |
|
* * SMTP::DEBUG_CLIENT: Client messages |
|
* * SMTP::DEBUG_SERVER: Client and server messages |
|
* * SMTP::DEBUG_CONNECTION: As SERVER plus connection status |
|
* * SMTP::DEBUG_LOWLEVEL: Noisy, low-level data output, rarely needed |
|
* |
|
* @see SMTP::$do_debug |
|
* |
|
* @var int |
|
*/ |
|
public $SMTPDebug = 0; |
|
|
|
/** |
|
* How to handle debug output. |
|
* Options: |
|
* * `echo` Output plain-text as-is, appropriate for CLI |
|
* * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output |
|
* * `error_log` Output to error log as configured in php.ini |
|
* By default PHPMailer will use `echo` if run from a `cli` or `cli-server` SAPI, `html` otherwise. |
|
* Alternatively, you can provide a callable expecting two params: a message string and the debug level: |
|
* |
|
* ```php |
|
* $mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";}; |
|
* ``` |
|
* |
|
* Alternatively, you can pass in an instance of a PSR-3 compatible logger, though only `debug` |
|
* level output is used: |
|
* |
|
* ```php |
|
* $mail->Debugoutput = new myPsr3Logger; |
|
* ``` |
|
* |
|
* @see SMTP::$Debugoutput |
|
* |
|
* @var string|callable|\Psr\Log\LoggerInterface |
|
*/ |
|
public $Debugoutput = 'echo'; |
|
|
|
/** |
|
* Whether to keep SMTP connection open after each message. |
|
* If this is set to true then to close the connection |
|
* requires an explicit call to smtpClose(). |
|
* |
|
* @var bool |
|
*/ |
|
public $SMTPKeepAlive = false; |
|
|
|
/** |
|
* Whether to split multiple to addresses into multiple messages |
|
* or send them all in one message. |
|
* Only supported in `mail` and `sendmail` transports, not in SMTP. |
|
* |
|
* @var bool |
|
*/ |
|
public $SingleTo = false; |
|
|
|
/** |
|
* Storage for addresses when SingleTo is enabled. |
|
* |
|
* @var array |
|
*/ |
|
protected $SingleToArray = []; |
|
|
|
/** |
|
* Whether to generate VERP addresses on send. |
|
* Only applicable when sending via SMTP. |
|
* |
|
* @see https://en.wikipedia.org/wiki/Variable_envelope_return_path |
|
* @see http://www.postfix.org/VERP_README.html Postfix VERP info |
|
* |
|
* @var bool |
|
*/ |
|
public $do_verp = false; |
|
|
|
/** |
|
* Whether to allow sending messages with an empty body. |
|
* |
|
* @var bool |
|
*/ |
|
public $AllowEmpty = false; |
|
|
|
/** |
|
* DKIM selector. |
|
* |
|
* @var string |
|
*/ |
|
public $DKIM_selector = ''; |
|
|
|
/** |
|
* DKIM Identity. |
|
* Usually the email address used as the source of the email. |
|
* |
|
* @var string |
|
*/ |
|
public $DKIM_identity = ''; |
|
|
|
/** |
|
* DKIM passphrase. |
|
* Used if your key is encrypted. |
|
* |
|
* @var string |
|
*/ |
|
public $DKIM_passphrase = ''; |
|
|
|
/** |
|
* DKIM signing domain name. |
|
* |
|
* @example 'example.com' |
|
* |
|
* @var string |
|
*/ |
|
public $DKIM_domain = ''; |
|
|
|
/** |
|
* DKIM Copy header field values for diagnostic use. |
|
* |
|
* @var bool |
|
*/ |
|
public $DKIM_copyHeaderFields = true; |
|
|
|
/** |
|
* DKIM Extra signing headers. |
|
* |
|
* @example ['List-Unsubscribe', 'List-Help'] |
|
* |
|
* @var array |
|
*/ |
|
public $DKIM_extraHeaders = []; |
|
|
|
/** |
|
* DKIM private key file path. |
|
* |
|
* @var string |
|
*/ |
|
public $DKIM_private = ''; |
|
|
|
/** |
|
* DKIM private key string. |
|
* |
|
* If set, takes precedence over `$DKIM_private`. |
|
* |
|
* @var string |
|
*/ |
|
public $DKIM_private_string = ''; |
|
|
|
/** |
|
* Callback Action function name. |
|
* |
|
* The function that handles the result of the send email action. |
|
* It is called out by send() for each email sent. |
|
* |
|
* Value can be any php callable: http://www.php.net/is_callable |
|
* |
|
* Parameters: |
|
* bool $result result of the send action |
|
* array $to email addresses of the recipients |
|
* array $cc cc email addresses |
|
* array $bcc bcc email addresses |
|
* string $subject the subject |
|
* string $body the email body |
|
* string $from email address of sender |
|
* string $extra extra information of possible use |
|
* "smtp_transaction_id' => last smtp transaction id |
|
* |
|
* @var string |
|
*/ |
|
public $action_function = ''; |
|
|
|
/** |
|
* What to put in the X-Mailer header. |
|
* Options: An empty string for PHPMailer default, whitespace/null for none, or a string to use. |
|
* |
|
* @var string|null |
|
*/ |
|
public $XMailer = ''; |
|
|
|
/** |
|
* Which validator to use by default when validating email addresses. |
|
* May be a callable to inject your own validator, but there are several built-in validators. |
|
* The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option. |
|
* |
|
* @see PHPMailer::validateAddress() |
|
* |
|
* @var string|callable |
|
*/ |
|
public static $validator = 'php'; |
|
|
|
/** |
|
* An instance of the SMTP sender class. |
|
* |
|
* @var SMTP |
|
*/ |
|
protected $smtp; |
|
|
|
/** |
|
* The array of 'to' names and addresses. |
|
* |
|
* @var array |
|
*/ |
|
protected $to = []; |
|
|
|
/** |
|
* The array of 'cc' names and addresses. |
|
* |
|
* @var array |
|
*/ |
|
protected $cc = []; |
|
|
|
/** |
|
* The array of 'bcc' names and addresses. |
|
* |
|
* @var array |
|
*/ |
|
protected $bcc = []; |
|
|
|
/** |
|
* The array of reply-to names and addresses. |
|
* |
|
* @var array |
|
*/ |
|
protected $ReplyTo = []; |
|
|
|
/** |
|
* An array of all kinds of addresses. |
|
* Includes all of $to, $cc, $bcc. |
|
* |
|
* @see PHPMailer::$to |
|
* @see PHPMailer::$cc |
|
* @see PHPMailer::$bcc |
|
* |
|
* @var array |
|
*/ |
|
protected $all_recipients = []; |
|
|
|
/** |
|
* An array of names and addresses queued for validation. |
|
* In send(), valid and non duplicate entries are moved to $all_recipients |
|
* and one of $to, $cc, or $bcc. |
|
* This array is used only for addresses with IDN. |
|
* |
|
* @see PHPMailer::$to |
|
* @see PHPMailer::$cc |
|
* @see PHPMailer::$bcc |
|
* @see PHPMailer::$all_recipients |
|
* |
|
* @var array |
|
*/ |
|
protected $RecipientsQueue = []; |
|
|
|
/** |
|
* An array of reply-to names and addresses queued for validation. |
|
* In send(), valid and non duplicate entries are moved to $ReplyTo. |
|
* This array is used only for addresses with IDN. |
|
* |
|
* @see PHPMailer::$ReplyTo |
|
* |
|
* @var array |
|
*/ |
|
protected $ReplyToQueue = []; |
|
|
|
/** |
|
* The array of attachments. |
|
* |
|
* @var array |
|
*/ |
|
protected $attachment = []; |
|
|
|
/** |
|
* The array of custom headers. |
|
* |
|
* @var array |
|
*/ |
|
protected $CustomHeader = []; |
|
|
|
/** |
|
* The most recent Message-ID (including angular brackets). |
|
* |
|
* @var string |
|
*/ |
|
protected $lastMessageID = ''; |
|
|
|
/** |
|
* The message's MIME type. |
|
* |
|
* @var string |
|
*/ |
|
protected $message_type = ''; |
|
|
|
/** |
|
* The array of MIME boundary strings. |
|
* |
|
* @var array |
|
*/ |
|
protected $boundary = []; |
|
|
|
/** |
|
* The array of available languages. |
|
* |
|
* @var array |
|
*/ |
|
protected $language = []; |
|
|
|
/** |
|
* The number of errors encountered. |
|
* |
|
* @var int |
|
*/ |
|
protected $error_count = 0; |
|
|
|
/** |
|
* The S/MIME certificate file path. |
|
* |
|
* @var string |
|
*/ |
|
protected $sign_cert_file = ''; |
|
|
|
/** |
|
* The S/MIME key file path. |
|
* |
|
* @var string |
|
*/ |
|
protected $sign_key_file = ''; |
|
|
|
/** |
|
* The optional S/MIME extra certificates ("CA Chain") file path. |
|
* |
|
* @var string |
|
*/ |
|
protected $sign_extracerts_file = ''; |
|
|
|
/** |
|
* The S/MIME password for the key. |
|
* Used only if the key is encrypted. |
|
* |
|
* @var string |
|
*/ |
|
protected $sign_key_pass = ''; |
|
|
|
/** |
|
* Whether to throw exceptions for errors. |
|
* |
|
* @var bool |
|
*/ |
|
protected $exceptions = false; |
|
|
|
/** |
|
* Unique ID used for message ID and boundaries. |
|
* |
|
* @var string |
|
*/ |
|
protected $uniqueid = ''; |
|
|
|
/** |
|
* The PHPMailer Version number. |
|
* |
|
* @var string |
|
*/ |
|
const VERSION = '6.1.5'; |
|
|
|
/** |
|
* Error severity: message only, continue processing. |
|
* |
|
* @var int |
|
*/ |
|
const STOP_MESSAGE = 0; |
|
|
|
/** |
|
* Error severity: message, likely ok to continue processing. |
|
* |
|
* @var int |
|
*/ |
|
const STOP_CONTINUE = 1; |
|
|
|
/** |
|
* Error severity: message, plus full stop, critical error reached. |
|
* |
|
* @var int |
|
*/ |
|
const STOP_CRITICAL = 2; |
|
|
|
/** |
|
* The SMTP standard CRLF line break. |
|
* If you want to change line break format, change static::$LE, not this. |
|
*/ |
|
const CRLF = "\r\n"; |
|
|
|
/** |
|
* "Folding White Space" a white space string used for line folding. |
|
*/ |
|
const FWS = ' '; |
|
|
|
/** |
|
* SMTP RFC standard line ending; Carriage Return, Line Feed. |
|
* |
|
* @var string |
|
*/ |
|
protected static $LE = self::CRLF; |
|
|
|
/** |
|
* The maximum line length supported by mail(). |
|
* |
|
* Background: mail() will sometimes corrupt messages |
|
* with headers headers longer than 65 chars, see #818. |
|
* |
|
* @var int |
|
*/ |
|
const MAIL_MAX_LINE_LENGTH = 63; |
|
|
|
/** |
|
* The maximum line length allowed by RFC 2822 section 2.1.1. |
|
* |
|
* @var int |
|
*/ |
|
const MAX_LINE_LENGTH = 998; |
|
|
|
/** |
|
* The lower maximum line length allowed by RFC 2822 section 2.1.1. |
|
* This length does NOT include the line break |
|
* 76 means that lines will be 77 or 78 chars depending on whether |
|
* the line break format is LF or CRLF; both are valid. |
|
* |
|
* @var int |
|
*/ |
|
const STD_LINE_LENGTH = 76; |
|
|
|
/** |
|
* Constructor. |
|
* |
|
* @param bool $exceptions Should we throw external exceptions? |
|
*/ |
|
public function __construct($exceptions = null) |
|
{ |
|
if (null !== $exceptions) { |
|
$this->exceptions = (bool) $exceptions; |
|
} |
|
//Pick an appropriate debug output format automatically |
|
$this->Debugoutput = (strpos(PHP_SAPI, 'cli') !== false ? 'echo' : 'html'); |
|
} |
|
|
|
/** |
|
* Destructor. |
|
*/ |
|
public function __destruct() |
|
{ |
|
//Close any open SMTP connection nicely |
|
$this->smtpClose(); |
|
} |
|
|
|
/** |
|
* Call mail() in a safe_mode-aware fashion. |
|
* Also, unless sendmail_path points to sendmail (or something that |
|
* claims to be sendmail), don't pass params (not a perfect fix, |
|
* but it will do). |
|
* |
|
* @param string $to To |
|
* @param string $subject Subject |
|
* @param string $body Message Body |
|
* @param string $header Additional Header(s) |
|
* @param string|null $params Params |
|
* |
|
* @return bool |
|
*/ |
|
private function mailPassthru($to, $subject, $body, $header, $params) |
|
{ |
|
//Check overloading of mail function to avoid double-encoding |
|
if (ini_get('mbstring.func_overload') & 1) { |
|
$subject = $this->secureHeader($subject); |
|
} else { |
|
$subject = $this->encodeHeader($this->secureHeader($subject)); |
|
} |
|
//Calling mail() with null params breaks |
|
if (!$this->UseSendmailOptions || null === $params) { |
|
$result = @mail($to, $subject, $body, $header); |
|
} else { |
|
$result = @mail($to, $subject, $body, $header, $params); |
|
} |
|
|
|
return $result; |
|
} |
|
|
|
/** |
|
* Output debugging info via user-defined method. |
|
* Only generates output if SMTP debug output is enabled (@see SMTP::$do_debug). |
|
* |
|
* @see PHPMailer::$Debugoutput |
|
* @see PHPMailer::$SMTPDebug |
|
* |
|
* @param string $str |
|
*/ |
|
protected function edebug($str) |
|
{ |
|
if ($this->SMTPDebug <= 0) { |
|
return; |
|
} |
|
//Is this a PSR-3 logger? |
|
if ($this->Debugoutput instanceof \Psr\Log\LoggerInterface) { |
|
$this->Debugoutput->debug($str); |
|
|
|
return; |
|
} |
|
//Avoid clash with built-in function names |
|
if (is_callable($this->Debugoutput) && !in_array($this->Debugoutput, ['error_log', 'html', 'echo'])) { |
|
call_user_func($this->Debugoutput, $str, $this->SMTPDebug); |
|
|
|
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' |
|
), "<br>\n"; |
|
break; |
|
case 'echo': |
|
default: |
|
//Normalize line breaks |
|
$str = preg_replace('/\r\n|\r/m', "\n", $str); |
|
echo gmdate('Y-m-d H:i:s'), |
|
"\t", |
|
//Trim trailing space |
|
trim( |
|
//Indent for readability, except for trailing break |
|
str_replace( |
|
"\n", |
|
"\n \t ", |
|
trim($str) |
|
) |
|
), |
|
"\n"; |
|
} |
|
} |
|
|
|
/** |
|
* Sets message type to HTML or plain. |
|
* |
|
* @param bool $isHtml True for HTML mode |
|
*/ |
|
public function isHTML($isHtml = true) |
|
{ |
|
if ($isHtml) { |
|
$this->ContentType = static::CONTENT_TYPE_TEXT_HTML; |
|
} else { |
|
$this->ContentType = static::CONTENT_TYPE_PLAINTEXT; |
|
} |
|
} |
|
|
|
/** |
|
* Send messages using SMTP. |
|
*/ |
|
public function isSMTP() |
|
{ |
|
$this->Mailer = 'smtp'; |
|
} |
|
|
|
/** |
|
* Send messages using PHP's mail() function. |
|
*/ |
|
public function isMail() |
|
{ |
|
$this->Mailer = 'mail'; |
|
} |
|
|
|
/** |
|
* Send messages using $Sendmail. |
|
*/ |
|
public function isSendmail() |
|
{ |
|
$ini_sendmail_path = ini_get('sendmail_path'); |
|
|
|
if (false === stripos($ini_sendmail_path, 'sendmail')) { |
|
$this->Sendmail = '/usr/sbin/sendmail'; |
|
} else { |
|
$this->Sendmail = $ini_sendmail_path; |
|
} |
|
$this->Mailer = 'sendmail'; |
|
} |
|
|
|
/** |
|
* Send messages using qmail. |
|
*/ |
|
public function isQmail() |
|
{ |
|
$ini_sendmail_path = ini_get('sendmail_path'); |
|
|
|
if (false === stripos($ini_sendmail_path, 'qmail')) { |
|
$this->Sendmail = '/var/qmail/bin/qmail-inject'; |
|
} else { |
|
$this->Sendmail = $ini_sendmail_path; |
|
} |
|
$this->Mailer = 'qmail'; |
|
} |
|
|
|
/** |
|
* Add a "To" address. |
|
* |
|
* @param string $address The email address to send to |
|
* @param string $name |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool true on success, false if address already used or invalid in some way |
|
*/ |
|
public function addAddress($address, $name = '') |
|
{ |
|
return $this->addOrEnqueueAnAddress('to', $address, $name); |
|
} |
|
|
|
/** |
|
* Add a "CC" address. |
|
* |
|
* @param string $address The email address to send to |
|
* @param string $name |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool true on success, false if address already used or invalid in some way |
|
*/ |
|
public function addCC($address, $name = '') |
|
{ |
|
return $this->addOrEnqueueAnAddress('cc', $address, $name); |
|
} |
|
|
|
/** |
|
* Add a "BCC" address. |
|
* |
|
* @param string $address The email address to send to |
|
* @param string $name |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool true on success, false if address already used or invalid in some way |
|
*/ |
|
public function addBCC($address, $name = '') |
|
{ |
|
return $this->addOrEnqueueAnAddress('bcc', $address, $name); |
|
} |
|
|
|
/** |
|
* Add a "Reply-To" address. |
|
* |
|
* @param string $address The email address to reply to |
|
* @param string $name |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool true on success, false if address already used or invalid in some way |
|
*/ |
|
public function addReplyTo($address, $name = '') |
|
{ |
|
return $this->addOrEnqueueAnAddress('Reply-To', $address, $name); |
|
} |
|
|
|
/** |
|
* Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer |
|
* can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still |
|
* be modified after calling this function), addition of such addresses is delayed until send(). |
|
* Addresses that have been added already return false, but do not throw exceptions. |
|
* |
|
* @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo' |
|
* @param string $address The email address to send, resp. to reply to |
|
* @param string $name |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool true on success, false if address already used or invalid in some way |
|
*/ |
|
protected function addOrEnqueueAnAddress($kind, $address, $name) |
|
{ |
|
$address = trim($address); |
|
$name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim |
|
$pos = strrpos($address, '@'); |
|
if (false === $pos) { |
|
// At-sign is missing. |
|
$error_message = sprintf( |
|
'%s (%s): %s', |
|
$this->lang('invalid_address'), |
|
$kind, |
|
$address |
|
); |
|
$this->setError($error_message); |
|
$this->edebug($error_message); |
|
if ($this->exceptions) { |
|
throw new Exception($error_message); |
|
} |
|
|
|
return false; |
|
} |
|
$params = [$kind, $address, $name]; |
|
// Enqueue addresses with IDN until we know the PHPMailer::$CharSet. |
|
if (static::idnSupported() && $this->has8bitChars(substr($address, ++$pos))) { |
|
if ('Reply-To' !== $kind) { |
|
if (!array_key_exists($address, $this->RecipientsQueue)) { |
|
$this->RecipientsQueue[$address] = $params; |
|
|
|
return true; |
|
} |
|
} elseif (!array_key_exists($address, $this->ReplyToQueue)) { |
|
$this->ReplyToQueue[$address] = $params; |
|
|
|
return true; |
|
} |
|
|
|
return false; |
|
} |
|
|
|
// Immediately add standard addresses without IDN. |
|
return call_user_func_array([$this, 'addAnAddress'], $params); |
|
} |
|
|
|
/** |
|
* Add an address to one of the recipient arrays or to the ReplyTo array. |
|
* Addresses that have been added already return false, but do not throw exceptions. |
|
* |
|
* @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo' |
|
* @param string $address The email address to send, resp. to reply to |
|
* @param string $name |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool true on success, false if address already used or invalid in some way |
|
*/ |
|
protected function addAnAddress($kind, $address, $name = '') |
|
{ |
|
if (!in_array($kind, ['to', 'cc', 'bcc', 'Reply-To'])) { |
|
$error_message = sprintf( |
|
'%s: %s', |
|
$this->lang('Invalid recipient kind'), |
|
$kind |
|
); |
|
$this->setError($error_message); |
|
$this->edebug($error_message); |
|
if ($this->exceptions) { |
|
throw new Exception($error_message); |
|
} |
|
|
|
return false; |
|
} |
|
if (!static::validateAddress($address)) { |
|
$error_message = sprintf( |
|
'%s (%s): %s', |
|
$this->lang('invalid_address'), |
|
$kind, |
|
$address |
|
); |
|
$this->setError($error_message); |
|
$this->edebug($error_message); |
|
if ($this->exceptions) { |
|
throw new Exception($error_message); |
|
} |
|
|
|
return false; |
|
} |
|
if ('Reply-To' !== $kind) { |
|
if (!array_key_exists(strtolower($address), $this->all_recipients)) { |
|
$this->{$kind}[] = [$address, $name]; |
|
$this->all_recipients[strtolower($address)] = true; |
|
|
|
return true; |
|
} |
|
} elseif (!array_key_exists(strtolower($address), $this->ReplyTo)) { |
|
$this->ReplyTo[strtolower($address)] = [$address, $name]; |
|
|
|
return true; |
|
} |
|
|
|
return false; |
|
} |
|
|
|
/** |
|
* Parse and validate a string containing one or more RFC822-style comma-separated email addresses |
|
* of the form "display name <address>" into an array of name/address pairs. |
|
* Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available. |
|
* Note that quotes in the name part are removed. |
|
* |
|
* @see http://www.andrew.cmu.edu/user/agreen1/testing/mrbs/web/Mail/RFC822.php A more careful implementation |
|
* |
|
* @param string $addrstr The address list string |
|
* @param bool $useimap Whether to use the IMAP extension to parse the list |
|
* |
|
* @return array |
|
*/ |
|
public static function parseAddresses($addrstr, $useimap = true) |
|
{ |
|
$addresses = []; |
|
if ($useimap && function_exists('imap_rfc822_parse_adrlist')) { |
|
//Use this built-in parser if it's available |
|
$list = imap_rfc822_parse_adrlist($addrstr, ''); |
|
foreach ($list as $address) { |
|
if (('.SYNTAX-ERROR.' !== $address->host) && static::validateAddress( |
|
$address->mailbox . '@' . $address->host |
|
)) { |
|
$addresses[] = [ |
|
'name' => (property_exists($address, 'personal') ? $address->personal : ''), |
|
'address' => $address->mailbox . '@' . $address->host, |
|
]; |
|
} |
|
} |
|
} else { |
|
//Use this simpler parser |
|
$list = explode(',', $addrstr); |
|
foreach ($list as $address) { |
|
$address = trim($address); |
|
//Is there a separate name part? |
|
if (strpos($address, '<') === false) { |
|
//No separate name, just use the whole thing |
|
if (static::validateAddress($address)) { |
|
$addresses[] = [ |
|
'name' => '', |
|
'address' => $address, |
|
]; |
|
} |
|
} else { |
|
list($name, $email) = explode('<', $address); |
|
$email = trim(str_replace('>', '', $email)); |
|
if (static::validateAddress($email)) { |
|
$addresses[] = [ |
|
'name' => trim(str_replace(['"', "'"], '', $name)), |
|
'address' => $email, |
|
]; |
|
} |
|
} |
|
} |
|
} |
|
|
|
return $addresses; |
|
} |
|
|
|
/** |
|
* Set the From and FromName properties. |
|
* |
|
* @param string $address |
|
* @param string $name |
|
* @param bool $auto Whether to also set the Sender address, defaults to true |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool |
|
*/ |
|
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(). |
|
$pos = strrpos($address, '@'); |
|
if ((false === $pos) |
|
|| ((!$this->has8bitChars(substr($address, ++$pos)) || !static::idnSupported()) |
|
&& !static::validateAddress($address)) |
|
) { |
|
$error_message = sprintf( |
|
'%s (From): %s', |
|
$this->lang('invalid_address'), |
|
$address |
|
); |
|
$this->setError($error_message); |
|
$this->edebug($error_message); |
|
if ($this->exceptions) { |
|
throw new Exception($error_message); |
|
} |
|
|
|
return false; |
|
} |
|
$this->From = $address; |
|
$this->FromName = $name; |
|
if ($auto && 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. |
|
* Validation patterns supported: |
|
* * `auto` Pick best pattern automatically; |
|
* * `pcre8` Use the squiloople.com pattern, requires PCRE > 8.0; |
|
* * `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: |
|
* |
|
* ```php |
|
* 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. |
|
* |
|
* @param string $address The email address to check |
|
* @param string|callable $patternselect Which pattern to use |
|
* |
|
* @return bool |
|
*/ |
|
public static function validateAddress($address, $patternselect = null) |
|
{ |
|
if (null === $patternselect) { |
|
$patternselect = static::$validator; |
|
} |
|
if (is_callable($patternselect)) { |
|
return $patternselect($address); |
|
} |
|
//Reject line breaks in addresses; it's valid RFC5322, but not RFC5321 |
|
if (strpos($address, "\n") !== false || strpos($address, "\r") !== false) { |
|
return false; |
|
} |
|
switch ($patternselect) { |
|
case 'pcre': //Kept for BC |
|
case 'pcre8': |
|
/* |
|
* A more complex and more permissive version of the RFC5322 regex on which FILTER_VALIDATE_EMAIL |
|
* is based. |
|
* In addition to the addresses allowed by filter_var, also permits: |
|
* * dotless domains: `a@b` |
|
* * comments: `1234 @ local(blah) .machine .example` |
|
* * quoted elements: `'"test blah"@example.org'` |
|
* * numeric TLDs: `a@b.123` |
|
* * unbracketed IPv4 literals: `a@192.168.0.1` |
|
* * IPv6 literals: 'first.last@[IPv6:a1::]' |
|
* Not all of these will necessarily work for sending! |
|
* |
|
* @see 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 (bool) 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 'html5': |
|
/* |
|
* This is the pattern used in the HTML5 spec for validation of 'email' type form input elements. |
|
* |
|
* @see http://www.whatwg.org/specs/web-apps/current-work/#e-mail-state-(type=email) |
|
*/ |
|
return (bool) preg_match( |
|
'/^[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}' . |
|
'[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/sD', |
|
$address |
|
); |
|
case 'php': |
|
default: |
|
return filter_var($address, FILTER_VALIDATE_EMAIL) !== false; |
|
} |
|
} |
|
|
|
/** |
|
* 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 static function idnSupported() |
|
{ |
|
return function_exists('idn_to_ascii') && 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 contains 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. |
|
$pos = strrpos($address, '@'); |
|
if (!empty($this->CharSet) && |
|
false !== $pos && |
|
static::idnSupported() |
|
) { |
|
$domain = substr($address, ++$pos); |
|
// Verify CharSet string is a valid one, and domain properly encoded in this CharSet. |
|
if ($this->has8bitChars($domain) && @mb_check_encoding($domain, $this->CharSet)) { |
|
$domain = mb_convert_encoding($domain, 'UTF-8', $this->CharSet); |
|
//Ignore IDE complaints about this line - method signature changed in PHP 5.4 |
|
$errorcode = 0; |
|
if (defined('INTL_IDNA_VARIANT_UTS46')) { |
|
$punycode = idn_to_ascii($domain, $errorcode, INTL_IDNA_VARIANT_UTS46); |
|
} elseif (defined('INTL_IDNA_VARIANT_2003')) { |
|
$punycode = idn_to_ascii($domain, $errorcode, INTL_IDNA_VARIANT_2003); |
|
} else { |
|
$punycode = idn_to_ascii($domain, $errorcode); |
|
} |
|
if (false !== $punycode) { |
|
return substr($address, 0, $pos) . $punycode; |
|
} |
|
} |
|
} |
|
|
|
return $address; |
|
} |
|
|
|
/** |
|
* Create a message and send it. |
|
* Uses the sending method specified by $Mailer. |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool 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 (Exception $exc) { |
|
$this->mailHeader = ''; |
|
$this->setError($exc->getMessage()); |
|
if ($this->exceptions) { |
|
throw $exc; |
|
} |
|
|
|
return false; |
|
} |
|
} |
|
|
|
/** |
|
* Prepare a message for sending. |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool |
|
*/ |
|
public function preSend() |
|
{ |
|
if ('smtp' === $this->Mailer |
|
|| ('mail' === $this->Mailer && stripos(PHP_OS, 'WIN') === 0) |
|
) { |
|
//SMTP mandates RFC-compliant line endings |
|
//and it's also used with mail() on Windows |
|
static::setLE(self::CRLF); |
|
} else { |
|
//Maintain backward compatibility with legacy Linux command line mailers |
|
static::setLE(PHP_EOL); |
|
} |
|
//Check for buggy PHP versions that add a header with an incorrect line break |
|
if ('mail' === $this->Mailer |
|
&& ((PHP_VERSION_ID >= 70000 && PHP_VERSION_ID < 70017) |
|
|| (PHP_VERSION_ID >= 70100 && PHP_VERSION_ID < 70103)) |
|
&& ini_get('mail.add_x_header') === '1' |
|
&& stripos(PHP_OS, 'WIN') === 0 |
|
) { |
|
trigger_error( |
|
'Your version of PHP is affected by a bug that may result in corrupted messages.' . |
|
' To fix it, switch to sending using SMTP, disable the mail.add_x_header option in' . |
|
' your php.ini, switch to MacOS or Linux, or upgrade your PHP to version 7.0.17+ or 7.1.3+.', |
|
E_USER_WARNING |
|
); |
|
} |
|
|
|
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([$this, 'addAnAddress'], $params); |
|
} |
|
if (count($this->to) + count($this->cc) + count($this->bcc) < 1) { |
|
throw new Exception($this->lang('provide_address'), self::STOP_CRITICAL); |
|
} |
|
|
|
// Validate From, Sender, and ConfirmReadingTo addresses |
|
foreach (['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 (!static::validateAddress($this->$address_kind)) { |
|
$error_message = sprintf( |
|
'%s (%s): %s', |
|
$this->lang('invalid_address'), |
|
$address_kind, |
|
$this->$address_kind |
|
); |
|
$this->setError($error_message); |
|
$this->edebug($error_message); |
|
if ($this->exceptions) { |
|
throw new Exception($error_message); |
|
} |
|
|
|
return false; |
|
} |
|
} |
|
|
|
// Set whether the message is multipart/alternative |
|
if ($this->alternativeExists()) { |
|
$this->ContentType = static::CONTENT_TYPE_MULTIPART_ALTERNATIVE; |
|
} |
|
|
|
$this->setMessageType(); |
|
// Refuse to send an empty message unless we are specifically allowing it |
|
if (!$this->AllowEmpty && empty($this->Body)) { |
|
throw new Exception($this->lang('empty_message'), self::STOP_CRITICAL); |
|
} |
|
|
|
//Trim subject consistently |
|
$this->Subject = trim($this->Subject); |
|
// 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 ('mail' === $this->Mailer) { |
|
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($this->Subject)) |
|
); |
|
} |
|
|
|
// Sign with DKIM if enabled |
|
if (!empty($this->DKIM_domain) |
|
&& !empty($this->DKIM_selector) |
|
&& (!empty($this->DKIM_private_string) |
|
|| (!empty($this->DKIM_private) |
|
&& static::isPermittedPath($this->DKIM_private) |
|
&& file_exists($this->DKIM_private) |
|
) |
|
) |
|
) { |
|
$header_dkim = $this->DKIM_Add( |
|
$this->MIMEHeader . $this->mailHeader, |
|
$this->encodeHeader($this->secureHeader($this->Subject)), |
|
$this->MIMEBody |
|
); |
|
$this->MIMEHeader = static::stripTrailingWSP($this->MIMEHeader) . static::$LE . |
|
static::normalizeBreaks($header_dkim) . static::$LE; |
|
} |
|
|
|
return true; |
|
} catch (Exception $exc) { |
|
$this->setError($exc->getMessage()); |
|
if ($this->exceptions) { |
|
throw $exc; |
|
} |
|
|
|
return false; |
|
} |
|
} |
|
|
|
/** |
|
* Actually send a message via the selected mechanism. |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool |
|
*/ |
|
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 (Exception $exc) { |
|
$this->setError($exc->getMessage()); |
|
$this->edebug($exc->getMessage()); |
|
if ($this->exceptions) { |
|
throw $exc; |
|
} |
|
} |
|
|
|
return false; |
|
} |
|
|
|
/** |
|
* Send mail using the $Sendmail program. |
|
* |
|
* @see PHPMailer::$Sendmail |
|
* |
|
* @param string $header The message headers |
|
* @param string $body The message body |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool |
|
*/ |
|
protected function sendmailSend($header, $body) |
|
{ |
|
$header = static::stripTrailingWSP($header) . static::$LE . static::$LE; |
|
|
|
// CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped. |
|
if (!empty($this->Sender) && self::isShellSafe($this->Sender)) { |
|
if ('qmail' === $this->Mailer) { |
|
$sendmailFmt = '%s -f%s'; |
|
} else { |
|
$sendmailFmt = '%s -oi -f%s -t'; |
|
} |
|
} elseif ('qmail' === $this->Mailer) { |
|
$sendmailFmt = '%s'; |
|
} else { |
|
$sendmailFmt = '%s -oi -t'; |
|
} |
|
|
|
$sendmail = sprintf($sendmailFmt, escapeshellcmd($this->Sendmail), $this->Sender); |
|
|
|
if ($this->SingleTo) { |
|
foreach ($this->SingleToArray as $toAddr) { |
|
$mail = @popen($sendmail, 'w'); |
|
if (!$mail) { |
|
throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); |
|
} |
|
fwrite($mail, 'To: ' . $toAddr . "\n"); |
|
fwrite($mail, $header); |
|
fwrite($mail, $body); |
|
$result = pclose($mail); |
|
$this->doCallback( |
|
($result === 0), |
|
[$toAddr], |
|
$this->cc, |
|
$this->bcc, |
|
$this->Subject, |
|
$body, |
|
$this->From, |
|
[] |
|
); |
|
if (0 !== $result) { |
|
throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); |
|
} |
|
} |
|
} else { |
|
$mail = @popen($sendmail, 'w'); |
|
if (!$mail) { |
|
throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); |
|
} |
|
fwrite($mail, $header); |
|
fwrite($mail, $body); |
|
$result = pclose($mail); |
|
$this->doCallback( |
|
($result === 0), |
|
$this->to, |
|
$this->cc, |
|
$this->bcc, |
|
$this->Subject, |
|
$body, |
|
$this->From, |
|
[] |
|
); |
|
if (0 !== $result) { |
|
throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); |
|
} |
|
} |
|
|
|
return true; |
|
} |
|
|
|
/** |
|
* Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters. |
|
* Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows. |
|
* |
|
* @see https://github.com/PHPMailer/PHPMailer/issues/924 CVE-2016-10045 bug report |
|
* |
|
* @param string $string The string to be validated |
|
* |
|
* @return bool |
|
*/ |
|
protected static function isShellSafe($string) |
|
{ |
|
// Future-proof |
|
if (escapeshellcmd($string) !== $string |
|
|| !in_array(escapeshellarg($string), ["'$string'", "\"$string\""]) |
|
) { |
|
return false; |
|
} |
|
|
|
$length = strlen($string); |
|
|
|
for ($i = 0; $i < $length; ++$i) { |
|
$c = $string[$i]; |
|
|
|
// All other characters have a special meaning in at least one common shell, including = and +. |
|
// Full stop (.) has a special meaning in cmd.exe, but its impact should be negligible here. |
|
// Note that this does permit non-Latin alphanumeric characters based on the current locale. |
|
if (!ctype_alnum($c) && strpos('@_-.', $c) === false) { |
|
return false; |
|
} |
|
} |
|
|
|
return true; |
|
} |
|
|
|
/** |
|
* Check whether a file path is of a permitted type. |
|
* Used to reject URLs and phar files from functions that access local file paths, |
|
* such as addAttachment. |
|
* |
|
* @param string $path A relative or absolute path to a file |
|
* |
|
* @return bool |
|
*/ |
|
protected static function isPermittedPath($path) |
|
{ |
|
return !preg_match('#^[a-z]+://#i', $path); |
|
} |
|
|
|
/** |
|
* Send mail using the PHP mail() function. |
|
* |
|
* @see http://www.php.net/manual/en/book.mail.php |
|
* |
|
* @param string $header The message headers |
|
* @param string $body The message body |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool |
|
*/ |
|
protected function mailSend($header, $body) |
|
{ |
|
$header = static::stripTrailingWSP($header) . static::$LE . static::$LE; |
|
|
|
$toArr = []; |
|
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 |
|
//A space after `-f` is optional, but there is a long history of its presence |
|
//causing problems, so we don't use one |
|
//Exim docs: http://www.exim.org/exim-html-current/doc/html/spec_html/ch-the_exim_command_line.html |
|
//Sendmail docs: http://www.sendmail.org/~ca/email/man/sendmail.html |
|
//Qmail docs: http://www.qmail.org/man/man8/qmail-inject.html |
|
//Example problem: https://www.drupal.org/node/1057954 |
|
// CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped. |
|
if (!empty($this->Sender) && static::validateAddress($this->Sender) && self::isShellSafe($this->Sender)) { |
|
$params = sprintf('-f%s', $this->Sender); |
|
} |
|
if (!empty($this->Sender) && static::validateAddress($this->Sender)) { |
|
$old_from = ini_get('sendmail_from'); |
|
ini_set('sendmail_from', $this->Sender); |
|
} |
|
$result = false; |
|
if ($this->SingleTo && count($toArr) > 1) { |
|
foreach ($toArr as $toAddr) { |
|
$result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params); |
|
$this->doCallback($result, [$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 Exception($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, |
|
* or set one with setSMTPInstance. |
|
* |
|
* @return SMTP |
|
*/ |
|
public function getSMTPInstance() |
|
{ |
|
if (!is_object($this->smtp)) { |
|
$this->smtp = new SMTP(); |
|
} |
|
|
|
return $this->smtp; |
|
} |
|
|
|
/** |
|
* Provide an instance to use for SMTP operations. |
|
* |
|
* @return SMTP |
|
*/ |
|
public function setSMTPInstance(SMTP $smtp) |
|
{ |
|
$this->smtp = $smtp; |
|
|
|
return $this->smtp; |
|
} |
|
|
|
/** |
|
* Send mail via SMTP. |
|
* Returns false if there is a bad MAIL FROM, RCPT, or DATA input. |
|
* |
|
* @see PHPMailer::setSMTPInstance() to use a different class. |
|
* |
|
* @uses \PHPMailer\PHPMailer\SMTP |
|
* |
|
* @param string $header The message headers |
|
* @param string $body The message body |
|
* |
|
* @throws Exception |
|
* |
|
* @return bool |
|
*/ |
|
protected function smtpSend($header, $body) |
|
{ |
|
$header = static::stripTrailingWSP($header) . static::$LE . static::$LE; |
|
$bad_rcpt = []; |
|
if (!$this->smtpConnect($this->SMTPOptions)) { |
|
throw new Exception($this->lang('smtp_connect_failed'), self::STOP_CRITICAL); |
|
} |
|
//Sender already validated in preSend() |
|
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 Exception($this->ErrorInfo, self::STOP_CRITICAL); |
|
} |
|
|
|
$callbacks = []; |
|
// Attempt to send to all recipients |
|
foreach ([$this->to, $this->cc, $this->bcc] as $togroup) { |
|
foreach ($togroup as $to) { |
|
if (!$this->smtp->recipient($to[0], $this->dsn)) { |
|
$error = $this->smtp->getError(); |
|
$bad_rcpt[] = ['to' => $to[0], 'error' => $error['detail']]; |
|
$isSent = false; |
|
} else { |
|
$isSent = true; |
|
} |
|
|
|
$callbacks[] = ['issent'=>$isSent, 'to'=>$to[0]]; |
|
} |
|
} |
|
|
|
// Only send the DATA command if we have viable recipients |
|
if ((count($this->all_recipients) > count($bad_rcpt)) && !$this->smtp->data($header . $body)) { |
|
throw new Exception($this->lang('data_not_accepted'), self::STOP_CRITICAL); |
|
} |
|
|
|
$smtp_transaction_id = $this->smtp->getLastTransactionID(); |
|
|
|
if ($this->SMTPKeepAlive) { |
|
$this->smtp->reset(); |
|
} else { |
|
$this->smtp->quit(); |
|
$this->smtp->close(); |
|
} |
|
|
|
foreach ($callbacks as $cb) { |
|
$this->doCallback( |
|
$cb['issent'], |
|
[$cb['to']], |
|
[], |
|
[], |
|
$this->Subject, |
|
$body, |
|
$this->From, |
|
['smtp_transaction_id' => $smtp_transaction_id] |
|
); |
|
} |
|
|
|
//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 Exception($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() |
|
* |
|
* @throws Exception |
|
* |
|
* @uses \PHPMailer\PHPMailer\SMTP |
|
* |
|
* @return bool |
|
*/ |
|
public function smtpConnect($options = null) |
|
{ |
|
if (null === $this->smtp) { |
|
$this->smtp = $this->getSMTPInstance(); |
|
} |
|
|
|
//If no options are provided, use whatever is set in the instance |
|
if (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 = []; |
|
if (!preg_match( |
|
'/^(?:(ssl|tls):\/\/)?(.+?)(?::(\d+))?$/', |
|
trim($hostentry), |
|
$hostinfo |
|
)) { |
|
$this->edebug($this->lang('invalid_hostentry') . ' ' . trim($hostentry)); |
|
// Not a valid host entry |
|
continue; |
|
} |
|
// $hostinfo[1]: optional ssl or tls prefix |
|
// $hostinfo[2]: the hostname |
|
// $hostinfo[3]: 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 |
|
|
|
//Check the host name is a valid name or IP address before trying to use it |
|
if (!static::isValidHost($hostinfo[2])) { |
|
$this->edebug($this->lang('invalid_host') . ' ' . $hostinfo[2]); |
|
continue; |
|
} |
|
$prefix = ''; |
|
$secure = $this->SMTPSecure; |
|
$tls = (static::ENCRYPTION_STARTTLS === $this->SMTPSecure); |
|
if ('ssl' === $hostinfo[1] || ('' === $hostinfo[1] && static::ENCRYPTION_SMTPS === $this->SMTPSecure)) { |
|
$prefix = 'ssl://'; |
|
$tls = false; // Can't have SSL and TLS at the same time |
|
$secure = static::ENCRYPTION_SMTPS; |
|
} elseif ('tls' === $hostinfo[1]) { |
|
$tls = true; |
|
// tls doesn't use a prefix |
|
$secure = static::ENCRYPTION_STARTTLS; |
|
} |
|
//Do we need the OpenSSL extension? |
|
$sslext = defined('OPENSSL_ALGO_SHA256'); |
|
if (static::ENCRYPTION_STARTTLS === $secure || static::ENCRYPTION_SMTPS === $secure) { |
|
//Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled |
|
if (!$sslext) { |
|
throw new Exception($this->lang('extension_missing') . 'openssl', self::STOP_CRITICAL); |
|
} |
|
} |
|
$host = $hostinfo[2]; |
|
$port = $this->Port; |
|
if (array_key_exists(3, $hostinfo) && is_numeric($hostinfo[3]) && $hostinfo[3] > 0 && $hostinfo[3] < 65536) { |
|
$port = (int) $hostinfo[3]; |
|
} |
|
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 && $sslext && 'ssl' !== $secure && $this->smtp->getServerExt('STARTTLS')) { |
|
$tls = true; |
|
} |
|
if ($tls) { |
|
if (!$this->smtp->startTLS()) { |
|
throw new Exception($this->lang('connect_host')); |
|
} |
|
// We must resend EHLO after TLS negotiation |
|
$this->smtp->hello($hello); |
|
} |
|
if ($this->SMTPAuth && !$this->smtp->authenticate( |
|
$this->Username, |
|
$this->Password, |
|
$this->AuthType, |
|
$this->oauth |
|
)) { |
|
throw new Exception($this->lang('authenticate')); |
|
} |
|
|
|
return true; |
|
} catch (Exception $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 && null !== $lastexception) { |
|
throw $lastexception; |
|
} |
|
|
|
return false; |
|
} |
|
|
|
/** |
|
* Close the active SMTP session if one exists. |
|
*/ |
|
public function smtpClose() |
|
{ |
|
if ((null !== $this->smtp) && $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 bool |
|
*/ |
|
public function setLanguage($langcode = 'en', $lang_path = '') |
|
{ |
|
// Backwards compatibility for renamed language codes |
|
$renamed_langcodes = [ |
|
'br' => 'pt_br', |
|
'cz' => 'cs', |
|
'dk' => 'da', |
|
'no' => 'nb', |
|
'se' => 'sv', |
|
'rs' => 'sr', |
|
'tg' => 'tl', |
|
'am' => 'hy', |
|
]; |
|
|
|
if (isset($renamed_langcodes[$langcode])) { |
|
$langcode = $renamed_langcodes[$langcode]; |
|
} |
|
|
|
// Define full set of translatable strings in English |
|
$PHPMAILER_LANG = [ |
|
'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: ', |
|
'invalid_hostentry' => 'Invalid hostentry: ', |
|
'invalid_host' => 'Invalid host: ', |
|
'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(__DIR__) . DIRECTORY_SEPARATOR . 'language' . DIRECTORY_SEPARATOR; |
|
} |
|
//Validate $langcode |
|
if (!preg_match('/^[a-z]{2}(?:_[a-zA-Z]{2})?$/', $langcode)) { |
|
$langcode = 'en'; |
|
} |
|
$foundlang = true; |
|
$lang_file = $lang_path . 'phpmailer.lang-' . $langcode . '.php'; |
|
// There is no English translation file |
|
if ('en' !== $langcode) { |
|
// Make sure language file path is readable |
|
if (!static::isPermittedPath($lang_file) || !file_exists($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 (bool) $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. |
|
* |
|
* @param string $type |
|
* @param array $addr An array of recipients, |
|
* where each recipient is a 2-element indexed array with element 0 containing an address |
|
* and element 1 containing a name, like: |
|
* [['joe@example.com', 'Joe User'], ['zoe@example.com', 'Zoe User']] |
|
* |
|
* @return string |
|
*/ |
|
public function addrAppend($type, $addr) |
|
{ |
|
$addresses = []; |
|
foreach ($addr as $address) { |
|
$addresses[] = $this->addrFormat($address); |
|
} |
|
|
|
return $type . ': ' . implode(', ', $addresses) . static::$LE; |
|
} |
|
|
|
/** |
|
* Format an address for use in a message header. |
|
* |
|
* @param array $addr A 2-element indexed array, element 0 containing an address, element 1 containing a name like |
|
* ['joe@example.com', 'Joe User'] |
|
* |
|
* @return string |
|
*/ |
|
public function addrFormat($addr) |
|
{ |
|
if (empty($addr[1])) { // No name provided |
|
return $this->secureHeader($addr[0]); |
|
} |
|
|
|
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 int $length The line length to wrap to |
|
* @param bool $qp_mode Whether to run in Quoted-Printable mode |
|
* |
|
* @return string |
|
*/ |
|
public function wrapText($message, $length, $qp_mode = false) |
|
{ |
|
if ($qp_mode) { |
|
$soft_break = sprintf(' =%s', static::$LE); |
|
} else { |
|
$soft_break = static::$LE; |
|
} |
|
// If utf-8 encoding is used, we will need to make sure we don't |
|
// split multibyte characters when we wrap |
|
$is_utf8 = static::CHARSET_UTF8 === strtolower($this->CharSet); |
|
$lelen = strlen(static::$LE); |
|
$crlflen = strlen(static::$LE); |
|
|
|
$message = static::normalizeBreaks($message); |
|
//Remove a trailing line break |
|
if (substr($message, -$lelen) === static::$LE) { |
|
$message = substr($message, 0, -$lelen); |
|
} |
|
|
|
//Split message into lines |
|
$lines = explode(static::$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 && (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', static::$LE); |
|
} else { |
|
$message .= $buf . $soft_break; |
|
} |
|
$buf = ''; |
|
} |
|
while ($word !== '') { |
|
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 = (string) substr($word, $len); |
|
|
|
if ($word !== '') { |
|
$message .= $part . sprintf('=%s', static::$LE); |
|
} else { |
|
$buf = $part; |
|
} |
|
} |
|
} else { |
|
$buf_o = $buf; |
|
if (!$firstword) { |
|
$buf .= ' '; |
|
} |
|
$buf .= $word; |
|
|
|
if ('' !== $buf_o && strlen($buf) > $length) { |
|
$message .= $buf_o . $soft_break; |
|
$buf = $word; |
|
} |
|
} |
|
$firstword = false; |
|
} |
|
$message .= $buf . static::$LE; |
|
} |
|
|
|
return $message; |
|
} |
|
|
|
/** |
|
* Find the last character boundary prior to $maxLength in a utf-8 |
|
* quoted-printable encoded string. |
|
* Original written by Colin Brown. |
|
* |
|
* @param string $encodedText utf-8 QP text |
|
* @param int $maxLength Find the last character boundary prior to this length |
|
* |
|
* @return int |
|
*/ |
|
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 -= $lookBack - $encodedCharPos; |
|
} |
|
$foundSplitPos = true; |
|
} elseif ($dec >= 192) { |
|
// First byte of a multi byte character |
|
// Reduce maxLength to split at start of character |
|
$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. |
|
*/ |
|
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. |
|
* |
|
* @return string The assembled headers |
|
*/ |
|
public function createHeader() |
|
{ |
|
$result = ''; |
|
|
|
$result .= $this->headerLine('Date', '' === $this->MessageDate ? self::rfcDate() : $this->MessageDate); |
|
|
|
// To be created automatically by mail() |
|
if ($this->SingleTo) { |
|
if ('mail' !== $this->Mailer) { |
|
foreach ($this->to as $toaddr) { |
|
$this->SingleToArray[] = $this->addrFormat($toaddr); |
|
} |
|
} |
|
} elseif (count($this->to) > 0) { |
|
if ('mail' !== $this->Mailer) { |
|
$result .= $this->addrAppend('To', $this->to); |
|
} |
|
} elseif (count($this->cc) === 0) { |
|
$result .= $this->headerLine('To', 'undisclosed-recipients:;'); |
|
} |
|
|
|
$result .= $this->addrAppend('From', [[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 (( |
|
'sendmail' === $this->Mailer || 'qmail' === $this->Mailer || 'mail' === $this->Mailer |
|
) |
|
&& 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 ('mail' !== $this->Mailer) { |
|
$result .= $this->headerLine('Subject', $this->encodeHeader($this->secureHeader($this->Subject))); |
|
} |
|
|
|
// Only allow a custom message ID if it conforms to RFC 5322 section 3.6.4 |
|
// https://tools.ietf.org/html/rfc5322#section-3.6.4 |
|
if ('' !== $this->MessageID && 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 (null !== $this->Priority) { |
|
$result .= $this->headerLine('X-Priority', $this->Priority); |
|
} |
|
if ('' === $this->XMailer) { |
|
$result .= $this->headerLine( |
|
'X-Mailer', |
|
'PHPMailer ' . self::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. |
|
* |
|
* @return string |
|
*/ |
|
public function getMailMIME() |
|
{ |
|
$result = ''; |
|
$ismultipart = true; |
|
switch ($this->message_type) { |
|
case 'inline': |
|
$result .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_RELATED . ';'); |
|
$result .= $this->textLine(' boundary="' . $this->boundary[1] . '"'); |
|
break; |
|
case 'attach': |
|
case 'inline_attach': |
|
case 'alt_attach': |
|
case 'alt_inline_attach': |
|
$result .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_MIXED . ';'); |
|
$result .= $this->textLine(' boundary="' . $this->boundary[1] . '"'); |
|
break; |
|
case 'alt': |
|
case 'alt_inline': |
|
$result .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_ALTERNATIVE . ';'); |
|
$result .= $this->textLine(' boundary="' . $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 (static::ENCODING_7BIT !== $this->Encoding) { |
|
// RFC 2045 section 6.4 says multipart MIME parts may only use 7bit, 8bit or binary CTE |
|
if ($ismultipart) { |
|
if (static::ENCODING_8BIT === $this->Encoding) { |
|
$result .= $this->headerLine('Content-Transfer-Encoding', static::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 ('mail' !== $this->Mailer) { |
|
// $result .= static::$LE; |
|
} |
|
|
|
return $result; |
|
} |
|
|
|
/** |
|
* Returns the whole MIME message. |
|
* Includes complete headers and body. |
|
* Only valid post preSend(). |
|
* |
|
* @see PHPMailer::preSend() |
|
* |
|
* @return string |
|
*/ |
|
public function getSentMIMEMessage() |
|
{ |
|
return static::stripTrailingWSP($this->MIMEHeader . $this->mailHeader) . |
|
static::$LE . static::$LE . $this->MIMEBody; |
|
} |
|
|
|
/** |
|
* Create a unique ID to use for boundaries. |
|
* |
|
* @return string |
|
*/ |
|
protected function generateId() |
|
{ |
|
$len = 32; //32 bytes = 256 bits |
|
$bytes = ''; |
|
if (function_exists('random_bytes')) { |
|
try { |
|
$bytes = random_bytes($len); |
|
} catch (\Exception $e) { |
|
//Do nothing |
|
} |
|
} elseif (function_exists('openssl_random_pseudo_bytes')) { |
|
/** @noinspection CryptographicallySecureRandomnessInspection */ |
|
$bytes = openssl_random_pseudo_bytes($len); |
|
} |
|
if ($bytes === '') { |
|
//We failed to produce a proper random string, so make do. |
|
//Use a hash to force the length to the same as the other methods |
|
$bytes = hash('sha256', uniqid((string) mt_rand(), true), true); |
|
} |
|
|
|
//We don't care about messing up base64 format here, just want a random string |
|
return str_replace(['=', '+', '/'], '', base64_encode(hash('sha256', $bytes, true))); |
|
} |
|
|
|
/** |
|
* Assemble the message body. |
|
* Returns an empty string on failure. |
|
* |
|
* @throws Exception |
|
* |
|
* @return string The assembled message body |
|
*/ |
|
public function createBody() |
|
{ |
|
$body = ''; |
|
//Create unique IDs and preset boundaries |
|
$this->uniqueid = $this->generateId(); |
|
$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() . static::$LE; |
|
} |
|
|
|
$this->setWordWrap(); |
|
|
|
$bodyEncoding = $this->Encoding; |
|
$bodyCharSet = $this->CharSet; |
|
//Can we do a 7-bit downgrade? |
|
if (static::ENCODING_8BIT === $bodyEncoding && !$this->has8bitChars($this->Body)) { |
|
$bodyEncoding = static::ENCODING_7BIT; |
|
//All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit |
|
$bodyCharSet = static::CHARSET_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 (static::ENCODING_BASE64 !== $this->Encoding && static::hasLineLongerThanMax($this->Body)) { |
|
$bodyEncoding = static::ENCODING_QUOTED_PRINTABLE; |
|
} |
|
|
|
$altBodyEncoding = $this->Encoding; |
|
$altBodyCharSet = $this->CharSet; |
|
//Can we do a 7-bit downgrade? |
|
if (static::ENCODING_8BIT === $altBodyEncoding && !$this->has8bitChars($this->AltBody)) { |
|
$altBodyEncoding = static::ENCODING_7BIT; |
|
//All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit |
|
$altBodyCharSet = static::CHARSET_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 (static::ENCODING_BASE64 !== $altBodyEncoding && static::hasLineLongerThanMax($this->AltBody)) { |
|
$altBodyEncoding = static::ENCODING_QUOTED_PRINTABLE; |
|
} |
|
//Use this as a preamble in all multipart message types |
|
$mimepre = 'This is a multi-part message in MIME format.' . static::$LE . static::$LE; |
|
switch ($this->message_type) { |
|
case 'inline': |
|
$body .= $mimepre; |
|
$body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding); |
|
$body .= $this->encodeString($this->Body, $bodyEncoding); |
|
$body .= static::$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 .= static::$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', static::CONTENT_TYPE_MULTIPART_RELATED . ';'); |
|
$body .= $this->textLine(' boundary="' . $this->boundary[2] . '";'); |
|
$body .= $this->textLine(' type="' . static::CONTENT_TYPE_TEXT_HTML . '"'); |
|
$body .= static::$LE; |
|
$body .= $this->getBoundary($this->boundary[2], $bodyCharSet, '', $bodyEncoding); |
|
$body .= $this->encodeString($this->Body, $bodyEncoding); |
|
$body .= static::$LE; |
|
$body .= $this->attachAll('inline', $this->boundary[2]); |
|
$body .= static::$LE; |
|
$body .= $this->attachAll('attachment', $this->boundary[1]); |
|
break; |
|
case 'alt': |
|
$body .= $mimepre; |
|
$body .= $this->getBoundary( |
|
$this->boundary[1], |
|
$altBodyCharSet, |
|
static::CONTENT_TYPE_PLAINTEXT, |
|
$altBodyEncoding |
|
); |
|
$body .= $this->encodeString($this->AltBody, $altBodyEncoding); |
|
$body .= static::$LE; |
|
$body .= $this->getBoundary( |
|
$this->boundary[1], |
|
$bodyCharSet, |
|
static::CONTENT_TYPE_TEXT_HTML, |
|
$bodyEncoding |
|
); |
|
$body .= $this->encodeString($this->Body, $bodyEncoding); |
|
$body .= static::$LE; |
|
if (!empty($this->Ical)) { |
|
$method = static::ICAL_METHOD_REQUEST; |
|
foreach (static::$IcalMethods as $imethod) { |
|
if (stripos($this->Ical, 'METHOD:' . $imethod) !== false) { |
|
$method = $imethod; |
|
break; |
|
} |
|
} |
|
$body .= $this->getBoundary( |
|
$this->boundary[1], |
|
'', |
|
static::CONTENT_TYPE_TEXT_CALENDAR . '; method=' . $method, |
|
'' |
|
); |
|
$body .= $this->encodeString($this->Ical, $this->Encoding); |
|
$body .= static::$LE; |
|
} |
|
$body .= $this->endBoundary($this->boundary[1]); |
|
break; |
|
case 'alt_inline': |
|
$body .= $mimepre; |
|
$body .= $this->getBoundary( |
|
$this->boundary[1], |
|
$altBodyCharSet, |
|
static::CONTENT_TYPE_PLAINTEXT, |
|
$altBodyEncoding |
|
); |
|
$body .= $this->encodeString($this->AltBody, $altBodyEncoding); |
|
$body .= static::$LE; |
|
$body .= $this->textLine('--' . $this->boundary[1]); |
|
$body .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_RELATED . ';'); |
|
$body .= $this->textLine(' boundary="' . $this->boundary[2] . '";'); |
|
$body .= $this->textLine(' type="' . static::CONTENT_TYPE_TEXT_HTML . '"'); |
|
$body .= static::$LE; |
|
$body .= $this->getBoundary( |
|
$this->boundary[2], |
|
$bodyCharSet, |
|
static::CONTENT_TYPE_TEXT_HTML, |
|
$bodyEncoding |
|
); |
|
$body .= $this->encodeString($this->Body, $bodyEncoding); |
|
$body .= static::$LE; |
|
$body .= $this->attachAll('inline', $this->boundary[2]); |
|
$body .= static::$LE; |
|
$body .= $this->endBoundary($this->boundary[1]); |
|
break; |
|
case 'alt_attach': |
|
$body .= $mimepre; |
|
$body .= $this->textLine('--' . $this->boundary[1]); |
|
$body .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_ALTERNATIVE . ';'); |
|
$body .= $this->textLine(' boundary="' . $this->boundary[2] . '"'); |
|
$body .= static::$LE; |
|
$body .= $this->getBoundary( |
|
$this->boundary[2], |
|
$altBodyCharSet, |
|
static::CONTENT_TYPE_PLAINTEXT, |
|
$altBodyEncoding |
|
); |
|
$body .= $this->encodeString($this->AltBody, $altBodyEncoding); |
|
$body .= static::$LE; |
|
$body .= $this->getBoundary( |
|
$this->boundary[2], |
|
$bodyCharSet, |
|
static::CONTENT_TYPE_TEXT_HTML, |
|
$bodyEncoding |
|
); |
|