3 * PHPMailer - PHP email creation and transport class.
6 * @link https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project
7 * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
8 * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
9 * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
10 * @author Brent R. Matzelle (original founder)
11 * @copyright 2012 - 2014 Marcus Bointon
12 * @copyright 2010 - 2012 Jim Jagielski
13 * @copyright 2004 - 2009 Andy Prevost
14 * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
15 * @note This program is distributed in the hope that it will be useful - WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE.
21 * PHPMailer - PHP email creation and transport class.
23 * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
24 * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
25 * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
26 * @author Brent R. Matzelle (original founder)
31 * The PHPMailer Version number.
34 public $Version = '5.2.14';
38 * Options: null (default), 1 = High, 3 = Normal, 5 = low.
39 * When null, the header is not set at all.
42 public $Priority = null;
45 * The character set of the message.
48 public $CharSet = 'iso-8859-1';
51 * The MIME Content-type of the message.
54 public $ContentType = 'text/plain';
57 * The message encoding.
58 * Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".
61 public $Encoding = '8bit';
64 * Holds the most recent mailer error message.
67 public $ErrorInfo = '';
70 * The From email address for the message.
73 public $From = 'root@localhost';
76 * The From name of the message.
79 public $FromName = 'Root User';
82 * The Sender email (Return-Path) of the message.
83 * If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
89 * The Return-Path of the message.
90 * If empty, it will be set to either From or Sender.
92 * @deprecated Email senders should never set a return-path header;
93 * it's the receiver's job (RFC5321 section 4.4), so this no longer does anything.
94 * @link https://tools.ietf.org/html/rfc5321#section-4.4 RFC5321 reference
96 public $ReturnPath = '';
99 * The Subject of the message.
102 public $Subject = '';
105 * An HTML or plain text message body.
106 * If HTML then call isHTML(true).
112 * The plain-text message body.
113 * This body can be read by mail clients that do not have HTML email
114 * capability such as mutt & Eudora.
115 * Clients that can read HTML will view the normal Body.
118 public $AltBody = '';
121 * An iCal message part body.
122 * Only supported in simple alt or alt_inline message types
123 * To generate iCal events, use the bundled extras/EasyPeasyICS.php class or iCalcreator
124 * @link http://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/
125 * @link http://kigkonsult.se/iCalcreator/
131 * The complete compiled MIME message body.
135 protected $MIMEBody = '';
138 * The complete compiled MIME message headers.
142 protected $MIMEHeader = '';
145 * Extra headers that createHeader() doesn't fold in.
149 protected $mailHeader = '';
152 * Word-wrap the message body to this number of chars.
153 * Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance.
156 public $WordWrap = 0;
159 * Which method to use to send mail.
160 * Options: "mail", "sendmail", or "smtp".
163 public $Mailer = 'mail';
166 * The path to the sendmail program.
169 public $Sendmail = '/usr/sbin/sendmail';
172 * Whether mail() uses a fully sendmail-compatible MTA.
173 * One which supports sendmail's "-oi -f" options.
176 public $UseSendmailOptions = true;
179 * Path to PHPMailer plugins.
180 * Useful if the SMTP class is not in the PHP include path.
182 * @deprecated Should not be needed now there is an autoloader.
184 public $PluginDir = '';
187 * The email address that a reading confirmation should be sent to, also known as read receipt.
190 public $ConfirmReadingTo = '';
193 * The hostname to use in the Message-ID header and as default HELO string.
194 * If empty, PHPMailer attempts to find one with, in order,
195 * $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value
196 * 'localhost.localdomain'.
199 public $Hostname = '';
202 * An ID to be used in the Message-ID header.
203 * If empty, a unique id will be generated.
206 public $MessageID = '';
209 * The message Date to be used in the Date header.
210 * If empty, the current date will be added.
213 public $MessageDate = '';
217 * Either a single hostname or multiple semicolon-delimited hostnames.
218 * You can also specify a different port
219 * for each host by using this format: [hostname:port]
220 * (e.g. "smtp1.example.com:25;smtp2.example.com").
221 * You can also specify encryption type, for example:
222 * (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465").
223 * Hosts will be tried in order.
226 public $Host = 'localhost';
229 * The default SMTP server port.
231 * @TODO Why is this needed when the SMTP class takes care of it?
236 * The SMTP HELO of the message.
237 * Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find
238 * one with the same method described above for $Hostname.
240 * @see PHPMailer::$Hostname
245 * What kind of encryption to use on the SMTP connection.
246 * Options: '', 'ssl' or 'tls'
249 public $SMTPSecure = '';
252 * Whether to enable TLS encryption automatically if a server supports it,
253 * even if `SMTPSecure` is not set to 'tls'.
254 * Be aware that in PHP >= 5.6 this requires that the server's certificates are valid.
257 public $SMTPAutoTLS = true;
260 * Whether to use SMTP authentication.
261 * Uses the Username and Password properties.
263 * @see PHPMailer::$Username
264 * @see PHPMailer::$Password
266 public $SMTPAuth = false;
269 * Options array passed to stream_context_create when connecting via SMTP.
272 public $SMTPOptions = array();
278 public $Username = '';
284 public $Password = '';
288 * Options are LOGIN (default), PLAIN, NTLM, CRAM-MD5
291 public $AuthType = '';
305 public $Workstation = '';
308 * The SMTP server timeout in seconds.
309 * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
312 public $Timeout = 300;
315 * SMTP class debug output mode.
316 * Debug output level.
320 * * `2` Data and commands
321 * * `3` As 2 plus connection status
322 * * `4` Low-level data output
324 * @see SMTP::$do_debug
326 public $SMTPDebug = 0;
329 * How to handle debug output.
331 * * `echo` Output plain-text as-is, appropriate for CLI
332 * * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output
333 * * `error_log` Output to error log as configured in php.ini
335 * Alternatively, you can provide a callable expecting two params: a message string and the debug level:
337 * $mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
339 * @var string|callable
340 * @see SMTP::$Debugoutput
342 public $Debugoutput = 'echo';
345 * Whether to keep SMTP connection open after each message.
346 * If this is set to true then to close the connection
347 * requires an explicit call to smtpClose().
350 public $SMTPKeepAlive = false;
353 * Whether to split multiple to addresses into multiple messages
354 * or send them all in one message.
357 public $SingleTo = false;
360 * Storage for addresses when SingleTo is enabled.
362 * @TODO This should really not be public
364 public $SingleToArray = array();
367 * Whether to generate VERP addresses on send.
368 * Only applicable when sending via SMTP.
369 * @link https://en.wikipedia.org/wiki/Variable_envelope_return_path
370 * @link http://www.postfix.org/VERP_README.html Postfix VERP info
373 public $do_verp = false;
376 * Whether to allow sending messages with an empty body.
379 public $AllowEmpty = false;
382 * The default line ending.
383 * @note The default remains "\n". We force CRLF where we know
384 * it must be used via self::CRLF.
393 public $DKIM_selector = '';
397 * Usually the email address used as the source of the email
400 public $DKIM_identity = '';
404 * Used if your key is encrypted.
407 public $DKIM_passphrase = '';
410 * DKIM signing domain name.
411 * @example 'example.com'
414 public $DKIM_domain = '';
417 * DKIM private key file path.
420 public $DKIM_private = '';
423 * Callback Action function name.
425 * The function that handles the result of the send email action.
426 * It is called out by send() for each email sent.
428 * Value can be any php callable: http://www.php.net/is_callable
431 * boolean $result result of the send action
432 * string $to email address of the recipient
433 * string $cc cc email addresses
434 * string $bcc bcc email addresses
435 * string $subject the subject
436 * string $body the email body
437 * string $from email address of sender
440 public $action_function = '';
443 * What to put in the X-Mailer header.
444 * Options: An empty string for PHPMailer default, whitespace for none, or a string to use
447 public $XMailer = '';
450 * An instance of the SMTP sender class.
454 protected $smtp = null;
457 * The array of 'to' names and addresses.
461 protected $to = array();
464 * The array of 'cc' names and addresses.
468 protected $cc = array();
471 * The array of 'bcc' names and addresses.
475 protected $bcc = array();
478 * The array of reply-to names and addresses.
482 protected $ReplyTo = array();
485 * An array of all kinds of addresses.
486 * Includes all of $to, $cc, $bcc
489 * @see PHPMailer::$to @see PHPMailer::$cc @see PHPMailer::$bcc
491 protected $all_recipients = array();
494 * An array of names and addresses queued for validation.
495 * In send(), valid and non duplicate entries are moved to $all_recipients
496 * and one of $to, $cc, or $bcc.
497 * This array is used only for addresses with IDN.
500 * @see PHPMailer::$to @see PHPMailer::$cc @see PHPMailer::$bcc
501 * @see PHPMailer::$all_recipients
503 protected $RecipientsQueue = array();
506 * An array of reply-to names and addresses queued for validation.
507 * In send(), valid and non duplicate entries are moved to $ReplyTo.
508 * This array is used only for addresses with IDN.
511 * @see PHPMailer::$ReplyTo
513 protected $ReplyToQueue = array();
516 * The array of attachments.
520 protected $attachment = array();
523 * The array of custom headers.
527 protected $CustomHeader = array();
530 * The most recent Message-ID (including angular brackets).
534 protected $lastMessageID = '';
537 * The message's MIME type.
541 protected $message_type = '';
544 * The array of MIME boundary strings.
548 protected $boundary = array();
551 * The array of available languages.
555 protected $language = array();
558 * The number of errors encountered.
562 protected $error_count = 0;
565 * The S/MIME certificate file path.
569 protected $sign_cert_file = '';
572 * The S/MIME key file path.
576 protected $sign_key_file = '';
579 * The optional S/MIME extra certificates ("CA Chain") file path.
583 protected $sign_extracerts_file = '';
586 * The S/MIME password for the key.
587 * Used only if the key is encrypted.
591 protected $sign_key_pass = '';
594 * Whether to throw exceptions for errors.
598 protected $exceptions = false;
601 * Unique ID used for message ID and boundaries.
605 protected $uniqueid = '';
608 * Error severity: message only, continue processing.
610 const STOP_MESSAGE = 0;
613 * Error severity: message, likely ok to continue processing.
615 const STOP_CONTINUE = 1;
618 * Error severity: message, plus full stop, critical error reached.
620 const STOP_CRITICAL = 2;
623 * SMTP RFC standard line ending.
628 * The maximum line length allowed by RFC 2822 section 2.1.1
631 const MAX_LINE_LENGTH = 998;
635 * @param boolean $exceptions Should we throw external exceptions?
637 public function __construct($exceptions = false)
639 $this->exceptions = (boolean)$exceptions;
645 public function __destruct()
647 //Close any open SMTP connection nicely
648 if ($this->Mailer == 'smtp') {
654 * Call mail() in a safe_mode-aware fashion.
655 * Also, unless sendmail_path points to sendmail (or something that
656 * claims to be sendmail), don't pass params (not a perfect fix,
658 * @param string $to To
659 * @param string $subject Subject
660 * @param string $body Message Body
661 * @param string $header Additional Header(s)
662 * @param string $params Params
666 private function mailPassthru($to, $subject, $body, $header, $params)
668 //Check overloading of mail function to avoid double-encoding
669 if (ini_get('mbstring.func_overload') & 1) {
670 $subject = $this->secureHeader($subject);
672 $subject = $this->encodeHeader($this->secureHeader($subject));
674 if (ini_get('safe_mode') || !($this->UseSendmailOptions)) {
675 $result = @mail($to, $subject, $body, $header);
677 $result = @mail($to, $subject, $body, $header, $params);
683 * Output debugging info via user-defined method.
684 * Only generates output if SMTP debug output is enabled (@see SMTP::$do_debug).
685 * @see PHPMailer::$Debugoutput
686 * @see PHPMailer::$SMTPDebug
689 protected function edebug($str)
691 if ($this->SMTPDebug <= 0) {
694 //Avoid clash with built-in function names
695 if (!in_array($this->Debugoutput, array('error_log', 'html', 'echo')) and is_callable($this->Debugoutput)) {
696 call_user_func($this->Debugoutput, $str, $this->SMTPDebug);
699 switch ($this->Debugoutput) {
701 //Don't output, just log
705 //Cleans up output a bit for a better looking, HTML-safe output
707 preg_replace('/[\r\n]+/', '', $str),
715 //Normalize line breaks
716 $str = preg_replace('/(\r\n|\r|\n)/ms', "\n", $str);
717 echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
726 * Sets message type to HTML or plain.
727 * @param boolean $isHtml True for HTML mode.
730 public function isHTML($isHtml = true)
733 $this->ContentType = 'text/html';
735 $this->ContentType = 'text/plain';
740 * Send messages using SMTP.
743 public function isSMTP()
745 $this->Mailer = 'smtp';
749 * Send messages using PHP's mail() function.
752 public function isMail()
754 $this->Mailer = 'mail';
758 * Send messages using $Sendmail.
761 public function isSendmail()
763 $ini_sendmail_path = ini_get('sendmail_path');
765 if (!stristr($ini_sendmail_path, 'sendmail')) {
766 $this->Sendmail = '/usr/sbin/sendmail';
768 $this->Sendmail = $ini_sendmail_path;
770 $this->Mailer = 'sendmail';
774 * Send messages using qmail.
777 public function isQmail()
779 $ini_sendmail_path = ini_get('sendmail_path');
781 if (!stristr($ini_sendmail_path, 'qmail')) {
782 $this->Sendmail = '/var/qmail/bin/qmail-inject';
784 $this->Sendmail = $ini_sendmail_path;
786 $this->Mailer = 'qmail';
790 * Add a "To" address.
791 * @param string $address The email address to send to
792 * @param string $name
793 * @return boolean true on success, false if address already used or invalid in some way
795 public function addAddress($address, $name = '')
797 return $this->addOrEnqueueAnAddress('to', $address, $name);
801 * Add a "CC" address.
802 * @note: This function works with the SMTP mailer on win32, not with the "mail" mailer.
803 * @param string $address The email address to send to
804 * @param string $name
805 * @return boolean true on success, false if address already used or invalid in some way
807 public function addCC($address, $name = '')
809 return $this->addOrEnqueueAnAddress('cc', $address, $name);
813 * Add a "BCC" address.
814 * @note: This function works with the SMTP mailer on win32, not with the "mail" mailer.
815 * @param string $address The email address to send to
816 * @param string $name
817 * @return boolean true on success, false if address already used or invalid in some way
819 public function addBCC($address, $name = '')
821 return $this->addOrEnqueueAnAddress('bcc', $address, $name);
825 * Add a "Reply-To" address.
826 * @param string $address The email address to reply to
827 * @param string $name
828 * @return boolean true on success, false if address already used or invalid in some way
830 public function addReplyTo($address, $name = '')
832 return $this->addOrEnqueueAnAddress('Reply-To', $address, $name);
836 * Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer
837 * can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still
838 * be modified after calling this function), addition of such addresses is delayed until send().
839 * Addresses that have been added already return false, but do not throw exceptions.
840 * @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo'
841 * @param string $address The email address to send, resp. to reply to
842 * @param string $name
843 * @throws phpmailerException
844 * @return boolean true on success, false if address already used or invalid in some way
847 protected function addOrEnqueueAnAddress($kind, $address, $name)
849 $address = trim($address);
850 $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
851 if (($pos = strrpos($address, '@')) === false) {
852 // At-sign is misssing.
853 $error_message = $this->lang('invalid_address') . $address;
854 $this->setError($error_message);
855 $this->edebug($error_message);
856 if ($this->exceptions) {
857 throw new phpmailerException($error_message);
861 $params = array($kind, $address, $name);
862 // Enqueue addresses with IDN until we know the PHPMailer::$CharSet.
863 if ($this->has8bitChars(substr($address, ++$pos)) and $this->idnSupported()) {
864 if ($kind != 'Reply-To') {
865 if (!array_key_exists($address, $this->RecipientsQueue)) {
866 $this->RecipientsQueue[$address] = $params;
870 if (!array_key_exists($address, $this->ReplyToQueue)) {
871 $this->ReplyToQueue[$address] = $params;
877 // Immediately add standard addresses without IDN.
878 return call_user_func_array(array($this, 'addAnAddress'), $params);
882 * Add an address to one of the recipient arrays or to the ReplyTo array.
883 * Addresses that have been added already return false, but do not throw exceptions.
884 * @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo'
885 * @param string $address The email address to send, resp. to reply to
886 * @param string $name
887 * @throws phpmailerException
888 * @return boolean true on success, false if address already used or invalid in some way
891 protected function addAnAddress($kind, $address, $name = '')
893 if (!in_array($kind, array('to', 'cc', 'bcc', 'Reply-To'))) {
894 $error_message = $this->lang('Invalid recipient kind: ') . $kind;
895 $this->setError($error_message);
896 $this->edebug($error_message);
897 if ($this->exceptions) {
898 throw new phpmailerException($error_message);
902 if (!$this->validateAddress($address)) {
903 $error_message = $this->lang('invalid_address') . $address;
904 $this->setError($error_message);
905 $this->edebug($error_message);
906 if ($this->exceptions) {
907 throw new phpmailerException($error_message);
911 if ($kind != 'Reply-To') {
912 if (!array_key_exists(strtolower($address), $this->all_recipients)) {
913 array_push($this->$kind, array($address, $name));
914 $this->all_recipients[strtolower($address)] = true;
918 if (!array_key_exists(strtolower($address), $this->ReplyTo)) {
919 $this->ReplyTo[strtolower($address)] = array($address, $name);
927 * Set the From and FromName properties.
928 * @param string $address
929 * @param string $name
930 * @param boolean $auto Whether to also set the Sender address, defaults to true
931 * @throws phpmailerException
934 public function setFrom($address, $name = '', $auto = true)
936 $address = trim($address);
937 $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
938 // Don't validate now addresses with IDN. Will be done in send().
939 if (($pos = strrpos($address, '@')) === false or
940 (!$this->has8bitChars(substr($address, ++$pos)) or !$this->idnSupported()) and
941 !$this->validateAddress($address)) {
942 $error_message = $this->lang('invalid_address') . $address;
943 $this->setError($error_message);
944 $this->edebug($error_message);
945 if ($this->exceptions) {
946 throw new phpmailerException($error_message);
950 $this->From = $address;
951 $this->FromName = $name;
953 if (empty($this->Sender)) {
954 $this->Sender = $address;
961 * Return the Message-ID header of the last email.
962 * Technically this is the value from the last time the headers were created,
963 * but it's also the message ID of the last sent message except in
964 * pathological cases.
967 public function getLastMessageID()
969 return $this->lastMessageID;
973 * Check that a string looks like an email address.
974 * @param string $address The email address to check
975 * @param string $patternselect A selector for the validation pattern to use :
976 * * `auto` Pick best pattern automatically;
977 * * `pcre8` Use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14;
978 * * `pcre` Use old PCRE implementation;
979 * * `php` Use PHP built-in FILTER_VALIDATE_EMAIL;
980 * * `html5` Use the pattern given by the HTML5 spec for 'email' type form input elements.
981 * * `noregex` Don't use a regex: super fast, really dumb.
986 public static function validateAddress($address, $patternselect = 'auto')
988 //Reject line breaks in addresses; it's valid RFC5322, but not RFC5321
989 if (strpos($address, "\n") !== false or strpos($address, "\r") !== false) {
992 if (!$patternselect or $patternselect == 'auto') {
993 //Check this constant first so it works when extension_loaded() is disabled by safe mode
994 //Constant was added in PHP 5.2.4
995 if (defined('PCRE_VERSION')) {
996 //This pattern can get stuck in a recursive loop in PCRE <= 8.0.2
997 if (version_compare(PCRE_VERSION, '8.0.3') >= 0) {
998 $patternselect = 'pcre8';
1000 $patternselect = 'pcre';
1002 } elseif (function_exists('extension_loaded') and extension_loaded('pcre')) {
1003 //Fall back to older PCRE
1004 $patternselect = 'pcre';
1006 //Filter_var appeared in PHP 5.2.0 and does not require the PCRE extension
1007 if (version_compare(PHP_VERSION, '5.2.0') >= 0) {
1008 $patternselect = 'php';
1010 $patternselect = 'noregex';
1014 switch ($patternselect) {
1017 * Uses the same RFC5322 regex on which FILTER_VALIDATE_EMAIL is based, but allows dotless domains.
1018 * @link http://squiloople.com/2009/12/20/email-address-validation/
1019 * @copyright 2009-2010 Michael Rushton
1020 * Feel free to use and redistribute this code. But please keep this copyright notice.
1022 return (boolean)preg_match(
1023 '/^(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){255,})(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){65,}@)' .
1024 '((?>(?>(?>((?>(?>(?>\x0D\x0A)?[\t ])+|(?>[\t ]*\x0D\x0A)?[\t ]+)?)(\((?>(?2)' .
1025 '(?>[\x01-\x08\x0B\x0C\x0E-\'*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\)))+(?2))|(?2))?)' .
1026 '([!#-\'*+\/-9=?^-~-]+|"(?>(?2)(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\x7F]))*' .
1027 '(?2)")(?>(?1)\.(?1)(?4))*(?1)@(?!(?1)[a-z0-9-]{64,})(?1)(?>([a-z0-9](?>[a-z0-9-]*[a-z0-9])?)' .
1028 '(?>(?1)\.(?!(?1)[a-z0-9-]{64,})(?1)(?5)){0,126}|\[(?:(?>IPv6:(?>([a-f0-9]{1,4})(?>:(?6)){7}' .
1029 '|(?!(?:.*[a-f0-9][:\]]){8,})((?6)(?>:(?6)){0,6})?::(?7)?))|(?>(?>IPv6:(?>(?6)(?>:(?6)){5}:' .
1030 '|(?!(?:.*[a-f0-9]:){6,})(?8)?::(?>((?6)(?>:(?6)){0,4}):)?))?(25[0-5]|2[0-4][0-9]|1[0-9]{2}' .
1031 '|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD',
1035 //An older regex that doesn't need a recent PCRE
1036 return (boolean)preg_match(
1037 '/^(?!(?>"?(?>\\\[ -~]|[^"])"?){255,})(?!(?>"?(?>\\\[ -~]|[^"])"?){65,}@)(?>' .
1038 '[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*")' .
1039 '(?>\.(?>[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*"))*' .
1040 '@(?>(?![a-z0-9-]{64,})(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)(?>\.(?![a-z0-9-]{64,})' .
1041 '(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)){0,126}|\[(?:(?>IPv6:(?>(?>[a-f0-9]{1,4})(?>:' .
1042 '[a-f0-9]{1,4}){7}|(?!(?:.*[a-f0-9][:\]]){8,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?' .
1043 '::(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?))|(?>(?>IPv6:(?>[a-f0-9]{1,4}(?>:' .
1044 '[a-f0-9]{1,4}){5}:|(?!(?:.*[a-f0-9]:){6,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4})?' .
1045 '::(?>(?:[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4}):)?))?(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}' .
1046 '|[1-9]?[0-9])(?>\.(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}))\])$/isD',
1051 * This is the pattern used in the HTML5 spec for validation of 'email' type form input elements.
1052 * @link http://www.whatwg.org/specs/web-apps/current-work/#e-mail-state-(type=email)
1054 return (boolean)preg_match(
1055 '/^[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}' .
1056 '[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/sD',
1060 //No PCRE! Do something _very_ approximate!
1061 //Check the address is 3 chars or longer and contains an @ that's not the first or last char
1062 return (strlen($address) >= 3
1063 and strpos($address, '@') >= 1
1064 and strpos($address, '@') != strlen($address) - 1);
1067 return (boolean)filter_var($address, FILTER_VALIDATE_EMAIL);
1072 * Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the
1073 * "intl" and "mbstring" PHP extensions.
1074 * @return bool "true" if required functions for IDN support are present
1076 public function idnSupported()
1078 // @TODO: Write our own "idn_to_ascii" function for PHP <= 5.2.
1079 return function_exists('idn_to_ascii') and function_exists('mb_convert_encoding');
1083 * Converts IDN in given email address to its ASCII form, also known as punycode, if possible.
1084 * Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet.
1085 * This function silently returns unmodified address if:
1086 * - No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form)
1087 * - Conversion to punycode is impossible (e.g. required PHP functions are not available)
1088 * or fails for any reason (e.g. domain has characters not allowed in an IDN)
1089 * @see PHPMailer::$CharSet
1090 * @param string $address The email address to convert
1091 * @return string The encoded address in ASCII form
1093 public function punyencodeAddress($address)
1095 // Verify we have required functions, CharSet, and at-sign.
1096 if ($this->idnSupported() and
1097 !empty($this->CharSet) and
1098 ($pos = strrpos($address, '@')) !== false) {
1099 $domain = substr($address, ++$pos);
1100 // Verify CharSet string is a valid one, and domain properly encoded in this CharSet.
1101 if ($this->has8bitChars($domain) and @mb_check_encoding($domain, $this->CharSet)) {
1102 $domain = mb_convert_encoding($domain, 'UTF-8', $this->CharSet);
1103 if (($punycode = defined('INTL_IDNA_VARIANT_UTS46') ?
1104 idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46) :
1105 idn_to_ascii($domain)) !== false) {
1106 return substr($address, 0, $pos) . $punycode;
1114 * Create a message and send it.
1115 * Uses the sending method specified by $Mailer.
1116 * @throws phpmailerException
1117 * @return boolean false on error - See the ErrorInfo property for details of the error.
1119 public function send()
1122 if (!$this->preSend()) {
1125 return $this->postSend();
1126 } catch (phpmailerException $exc) {
1127 $this->mailHeader = '';
1128 $this->setError($exc->getMessage());
1129 if ($this->exceptions) {
1137 * Prepare a message for sending.
1138 * @throws phpmailerException
1141 public function preSend()
1144 $this->error_count = 0; // Reset errors
1145 $this->mailHeader = '';
1147 // Dequeue recipient and Reply-To addresses with IDN
1148 foreach (array_merge($this->RecipientsQueue, $this->ReplyToQueue) as $params) {
1149 $params[1] = $this->punyencodeAddress($params[1]);
1150 call_user_func_array(array($this, 'addAnAddress'), $params);
1152 if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
1153 throw new phpmailerException($this->lang('provide_address'), self::STOP_CRITICAL);
1156 // Validate From, Sender, and ConfirmReadingTo addresses
1157 foreach (array('From', 'Sender', 'ConfirmReadingTo') as $address_kind) {
1158 $this->$address_kind = trim($this->$address_kind);
1159 if (empty($this->$address_kind)) {
1162 $this->$address_kind = $this->punyencodeAddress($this->$address_kind);
1163 if (!$this->validateAddress($this->$address_kind)) {
1164 $error_message = $this->lang('invalid_address') . $this->$address_kind;
1165 $this->setError($error_message);
1166 $this->edebug($error_message);
1167 if ($this->exceptions) {
1168 throw new phpmailerException($error_message);
1174 // Set whether the message is multipart/alternative
1175 if (!empty($this->AltBody)) {
1176 $this->ContentType = 'multipart/alternative';
1179 $this->setMessageType();
1180 // Refuse to send an empty message unless we are specifically allowing it
1181 if (!$this->AllowEmpty and empty($this->Body)) {
1182 throw new phpmailerException($this->lang('empty_message'), self::STOP_CRITICAL);
1185 // Create body before headers in case body makes changes to headers (e.g. altering transfer encoding)
1186 $this->MIMEHeader = '';
1187 $this->MIMEBody = $this->createBody();
1188 // createBody may have added some headers, so retain them
1189 $tempheaders = $this->MIMEHeader;
1190 $this->MIMEHeader = $this->createHeader();
1191 $this->MIMEHeader .= $tempheaders;
1193 // To capture the complete message when using mail(), create
1194 // an extra header list which createHeader() doesn't fold in
1195 if ($this->Mailer == 'mail') {
1196 if (count($this->to) > 0) {
1197 $this->mailHeader .= $this->addrAppend('To', $this->to);
1199 $this->mailHeader .= $this->headerLine('To', 'undisclosed-recipients:;');
1201 $this->mailHeader .= $this->headerLine(
1203 $this->encodeHeader($this->secureHeader(trim($this->Subject)))
1207 // Sign with DKIM if enabled
1208 if (!empty($this->DKIM_domain)
1209 && !empty($this->DKIM_private)
1210 && !empty($this->DKIM_selector)
1211 && file_exists($this->DKIM_private)) {
1212 $header_dkim = $this->DKIM_Add(
1213 $this->MIMEHeader . $this->mailHeader,
1214 $this->encodeHeader($this->secureHeader($this->Subject)),
1217 $this->MIMEHeader = rtrim($this->MIMEHeader, "\r\n ") . self::CRLF .
1218 str_replace("\r\n", "\n", $header_dkim) . self::CRLF;
1221 } catch (phpmailerException $exc) {
1222 $this->setError($exc->getMessage());
1223 if ($this->exceptions) {
1231 * Actually send a message.
1232 * Send the email via the selected mechanism
1233 * @throws phpmailerException
1236 public function postSend()
1239 // Choose the mailer and send through it
1240 switch ($this->Mailer) {
1243 return $this->sendmailSend($this->MIMEHeader, $this->MIMEBody);
1245 return $this->smtpSend($this->MIMEHeader, $this->MIMEBody);
1247 return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
1249 $sendMethod = $this->Mailer.'Send';
1250 if (method_exists($this, $sendMethod)) {
1251 return $this->$sendMethod($this->MIMEHeader, $this->MIMEBody);
1254 return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
1256 } catch (phpmailerException $exc) {
1257 $this->setError($exc->getMessage());
1258 $this->edebug($exc->getMessage());
1259 if ($this->exceptions) {
1267 * Send mail using the $Sendmail program.
1268 * @param string $header The message headers
1269 * @param string $body The message body
1270 * @see PHPMailer::$Sendmail
1271 * @throws phpmailerException
1275 protected function sendmailSend($header, $body)
1277 if ($this->Sender != '') {
1278 if ($this->Mailer == 'qmail') {
1279 $sendmail = sprintf('%s -f%s', escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
1281 $sendmail = sprintf('%s -oi -f%s -t', escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
1284 if ($this->Mailer == 'qmail') {
1285 $sendmail = sprintf('%s', escapeshellcmd($this->Sendmail));
1287 $sendmail = sprintf('%s -oi -t', escapeshellcmd($this->Sendmail));
1290 if ($this->SingleTo) {
1291 foreach ($this->SingleToArray as $toAddr) {
1292 if (!@$mail = popen($sendmail, 'w')) {
1293 throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
1295 fputs($mail, 'To: ' . $toAddr . "\n");
1296 fputs($mail, $header);
1297 fputs($mail, $body);
1298 $result = pclose($mail);
1309 throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
1313 if (!@$mail = popen($sendmail, 'w')) {
1314 throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
1316 fputs($mail, $header);
1317 fputs($mail, $body);
1318 $result = pclose($mail);
1329 throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
1336 * Send mail using the PHP mail() function.
1337 * @param string $header The message headers
1338 * @param string $body The message body
1339 * @link http://www.php.net/manual/en/book.mail.php
1340 * @throws phpmailerException
1344 protected function mailSend($header, $body)
1347 foreach ($this->to as $toaddr) {
1348 $toArr[] = $this->addrFormat($toaddr);
1350 $to = implode(', ', $toArr);
1352 if (empty($this->Sender)) {
1355 $params = sprintf('-f%s', $this->Sender);
1357 if ($this->Sender != '' and !ini_get('safe_mode')) {
1358 $old_from = ini_get('sendmail_from');
1359 ini_set('sendmail_from', $this->Sender);
1362 if ($this->SingleTo && count($toArr) > 1) {
1363 foreach ($toArr as $toAddr) {
1364 $result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params);
1365 $this->doCallback($result, array($toAddr), $this->cc, $this->bcc, $this->Subject, $body, $this->From);
1368 $result = $this->mailPassthru($to, $this->Subject, $body, $header, $params);
1369 $this->doCallback($result, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
1371 if (isset($old_from)) {
1372 ini_set('sendmail_from', $old_from);
1375 throw new phpmailerException($this->lang('instantiate'), self::STOP_CRITICAL);
1381 * Get an instance to use for SMTP operations.
1382 * Override this function to load your own SMTP implementation
1385 public function getSMTPInstance()
1387 if (!is_object($this->smtp)) {
1388 require_once( 'class-smtp.php' );
1389 $this->smtp = new SMTP;
1395 * Send mail via SMTP.
1396 * Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
1397 * Uses the PHPMailerSMTP class by default.
1398 * @see PHPMailer::getSMTPInstance() to use a different class.
1399 * @param string $header The message headers
1400 * @param string $body The message body
1401 * @throws phpmailerException
1406 protected function smtpSend($header, $body)
1408 $bad_rcpt = array();
1409 if (!$this->smtpConnect($this->SMTPOptions)) {
1410 throw new phpmailerException($this->lang('smtp_connect_failed'), self::STOP_CRITICAL);
1412 if ('' == $this->Sender) {
1413 $smtp_from = $this->From;
1415 $smtp_from = $this->Sender;
1417 if (!$this->smtp->mail($smtp_from)) {
1418 $this->setError($this->lang('from_failed') . $smtp_from . ' : ' . implode(',', $this->smtp->getError()));
1419 throw new phpmailerException($this->ErrorInfo, self::STOP_CRITICAL);
1422 // Attempt to send to all recipients
1423 foreach (array($this->to, $this->cc, $this->bcc) as $togroup) {
1424 foreach ($togroup as $to) {
1425 if (!$this->smtp->recipient($to[0])) {
1426 $error = $this->smtp->getError();
1427 $bad_rcpt[] = array('to' => $to[0], 'error' => $error['detail']);
1432 $this->doCallback($isSent, array($to[0]), array(), array(), $this->Subject, $body, $this->From);
1436 // Only send the DATA command if we have viable recipients
1437 if ((count($this->all_recipients) > count($bad_rcpt)) and !$this->smtp->data($header . $body)) {
1438 throw new phpmailerException($this->lang('data_not_accepted'), self::STOP_CRITICAL);
1440 if ($this->SMTPKeepAlive) {
1441 $this->smtp->reset();
1443 $this->smtp->quit();
1444 $this->smtp->close();
1446 //Create error message for any bad addresses
1447 if (count($bad_rcpt) > 0) {
1449 foreach ($bad_rcpt as $bad) {
1450 $errstr .= $bad['to'] . ': ' . $bad['error'];
1452 throw new phpmailerException(
1453 $this->lang('recipients_failed') . $errstr,
1461 * Initiate a connection to an SMTP server.
1462 * Returns false if the operation failed.
1463 * @param array $options An array of options compatible with stream_context_create()
1466 * @throws phpmailerException
1469 public function smtpConnect($options = array())
1471 if (is_null($this->smtp)) {
1472 $this->smtp = $this->getSMTPInstance();
1475 // Already connected?
1476 if ($this->smtp->connected()) {
1480 $this->smtp->setTimeout($this->Timeout);
1481 $this->smtp->setDebugLevel($this->SMTPDebug);
1482 $this->smtp->setDebugOutput($this->Debugoutput);
1483 $this->smtp->setVerp($this->do_verp);
1484 $hosts = explode(';', $this->Host);
1485 $lastexception = null;
1487 foreach ($hosts as $hostentry) {
1488 $hostinfo = array();
1489 if (!preg_match('/^((ssl|tls):\/\/)*([a-zA-Z0-9\.-]*):?([0-9]*)$/', trim($hostentry), $hostinfo)) {
1490 // Not a valid host entry
1493 // $hostinfo[2]: optional ssl or tls prefix
1494 // $hostinfo[3]: the hostname
1495 // $hostinfo[4]: optional port number
1496 // The host string prefix can temporarily override the current setting for SMTPSecure
1497 // If it's not specified, the default value is used
1499 $secure = $this->SMTPSecure;
1500 $tls = ($this->SMTPSecure == 'tls');
1501 if ('ssl' == $hostinfo[2] or ('' == $hostinfo[2] and 'ssl' == $this->SMTPSecure)) {
1503 $tls = false; // Can't have SSL and TLS at the same time
1505 } elseif ($hostinfo[2] == 'tls') {
1507 // tls doesn't use a prefix
1510 //Do we need the OpenSSL extension?
1511 $sslext = defined('OPENSSL_ALGO_SHA1');
1512 if ('tls' === $secure or 'ssl' === $secure) {
1513 //Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled
1515 throw new phpmailerException($this->lang('extension_missing').'openssl', self::STOP_CRITICAL);
1518 $host = $hostinfo[3];
1519 $port = $this->Port;
1520 $tport = (integer)$hostinfo[4];
1521 if ($tport > 0 and $tport < 65536) {
1524 if ($this->smtp->connect($prefix . $host, $port, $this->Timeout, $options)) {
1527 $hello = $this->Helo;
1529 $hello = $this->serverHostname();
1531 $this->smtp->hello($hello);
1532 //Automatically enable TLS encryption if:
1533 // * it's not disabled
1534 // * we have openssl extension
1535 // * we are not already using SSL
1536 // * the server offers STARTTLS
1537 if ($this->SMTPAutoTLS and $sslext and $secure != 'ssl' and $this->smtp->getServerExt('STARTTLS')) {
1541 if (!$this->smtp->startTLS()) {
1542 throw new phpmailerException($this->lang('connect_host'));
1544 // We must resend HELO after tls negotiation
1545 $this->smtp->hello($hello);
1547 if ($this->SMTPAuth) {
1548 if (!$this->smtp->authenticate(
1556 throw new phpmailerException($this->lang('authenticate'));
1560 } catch (phpmailerException $exc) {
1561 $lastexception = $exc;
1562 $this->edebug($exc->getMessage());
1563 // We must have connected, but then failed TLS or Auth, so close connection nicely
1564 $this->smtp->quit();
1568 // If we get here, all connection attempts have failed, so close connection hard
1569 $this->smtp->close();
1570 // As we've caught all exceptions, just report whatever the last one was
1571 if ($this->exceptions and !is_null($lastexception)) {
1572 throw $lastexception;
1578 * Close the active SMTP session if one exists.
1581 public function smtpClose()
1583 if ($this->smtp !== null) {
1584 if ($this->smtp->connected()) {
1585 $this->smtp->quit();
1586 $this->smtp->close();
1592 * Set the language for error messages.
1593 * Returns false if it cannot load the language file.
1594 * The default language is English.
1595 * @param string $langcode ISO 639-1 2-character language code (e.g. French is "fr")
1596 * @param string $lang_path Path to the language file directory, with trailing separator (slash)
1600 public function setLanguage($langcode = 'en', $lang_path = '')
1602 // Define full set of translatable strings in English
1603 $PHPMAILER_LANG = array(
1604 'authenticate' => 'SMTP Error: Could not authenticate.',
1605 'connect_host' => 'SMTP Error: Could not connect to SMTP host.',
1606 'data_not_accepted' => 'SMTP Error: data not accepted.',
1607 'empty_message' => 'Message body empty',
1608 'encoding' => 'Unknown encoding: ',
1609 'execute' => 'Could not execute: ',
1610 'file_access' => 'Could not access file: ',
1611 'file_open' => 'File Error: Could not open file: ',
1612 'from_failed' => 'The following From address failed: ',
1613 'instantiate' => 'Could not instantiate mail function.',
1614 'invalid_address' => 'Invalid address: ',
1615 'mailer_not_supported' => ' mailer is not supported.',
1616 'provide_address' => 'You must provide at least one recipient email address.',
1617 'recipients_failed' => 'SMTP Error: The following recipients failed: ',
1618 'signing' => 'Signing Error: ',
1619 'smtp_connect_failed' => 'SMTP connect() failed.',
1620 'smtp_error' => 'SMTP server error: ',
1621 'variable_set' => 'Cannot set or reset variable: ',
1622 'extension_missing' => 'Extension missing: '
1624 if (empty($lang_path)) {
1625 // Calculate an absolute path so it can work if CWD is not here
1626 $lang_path = dirname(__FILE__). DIRECTORY_SEPARATOR . 'language'. DIRECTORY_SEPARATOR;
1629 $lang_file = $lang_path . 'phpmailer.lang-' . $langcode . '.php';
1630 // There is no English translation file
1631 if ($langcode != 'en') {
1632 // Make sure language file path is readable
1633 if (!is_readable($lang_file)) {
1636 // Overwrite language-specific strings.
1637 // This way we'll never have missing translation keys.
1638 $foundlang = include $lang_file;
1641 $this->language = $PHPMAILER_LANG;
1642 return (boolean)$foundlang; // Returns false if language not found
1646 * Get the array of strings for the current language.
1649 public function getTranslations()
1651 return $this->language;
1655 * Create recipient headers.
1657 * @param string $type
1658 * @param array $addr An array of recipient,
1659 * where each recipient is a 2-element indexed array with element 0 containing an address
1660 * and element 1 containing a name, like:
1661 * array(array('joe@example.com', 'Joe User'), array('zoe@example.com', 'Zoe User'))
1664 public function addrAppend($type, $addr)
1666 $addresses = array();
1667 foreach ($addr as $address) {
1668 $addresses[] = $this->addrFormat($address);
1670 return $type . ': ' . implode(', ', $addresses) . $this->LE;
1674 * Format an address for use in a message header.
1676 * @param array $addr A 2-element indexed array, element 0 containing an address, element 1 containing a name
1677 * like array('joe@example.com', 'Joe User')
1680 public function addrFormat($addr)
1682 if (empty($addr[1])) { // No name provided
1683 return $this->secureHeader($addr[0]);
1685 return $this->encodeHeader($this->secureHeader($addr[1]), 'phrase') . ' <' . $this->secureHeader(
1692 * Word-wrap message.
1693 * For use with mailers that do not automatically perform wrapping
1694 * and for quoted-printable encoded messages.
1695 * Original written by philippe.
1696 * @param string $message The message to wrap
1697 * @param integer $length The line length to wrap to
1698 * @param boolean $qp_mode Whether to run in Quoted-Printable mode
1702 public function wrapText($message, $length, $qp_mode = false)
1705 $soft_break = sprintf(' =%s', $this->LE);
1707 $soft_break = $this->LE;
1709 // If utf-8 encoding is used, we will need to make sure we don't
1710 // split multibyte characters when we wrap
1711 $is_utf8 = (strtolower($this->CharSet) == 'utf-8');
1712 $lelen = strlen($this->LE);
1713 $crlflen = strlen(self::CRLF);
1715 $message = $this->fixEOL($message);
1716 //Remove a trailing line break
1717 if (substr($message, -$lelen) == $this->LE) {
1718 $message = substr($message, 0, -$lelen);
1721 //Split message into lines
1722 $lines = explode($this->LE, $message);
1723 //Message will be rebuilt in here
1725 foreach ($lines as $line) {
1726 $words = explode(' ', $line);
1729 foreach ($words as $word) {
1730 if ($qp_mode and (strlen($word) > $length)) {
1731 $space_left = $length - strlen($buf) - $crlflen;
1733 if ($space_left > 20) {
1736 $len = $this->utf8CharBoundary($word, $len);
1737 } elseif (substr($word, $len - 1, 1) == '=') {
1739 } elseif (substr($word, $len - 2, 1) == '=') {
1742 $part = substr($word, 0, $len);
1743 $word = substr($word, $len);
1744 $buf .= ' ' . $part;
1745 $message .= $buf . sprintf('=%s', self::CRLF);
1747 $message .= $buf . $soft_break;
1751 while (strlen($word) > 0) {
1757 $len = $this->utf8CharBoundary($word, $len);
1758 } elseif (substr($word, $len - 1, 1) == '=') {
1760 } elseif (substr($word, $len - 2, 1) == '=') {
1763 $part = substr($word, 0, $len);
1764 $word = substr($word, $len);
1766 if (strlen($word) > 0) {
1767 $message .= $part . sprintf('=%s', self::CRLF);
1779 if (strlen($buf) > $length and $buf_o != '') {
1780 $message .= $buf_o . $soft_break;
1786 $message .= $buf . self::CRLF;
1793 * Find the last character boundary prior to $maxLength in a utf-8
1794 * quoted-printable encoded string.
1795 * Original written by Colin Brown.
1797 * @param string $encodedText utf-8 QP text
1798 * @param integer $maxLength Find the last character boundary prior to this length
1801 public function utf8CharBoundary($encodedText, $maxLength)
1803 $foundSplitPos = false;
1805 while (!$foundSplitPos) {
1806 $lastChunk = substr($encodedText, $maxLength - $lookBack, $lookBack);
1807 $encodedCharPos = strpos($lastChunk, '=');
1808 if (false !== $encodedCharPos) {
1809 // Found start of encoded character byte within $lookBack block.
1810 // Check the encoded byte value (the 2 chars after the '=')
1811 $hex = substr($encodedText, $maxLength - $lookBack + $encodedCharPos + 1, 2);
1812 $dec = hexdec($hex);
1814 // Single byte character.
1815 // If the encoded char was found at pos 0, it will fit
1816 // otherwise reduce maxLength to start of the encoded char
1817 if ($encodedCharPos > 0) {
1818 $maxLength = $maxLength - ($lookBack - $encodedCharPos);
1820 $foundSplitPos = true;
1821 } elseif ($dec >= 192) {
1822 // First byte of a multi byte character
1823 // Reduce maxLength to split at start of character
1824 $maxLength = $maxLength - ($lookBack - $encodedCharPos);
1825 $foundSplitPos = true;
1826 } elseif ($dec < 192) {
1827 // Middle byte of a multi byte character, look further back
1831 // No encoded character found
1832 $foundSplitPos = true;
1839 * Apply word wrapping to the message body.
1840 * Wraps the message body to the number of chars set in the WordWrap property.
1841 * You should only do this to plain-text bodies as wrapping HTML tags may break them.
1842 * This is called automatically by createBody(), so you don't need to call it yourself.
1846 public function setWordWrap()
1848 if ($this->WordWrap < 1) {
1852 switch ($this->message_type) {
1856 case 'alt_inline_attach':
1857 $this->AltBody = $this->wrapText($this->AltBody, $this->WordWrap);
1860 $this->Body = $this->wrapText($this->Body, $this->WordWrap);
1866 * Assemble message headers.
1868 * @return string The assembled headers
1870 public function createHeader()
1874 if ($this->MessageDate == '') {
1875 $this->MessageDate = self::rfcDate();
1877 $result .= $this->headerLine('Date', $this->MessageDate);
1879 // To be created automatically by mail()
1880 if ($this->SingleTo) {
1881 if ($this->Mailer != 'mail') {
1882 foreach ($this->to as $toaddr) {
1883 $this->SingleToArray[] = $this->addrFormat($toaddr);
1887 if (count($this->to) > 0) {
1888 if ($this->Mailer != 'mail') {
1889 $result .= $this->addrAppend('To', $this->to);
1891 } elseif (count($this->cc) == 0) {
1892 $result .= $this->headerLine('To', 'undisclosed-recipients:;');
1896 $result .= $this->addrAppend('From', array(array(trim($this->From), $this->FromName)));
1898 // sendmail and mail() extract Cc from the header before sending
1899 if (count($this->cc) > 0) {
1900 $result .= $this->addrAppend('Cc', $this->cc);
1903 // sendmail and mail() extract Bcc from the header before sending
1905 $this->Mailer == 'sendmail' or $this->Mailer == 'qmail' or $this->Mailer == 'mail'
1907 and count($this->bcc) > 0
1909 $result .= $this->addrAppend('Bcc', $this->bcc);
1912 if (count($this->ReplyTo) > 0) {
1913 $result .= $this->addrAppend('Reply-To', $this->ReplyTo);
1916 // mail() sets the subject itself
1917 if ($this->Mailer != 'mail') {
1918 $result .= $this->headerLine('Subject', $this->encodeHeader($this->secureHeader($this->Subject)));
1921 if ($this->MessageID != '') {
1922 $this->lastMessageID = $this->MessageID;
1924 $this->lastMessageID = sprintf('<%s@%s>', $this->uniqueid, $this->serverHostname());
1926 $result .= $this->headerLine('Message-ID', $this->lastMessageID);
1927 if (!is_null($this->Priority)) {
1928 $result .= $this->headerLine('X-Priority', $this->Priority);
1930 if ($this->XMailer == '') {
1931 $result .= $this->headerLine(
1933 'PHPMailer ' . $this->Version . ' (https://github.com/PHPMailer/PHPMailer)'
1936 $myXmailer = trim($this->XMailer);
1938 $result .= $this->headerLine('X-Mailer', $myXmailer);
1942 if ($this->ConfirmReadingTo != '') {
1943 $result .= $this->headerLine('Disposition-Notification-To', '<' . $this->ConfirmReadingTo . '>');
1946 // Add custom headers
1947 foreach ($this->CustomHeader as $header) {
1948 $result .= $this->headerLine(
1950 $this->encodeHeader(trim($header[1]))
1953 if (!$this->sign_key_file) {
1954 $result .= $this->headerLine('MIME-Version', '1.0');
1955 $result .= $this->getMailMIME();
1962 * Get the message MIME type headers.
1966 public function getMailMIME()
1969 $ismultipart = true;
1970 switch ($this->message_type) {
1972 $result .= $this->headerLine('Content-Type', 'multipart/related;');
1973 $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
1976 case 'inline_attach':
1978 case 'alt_inline_attach':
1979 $result .= $this->headerLine('Content-Type', 'multipart/mixed;');
1980 $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
1984 $result .= $this->headerLine('Content-Type', 'multipart/alternative;');
1985 $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
1988 // Catches case 'plain': and case '':
1989 $result .= $this->textLine('Content-Type: ' . $this->ContentType . '; charset=' . $this->CharSet);
1990 $ismultipart = false;
1993 // RFC1341 part 5 says 7bit is assumed if not specified
1994 if ($this->Encoding != '7bit') {
1995 // RFC 2045 section 6.4 says multipart MIME parts may only use 7bit, 8bit or binary CTE
1997 if ($this->Encoding == '8bit') {
1998 $result .= $this->headerLine('Content-Transfer-Encoding', '8bit');
2000 // The only remaining alternatives are quoted-printable and base64, which are both 7bit compatible
2002 $result .= $this->headerLine('Content-Transfer-Encoding', $this->Encoding);
2006 if ($this->Mailer != 'mail') {
2007 $result .= $this->LE;
2014 * Returns the whole MIME message.
2015 * Includes complete headers and body.
2016 * Only valid post preSend().
2017 * @see PHPMailer::preSend()
2021 public function getSentMIMEMessage()
2023 return $this->MIMEHeader . $this->mailHeader . self::CRLF . $this->MIMEBody;
2027 * Assemble the message body.
2028 * Returns an empty string on failure.
2030 * @throws phpmailerException
2031 * @return string The assembled message body
2033 public function createBody()
2036 //Create unique IDs and preset boundaries
2037 $this->uniqueid = md5(uniqid(time()));
2038 $this->boundary[1] = 'b1_' . $this->uniqueid;
2039 $this->boundary[2] = 'b2_' . $this->uniqueid;
2040 $this->boundary[3] = 'b3_' . $this->uniqueid;
2042 if ($this->sign_key_file) {
2043 $body .= $this->getMailMIME() . $this->LE;
2046 $this->setWordWrap();
2048 $bodyEncoding = $this->Encoding;
2049 $bodyCharSet = $this->CharSet;
2050 //Can we do a 7-bit downgrade?
2051 if ($bodyEncoding == '8bit' and !$this->has8bitChars($this->Body)) {
2052 $bodyEncoding = '7bit';
2053 $bodyCharSet = 'us-ascii';
2055 //If lines are too long, change to quoted-printable transfer encoding
2056 if (self::hasLineLongerThanMax($this->Body)) {
2057 $this->Encoding = 'quoted-printable';
2058 $bodyEncoding = 'quoted-printable';
2061 $altBodyEncoding = $this->Encoding;
2062 $altBodyCharSet = $this->CharSet;
2063 //Can we do a 7-bit downgrade?
2064 if ($altBodyEncoding == '8bit' and !$this->has8bitChars($this->AltBody)) {
2065 $altBodyEncoding = '7bit';
2066 $altBodyCharSet = 'us-ascii';
2068 //If lines are too long, change to quoted-printable transfer encoding
2069 if (self::hasLineLongerThanMax($this->AltBody)) {
2070 $altBodyEncoding = 'quoted-printable';
2072 //Use this as a preamble in all multipart message types
2073 $mimepre = "This is a multi-part message in MIME format." . $this->LE . $this->LE;
2074 switch ($this->message_type) {
2077 $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);
2078 $body .= $this->encodeString($this->Body, $bodyEncoding);
2079 $body .= $this->LE . $this->LE;
2080 $body .= $this->attachAll('inline', $this->boundary[1]);
2084 $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);
2085 $body .= $this->encodeString($this->Body, $bodyEncoding);
2086 $body .= $this->LE . $this->LE;
2087 $body .= $this->attachAll('attachment', $this->boundary[1]);
2089 case 'inline_attach':
2091 $body .= $this->textLine('--' . $this->boundary[1]);
2092 $body .= $this->headerLine('Content-Type', 'multipart/related;');
2093 $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
2095 $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, '', $bodyEncoding);
2096 $body .= $this->encodeString($this->Body, $bodyEncoding);
2097 $body .= $this->LE . $this->LE;
2098 $body .= $this->attachAll('inline', $this->boundary[2]);
2100 $body .= $this->attachAll('attachment', $this->boundary[1]);
2104 $body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, 'text/plain', $altBodyEncoding);
2105 $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
2106 $body .= $this->LE . $this->LE;
2107 $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, 'text/html', $bodyEncoding);
2108 $body .= $this->encodeString($this->Body, $bodyEncoding);
2109 $body .= $this->LE . $this->LE;
2110 if (!empty($this->Ical)) {
2111 $body .= $this->getBoundary($this->boundary[1], '', 'text/calendar; method=REQUEST', '');
2112 $body .= $this->encodeString($this->Ical, $this->Encoding);
2113 $body .= $this->LE . $this->LE;
2115 $body .= $this->endBoundary($this->boundary[1]);
2119 $body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, 'text/plain', $altBodyEncoding);
2120 $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
2121 $body .= $this->LE . $this->LE;
2122 $body .= $this->textLine('--' . $this->boundary[1]);
2123 $body .= $this->headerLine('Content-Type', 'multipart/related;');
2124 $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
2126 $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, 'text/html', $bodyEncoding);
2127 $body .= $this->encodeString($this->Body, $bodyEncoding);
2128 $body .= $this->LE . $this->LE;
2129 $body .= $this->attachAll('inline', $this->boundary[2]);
2131 $body .= $this->endBoundary($this->boundary[1]);
2135 $body .= $this->textLine('--' . $this->boundary[1]);
2136 $body .= $this->headerLine('Content-Type', 'multipart/alternative;');
2137 $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
2139 $body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, 'text/plain', $altBodyEncoding);
2140 $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
2141 $body .= $this->LE . $this->LE;
2142 $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, 'text/html', $bodyEncoding);
2143 $body .= $this->encodeString($this->Body, $bodyEncoding);
2144 $body .= $this->LE . $this->LE;
2145 $body .= $this->endBoundary($this->boundary[2]);
2147 $body .= $this->attachAll('attachment', $this->boundary[1]);
2149 case 'alt_inline_attach':
2151 $body .= $this->textLine('--' . $this->boundary[1]);
2152 $body .= $this->headerLine('Content-Type', 'multipart/alternative;');
2153 $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
2155 $body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, 'text/plain', $altBodyEncoding);
2156 $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
2157 $body .= $this->LE . $this->LE;
2158 $body .= $this->textLine('--' . $this->boundary[2]);
2159 $body .= $this->headerLine('Content-Type', 'multipart/related;');
2160 $body .= $this->textLine("\tboundary=\"" . $this->boundary[3] . '"');
2162 $body .= $this->getBoundary($this->boundary[3], $bodyCharSet, 'text/html', $bodyEncoding);
2163 $body .= $this->encodeString($this->Body, $bodyEncoding);
2164 $body .= $this->LE . $this->LE;
2165 $body .= $this->attachAll('inline', $this->boundary[3]);
2167 $body .= $this->endBoundary($this->boundary[2]);
2169 $body .= $this->attachAll('attachment', $this->boundary[1]);
2172 // catch case 'plain' and case ''
2173 $body .= $this->encodeString($this->Body, $bodyEncoding);
2177 if ($this->isError()) {
2179 } elseif ($this->sign_key_file) {
2181 if (!defined('PKCS7_TEXT')) {
2182 throw new phpmailerException($this->lang('extension_missing') . 'openssl');
2184 // @TODO would be nice to use php://temp streams here, but need to wrap for PHP < 5.1
2185 $file = tempnam(sys_get_temp_dir(), 'mail');
2186 if (false === file_put_contents($file, $body)) {
2187 throw new phpmailerException($this->lang('signing') . ' Could not write temp file');
2189 $signed = tempnam(sys_get_temp_dir(), 'signed');
2190 //Workaround for PHP bug https://bugs.php.net/bug.php?id=69197
2191 if (empty($this->sign_extracerts_file)) {
2192 $sign = @openssl_pkcs7_sign(
2195 'file://' . realpath($this->sign_cert_file),
2196 array('file://' . realpath($this->sign_key_file), $this->sign_key_pass),
2200 $sign = @openssl_pkcs7_sign(
2203 'file://' . realpath($this->sign_cert_file),
2204 array('file://' . realpath($this->sign_key_file), $this->sign_key_pass),
2207 $this->sign_extracerts_file
2212 $body = file_get_contents($signed);
2214 //The message returned by openssl contains both headers and body, so need to split them up
2215 $parts = explode("\n\n", $body, 2);
2216 $this->MIMEHeader .= $parts[0] . $this->LE . $this->LE;
2221 throw new phpmailerException($this->lang('signing') . openssl_error_string());
2223 } catch (phpmailerException $exc) {
2225 if ($this->exceptions) {
2234 * Return the start of a message boundary.
2236 * @param string $boundary
2237 * @param string $charSet
2238 * @param string $contentType
2239 * @param string $encoding
2242 protected function getBoundary($boundary, $charSet, $contentType, $encoding)
2245 if ($charSet == '') {
2246 $charSet = $this->CharSet;
2248 if ($contentType == '') {
2249 $contentType = $this->ContentType;
2251 if ($encoding == '') {
2252 $encoding = $this->Encoding;
2254 $result .= $this->textLine('--' . $boundary);
2255 $result .= sprintf('Content-Type: %s; charset=%s', $contentType, $charSet);
2256 $result .= $this->LE;
2257 // RFC1341 part 5 says 7bit is assumed if not specified
2258 if ($encoding != '7bit') {
2259 $result .= $this->headerLine('Content-Transfer-Encoding', $encoding);
2261 $result .= $this->LE;
2267 * Return the end of a message boundary.
2269 * @param string $boundary
2272 protected function endBoundary($boundary)
2274 return $this->LE . '--' . $boundary . '--' . $this->LE;
2278 * Set the message type.
2279 * PHPMailer only supports some preset message types,
2280 * not arbitrary MIME structures.
2284 protected function setMessageType()
2287 if ($this->alternativeExists()) {
2290 if ($this->inlineImageExists()) {
2293 if ($this->attachmentExists()) {
2296 $this->message_type = implode('_', $type);
2297 if ($this->message_type == '') {
2298 $this->message_type = 'plain';
2303 * Format a header line.
2305 * @param string $name
2306 * @param string $value
2309 public function headerLine($name, $value)
2311 return $name . ': ' . $value . $this->LE;
2315 * Return a formatted mail line.
2317 * @param string $value
2320 public function textLine($value)
2322 return $value . $this->LE;
2326 * Add an attachment from a path on the filesystem.
2327 * Returns false if the file could not be found or read.
2328 * @param string $path Path to the attachment.
2329 * @param string $name Overrides the attachment name.
2330 * @param string $encoding File encoding (see $Encoding).
2331 * @param string $type File extension (MIME) type.
2332 * @param string $disposition Disposition to use
2333 * @throws phpmailerException
2336 public function addAttachment($path, $name = '', $encoding = 'base64', $type = '', $disposition = 'attachment')
2339 if (!@is_file($path)) {
2340 throw new phpmailerException($this->lang('file_access') . $path, self::STOP_CONTINUE);
2343 // If a MIME type is not specified, try to work it out from the file name
2345 $type = self::filenameToType($path);
2348 $filename = basename($path);
2353 $this->attachment[] = array(
2359 5 => false, // isStringAttachment
2364 } catch (phpmailerException $exc) {
2365 $this->setError($exc->getMessage());
2366 $this->edebug($exc->getMessage());
2367 if ($this->exceptions) {
2376 * Return the array of attachments.
2379 public function getAttachments()
2381 return $this->attachment;
2385 * Attach all file, string, and binary attachments to the message.
2386 * Returns an empty string on failure.
2388 * @param string $disposition_type
2389 * @param string $boundary
2392 protected function attachAll($disposition_type, $boundary)
2394 // Return text of body
2399 // Add all attachments
2400 foreach ($this->attachment as $attachment) {
2401 // Check if it is a valid disposition_filter
2402 if ($attachment[6] == $disposition_type) {
2403 // Check for string attachment
2406 $bString = $attachment[5];
2408 $string = $attachment[0];
2410 $path = $attachment[0];
2413 $inclhash = md5(serialize($attachment));
2414 if (in_array($inclhash, $incl)) {
2417 $incl[] = $inclhash;
2418 $name = $attachment[2];
2419 $encoding = $attachment[3];
2420 $type = $attachment[4];
2421 $disposition = $attachment[6];
2422 $cid = $attachment[7];
2423 if ($disposition == 'inline' && array_key_exists($cid, $cidUniq)) {
2426 $cidUniq[$cid] = true;
2428 $mime[] = sprintf('--%s%s', $boundary, $this->LE);
2429 //Only include a filename property if we have one
2430 if (!empty($name)) {
2432 'Content-Type: %s; name="%s"%s',
2434 $this->encodeHeader($this->secureHeader($name)),
2439 'Content-Type: %s%s',
2444 // RFC1341 part 5 says 7bit is assumed if not specified
2445 if ($encoding != '7bit') {
2446 $mime[] = sprintf('Content-Transfer-Encoding: %s%s', $encoding, $this->LE);
2449 if ($disposition == 'inline') {
2450 $mime[] = sprintf('Content-ID: <%s>%s', $cid, $this->LE);
2453 // If a filename contains any of these chars, it should be quoted,
2454 // but not otherwise: RFC2183 & RFC2045 5.1
2455 // Fixes a warning in IETF's msglint MIME checker
2456 // Allow for bypassing the Content-Disposition header totally
2457 if (!(empty($disposition))) {
2458 $encoded_name = $this->encodeHeader($this->secureHeader($name));
2459 if (preg_match('/[ \(\)<>@,;:\\"\/\[\]\?=]/', $encoded_name)) {
2461 'Content-Disposition: %s; filename="%s"%s',
2464 $this->LE . $this->LE
2467 if (!empty($encoded_name)) {
2469 'Content-Disposition: %s; filename=%s%s',
2472 $this->LE . $this->LE
2476 'Content-Disposition: %s%s',
2478 $this->LE . $this->LE
2483 $mime[] = $this->LE;
2486 // Encode as string attachment
2488 $mime[] = $this->encodeString($string, $encoding);
2489 if ($this->isError()) {
2492 $mime[] = $this->LE . $this->LE;
2494 $mime[] = $this->encodeFile($path, $encoding);
2495 if ($this->isError()) {
2498 $mime[] = $this->LE . $this->LE;
2503 $mime[] = sprintf('--%s--%s', $boundary, $this->LE);
2505 return implode('', $mime);
2509 * Encode a file attachment in requested format.
2510 * Returns an empty string on failure.
2511 * @param string $path The full path to the file
2512 * @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
2513 * @throws phpmailerException
2517 protected function encodeFile($path, $encoding = 'base64')
2520 if (!is_readable($path)) {
2521 throw new phpmailerException($this->lang('file_open') . $path, self::STOP_CONTINUE);
2523 $magic_quotes = get_magic_quotes_runtime();
2524 if ($magic_quotes) {
2525 if (version_compare(PHP_VERSION, '5.3.0', '<')) {
2526 set_magic_quotes_runtime(false);
2528 //Doesn't exist in PHP 5.4, but we don't need to check because
2529 //get_magic_quotes_runtime always returns false in 5.4+
2530 //so it will never get here
2531 ini_set('magic_quotes_runtime', false);
2534 $file_buffer = file_get_contents($path);
2535 $file_buffer = $this->encodeString($file_buffer, $encoding);
2536 if ($magic_quotes) {
2537 if (version_compare(PHP_VERSION, '5.3.0', '<')) {
2538 set_magic_quotes_runtime($magic_quotes);
2540 ini_set('magic_quotes_runtime', $magic_quotes);
2543 return $file_buffer;
2544 } catch (Exception $exc) {
2545 $this->setError($exc->getMessage());
2551 * Encode a string in requested format.
2552 * Returns an empty string on failure.
2553 * @param string $str The text to encode
2554 * @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
2558 public function encodeString($str, $encoding = 'base64')
2561 switch (strtolower($encoding)) {
2563 $encoded = chunk_split(base64_encode($str), 76, $this->LE);
2567 $encoded = $this->fixEOL($str);
2568 // Make sure it ends with a line break
2569 if (substr($encoded, -(strlen($this->LE))) != $this->LE) {
2570 $encoded .= $this->LE;
2576 case 'quoted-printable':
2577 $encoded = $this->encodeQP($str);
2580 $this->setError($this->lang('encoding') . $encoding);
2587 * Encode a header string optimally.
2588 * Picks shortest of Q, B, quoted-printable or none.
2590 * @param string $str
2591 * @param string $position
2594 public function encodeHeader($str, $position = 'text')
2597 switch (strtolower($position)) {
2599 if (!preg_match('/[\200-\377]/', $str)) {
2600 // Can't use addslashes as we don't know the value of magic_quotes_sybase
2601 $encoded = addcslashes($str, "\0..\37\177\\\"");
2602 if (($str == $encoded) && !preg_match('/[^A-Za-z0-9!#$%&\'*+\/=?^_`{|}~ -]/', $str)) {
2605 return ("\"$encoded\"");
2608 $matchcount = preg_match_all('/[^\040\041\043-\133\135-\176]/', $str, $matches);
2610 /** @noinspection PhpMissingBreakStatementInspection */
2612 $matchcount = preg_match_all('/[()"]/', $str, $matches);
2613 // Intentional fall-through
2616 $matchcount += preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $str, $matches);
2620 //There are no chars that need encoding
2621 if ($matchcount == 0) {
2625 $maxlen = 75 - 7 - strlen($this->CharSet);
2626 // Try to select the encoding which should produce the shortest output
2627 if ($matchcount > strlen($str) / 3) {
2628 // More than a third of the content will need encoding, so B encoding will be most efficient
2630 if (function_exists('mb_strlen') && $this->hasMultiBytes($str)) {
2631 // Use a custom function which correctly encodes and wraps long
2632 // multibyte strings without breaking lines within a character
2633 $encoded = $this->base64EncodeWrapMB($str, "\n");
2635 $encoded = base64_encode($str);
2636 $maxlen -= $maxlen % 4;
2637 $encoded = trim(chunk_split($encoded, $maxlen, "\n"));
2641 $encoded = $this->encodeQ($str, $position);
2642 $encoded = $this->wrapText($encoded, $maxlen, true);
2643 $encoded = str_replace('=' . self::CRLF, "\n", trim($encoded));
2646 $encoded = preg_replace('/^(.*)$/m', ' =?' . $this->CharSet . "?$encoding?\\1?=", $encoded);
2647 $encoded = trim(str_replace("\n", $this->LE, $encoded));
2653 * Check if a string contains multi-byte characters.
2655 * @param string $str multi-byte text to wrap encode
2658 public function hasMultiBytes($str)
2660 if (function_exists('mb_strlen')) {
2661 return (strlen($str) > mb_strlen($str, $this->CharSet));
2662 } else { // Assume no multibytes (we can't handle without mbstring functions anyway)
2668 * Does a string contain any 8-bit chars (in any charset)?
2669 * @param string $text
2672 public function has8bitChars($text)
2674 return (boolean)preg_match('/[\x80-\xFF]/', $text);
2678 * Encode and wrap long multibyte strings for mail headers
2679 * without breaking lines within a character.
2680 * Adapted from a function by paravoid
2681 * @link http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283
2683 * @param string $str multi-byte text to wrap encode
2684 * @param string $linebreak string to use as linefeed/end-of-line
2687 public function base64EncodeWrapMB($str, $linebreak = null)
2689 $start = '=?' . $this->CharSet . '?B?';
2692 if ($linebreak === null) {
2693 $linebreak = $this->LE;
2696 $mb_length = mb_strlen($str, $this->CharSet);
2697 // Each line must have length <= 75, including $start and $end
2698 $length = 75 - strlen($start) - strlen($end);
2699 // Average multi-byte ratio
2700 $ratio = $mb_length / strlen($str);
2701 // Base64 has a 4:3 ratio
2702 $avgLength = floor($length * $ratio * .75);
2704 for ($i = 0; $i < $mb_length; $i += $offset) {
2707 $offset = $avgLength - $lookBack;
2708 $chunk = mb_substr($str, $i, $offset, $this->CharSet);
2709 $chunk = base64_encode($chunk);
2711 } while (strlen($chunk) > $length);
2712 $encoded .= $chunk . $linebreak;
2715 // Chomp the last linefeed
2716 $encoded = substr($encoded, 0, -strlen($linebreak));
2721 * Encode a string in quoted-printable format.
2722 * According to RFC2045 section 6.7.
2724 * @param string $string The text to encode
2725 * @param integer $line_max Number of chars allowed on a line before wrapping
2727 * @link http://www.php.net/manual/en/function.quoted-printable-decode.php#89417 Adapted from this comment
2729 public function encodeQP($string, $line_max = 76)
2731 // Use native function if it's available (>= PHP5.3)
2732 if (function_exists('quoted_printable_encode')) {
2733 return quoted_printable_encode($string);
2735 // Fall back to a pure PHP implementation
2736 $string = str_replace(
2737 array('%20', '%0D%0A.', '%0D%0A', '%'),
2738 array(' ', "\r\n=2E", "\r\n", '='),
2739 rawurlencode($string)
2741 return preg_replace('/[^\r\n]{' . ($line_max - 3) . '}[^=\r\n]{2}/', "$0=\r\n", $string);
2745 * Backward compatibility wrapper for an old QP encoding function that was removed.
2746 * @see PHPMailer::encodeQP()
2748 * @param string $string
2749 * @param integer $line_max
2750 * @param boolean $space_conv
2752 * @deprecated Use encodeQP instead.
2754 public function encodeQPphp(
2757 /** @noinspection PhpUnusedParameterInspection */ $space_conv = false
2759 return $this->encodeQP($string, $line_max);
2763 * Encode a string using Q encoding.
2764 * @link http://tools.ietf.org/html/rfc2047
2765 * @param string $str the text to encode
2766 * @param string $position Where the text is going to be used, see the RFC for what that means
2770 public function encodeQ($str, $position = 'text')
2772 // There should not be any EOL in the string
2774 $encoded = str_replace(array("\r", "\n"), '', $str);
2775 switch (strtolower($position)) {
2777 // RFC 2047 section 5.3
2778 $pattern = '^A-Za-z0-9!*+\/ -';
2780 /** @noinspection PhpMissingBreakStatementInspection */
2782 // RFC 2047 section 5.2
2784 // intentional fall-through
2785 // for this reason we build the $pattern without including delimiters and []
2788 // RFC 2047 section 5.1
2789 // Replace every high ascii, control, =, ? and _ characters
2790 $pattern = '\000-\011\013\014\016-\037\075\077\137\177-\377' . $pattern;
2794 if (preg_match_all("/[{$pattern}]/", $encoded, $matches)) {
2795 // If the string contains an '=', make sure it's the first thing we replace
2796 // so as to avoid double-encoding
2797 $eqkey = array_search('=', $matches[0]);
2798 if (false !== $eqkey) {
2799 unset($matches[0][$eqkey]);
2800 array_unshift($matches[0], '=');
2802 foreach (array_unique($matches[0]) as $char) {
2803 $encoded = str_replace($char, '=' . sprintf('%02X', ord($char)), $encoded);
2806 // Replace every spaces to _ (more readable than =20)
2807 return str_replace(' ', '_', $encoded);
2811 * Add a string or binary attachment (non-filesystem).
2812 * This method can be used to attach ascii or binary data,
2813 * such as a BLOB record from a database.
2814 * @param string $string String attachment data.
2815 * @param string $filename Name of the attachment.
2816 * @param string $encoding File encoding (see $Encoding).
2817 * @param string $type File extension (MIME) type.
2818 * @param string $disposition Disposition to use
2821 public function addStringAttachment(
2824 $encoding = 'base64',
2826 $disposition = 'attachment'
2828 // If a MIME type is not specified, try to work it out from the file name
2830 $type = self::filenameToType($filename);
2832 // Append to $attachment array
2833 $this->attachment[] = array(
2836 2 => basename($filename),
2839 5 => true, // isStringAttachment
2846 * Add an embedded (inline) attachment from a file.
2847 * This can include images, sounds, and just about any other document type.
2848 * These differ from 'regular' attachments in that they are intended to be
2849 * displayed inline with the message, not just attached for download.
2850 * This is used in HTML messages that embed the images
2851 * the HTML refers to using the $cid value.
2852 * @param string $path Path to the attachment.
2853 * @param string $cid Content ID of the attachment; Use this to reference
2854 * the content when using an embedded image in HTML.
2855 * @param string $name Overrides the attachment name.
2856 * @param string $encoding File encoding (see $Encoding).
2857 * @param string $type File MIME type.
2858 * @param string $disposition Disposition to use
2859 * @return boolean True on successfully adding an attachment
2861 public function addEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = '', $disposition = 'inline')
2863 if (!@is_file($path)) {
2864 $this->setError($this->lang('file_access') . $path);
2868 // If a MIME type is not specified, try to work it out from the file name
2870 $type = self::filenameToType($path);
2873 $filename = basename($path);
2878 // Append to $attachment array
2879 $this->attachment[] = array(
2885 5 => false, // isStringAttachment
2893 * Add an embedded stringified attachment.
2894 * This can include images, sounds, and just about any other document type.
2895 * Be sure to set the $type to an image type for images:
2896 * JPEG images use 'image/jpeg', GIF uses 'image/gif', PNG uses 'image/png'.
2897 * @param string $string The attachment binary data.
2898 * @param string $cid Content ID of the attachment; Use this to reference
2899 * the content when using an embedded image in HTML.
2900 * @param string $name
2901 * @param string $encoding File encoding (see $Encoding).
2902 * @param string $type MIME type.
2903 * @param string $disposition Disposition to use
2904 * @return boolean True on successfully adding an attachment
2906 public function addStringEmbeddedImage(
2910 $encoding = 'base64',
2912 $disposition = 'inline'
2914 // If a MIME type is not specified, try to work it out from the name
2915 if ($type == '' and !empty($name)) {
2916 $type = self::filenameToType($name);
2919 // Append to $attachment array
2920 $this->attachment[] = array(
2926 5 => true, // isStringAttachment
2934 * Check if an inline attachment is present.
2938 public function inlineImageExists()
2940 foreach ($this->attachment as $attachment) {
2941 if ($attachment[6] == 'inline') {
2949 * Check if an attachment (non-inline) is present.
2952 public function attachmentExists()
2954 foreach ($this->attachment as $attachment) {
2955 if ($attachment[6] == 'attachment') {
2963 * Check if this message has an alternative body set.
2966 public function alternativeExists()
2968 return !empty($this->AltBody);
2972 * Clear queued addresses of given kind.
2974 * @param string $kind 'to', 'cc', or 'bcc'
2977 public function clearQueuedAddresses($kind)
2979 $RecipientsQueue = $this->RecipientsQueue;
2980 foreach ($RecipientsQueue as $address => $params) {
2981 if ($params[0] == $kind) {
2982 unset($this->RecipientsQueue[$address]);
2988 * Clear all To recipients.
2991 public function clearAddresses()
2993 foreach ($this->to as $to) {
2994 unset($this->all_recipients[strtolower($to[0])]);
2996 $this->to = array();
2997 $this->clearQueuedAddresses('to');
3001 * Clear all CC recipients.
3004 public function clearCCs()
3006 foreach ($this->cc as $cc) {
3007 unset($this->all_recipients[strtolower($cc[0])]);
3009 $this->cc = array();
3010 $this->clearQueuedAddresses('cc');
3014 * Clear all BCC recipients.
3017 public function clearBCCs()
3019 foreach ($this->bcc as $bcc) {
3020 unset($this->all_recipients[strtolower($bcc[0])]);
3022 $this->bcc = array();
3023 $this->clearQueuedAddresses('bcc');
3027 * Clear all ReplyTo recipients.
3030 public function clearReplyTos()
3032 $this->ReplyTo = array();
3033 $this->ReplyToQueue = array();
3037 * Clear all recipient types.
3040 public function clearAllRecipients()
3042 $this->to = array();
3043 $this->cc = array();
3044 $this->bcc = array();
3045 $this->all_recipients = array();
3046 $this->RecipientsQueue = array();
3050 * Clear all filesystem, string, and binary attachments.
3053 public function clearAttachments()
3055 $this->attachment = array();
3059 * Clear all custom headers.
3062 public function clearCustomHeaders()
3064 $this->CustomHeader = array();
3068 * Add an error message to the error container.
3070 * @param string $msg
3073 protected function setError($msg)
3075 $this->error_count++;
3076 if ($this->Mailer == 'smtp' and !is_null($this->smtp)) {
3077 $lasterror = $this->smtp->getError();
3078 if (!empty($lasterror['error'])) {
3079 $msg .= $this->lang('smtp_error') . $lasterror['error'];
3080 if (!empty($lasterror['detail'])) {
3081 $msg .= ' Detail: '. $lasterror['detail'];
3083 if (!empty($lasterror['smtp_code'])) {
3084 $msg .= ' SMTP code: ' . $lasterror['smtp_code'];
3086 if (!empty($lasterror['smtp_code_ex'])) {
3087 $msg .= ' Additional SMTP info: ' . $lasterror['smtp_code_ex'];
3091 $this->ErrorInfo = $msg;
3095 * Return an RFC 822 formatted date.
3100 public static function rfcDate()
3102 // Set the time zone to whatever the default is to avoid 500 errors
3103 // Will default to UTC if it's not set properly in php.ini
3104 date_default_timezone_set(@date_default_timezone_get());
3105 return date('D, j M Y H:i:s O');
3109 * Get the server hostname.
3110 * Returns 'localhost.localdomain' if unknown.
3114 protected function serverHostname()
3116 $result = 'localhost.localdomain';
3117 if (!empty($this->Hostname)) {
3118 $result = $this->Hostname;
3119 } elseif (isset($_SERVER) and array_key_exists('SERVER_NAME', $_SERVER) and !empty($_SERVER['SERVER_NAME'])) {
3120 $result = $_SERVER['SERVER_NAME'];
3121 } elseif (function_exists('gethostname') && gethostname() !== false) {
3122 $result = gethostname();
3123 } elseif (php_uname('n') !== false) {
3124 $result = php_uname('n');
3130 * Get an error message in the current language.
3132 * @param string $key
3135 protected function lang($key)
3137 if (count($this->language) < 1) {
3138 $this->setLanguage('en'); // set the default language
3141 if (array_key_exists($key, $this->language)) {
3142 if ($key == 'smtp_connect_failed') {
3143 //Include a link to troubleshooting docs on SMTP connection failure
3144 //this is by far the biggest cause of support questions
3145 //but it's usually not PHPMailer's fault.
3146 return $this->language[$key] . ' https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting';
3148 return $this->language[$key];
3150 //Return the key as a fallback
3156 * Check if an error occurred.
3158 * @return boolean True if an error did occur.
3160 public function isError()
3162 return ($this->error_count > 0);
3166 * Ensure consistent line endings in a string.
3167 * Changes every end of line from CRLF, CR or LF to $this->LE.
3169 * @param string $str String to fixEOL
3172 public function fixEOL($str)
3175 $nstr = str_replace(array("\r\n", "\r"), "\n", $str);
3176 // Now convert LE as needed
3177 if ($this->LE !== "\n") {
3178 $nstr = str_replace("\n", $this->LE, $nstr);
3184 * Add a custom header.
3185 * $name value can be overloaded to contain
3186 * both header name and value (name:value)
3188 * @param string $name Custom header name
3189 * @param string $value Header value
3192 public function addCustomHeader($name, $value = null)
3194 if ($value === null) {
3195 // Value passed in as name:value
3196 $this->CustomHeader[] = explode(':', $name, 2);
3198 $this->CustomHeader[] = array($name, $value);
3203 * Returns all custom headers.
3206 public function getCustomHeaders()
3208 return $this->CustomHeader;
3212 * Create a message from an HTML string.
3213 * Automatically makes modifications for inline images and backgrounds
3214 * and creates a plain-text version by converting the HTML.
3215 * Overwrites any existing values in $this->Body and $this->AltBody
3217 * @param string $message HTML message string
3218 * @param string $basedir baseline directory for path
3219 * @param boolean|callable $advanced Whether to use the internal HTML to text converter
3220 * or your own custom converter @see PHPMailer::html2text()
3221 * @return string $message
3223 public function msgHTML($message, $basedir = '', $advanced = false)
3225 preg_match_all('/(src|background)=["\'](.*)["\']/Ui', $message, $images);
3226 if (array_key_exists(2, $images)) {
3227 foreach ($images[2] as $imgindex => $url) {
3228 // Convert data URIs into embedded images
3229 if (preg_match('#^data:(image[^;,]*)(;base64)?,#', $url, $match)) {
3230 $data = substr($url, strpos($url, ','));
3232 $data = base64_decode($data);
3234 $data = rawurldecode($data);
3236 $cid = md5($url) . '@phpmailer.0'; // RFC2392 S 2
3237 if ($this->addStringEmbeddedImage($data, $cid, 'embed' . $imgindex, 'base64', $match[1])) {
3238 $message = str_replace(
3239 $images[0][$imgindex],
3240 $images[1][$imgindex] . '="cid:' . $cid . '"',
3244 } elseif (substr($url, 0, 4) !== 'cid:' && !preg_match('#^[A-z]+://#', $url)) {
3245 // Do not change urls for absolute images (thanks to corvuscorax)
3246 // Do not change urls that are already inline images
3247 $filename = basename($url);
3248 $directory = dirname($url);
3249 if ($directory == '.') {
3252 $cid = md5($url) . '@phpmailer.0'; // RFC2392 S 2
3253 if (strlen($basedir) > 1 && substr($basedir, -1) != '/') {
3256 if (strlen($directory) > 1 && substr($directory, -1) != '/') {
3259 if ($this->addEmbeddedImage(
3260 $basedir . $directory . $filename,
3264 self::_mime_types((string)self::mb_pathinfo($filename, PATHINFO_EXTENSION))
3267 $message = preg_replace(
3268 '/' . $images[1][$imgindex] . '=["\']' . preg_quote($url, '/') . '["\']/Ui',
3269 $images[1][$imgindex] . '="cid:' . $cid . '"',
3276 $this->isHTML(true);
3277 // Convert all message body line breaks to CRLF, makes quoted-printable encoding work much better
3278 $this->Body = $this->normalizeBreaks($message);
3279 $this->AltBody = $this->normalizeBreaks($this->html2text($message, $advanced));
3280 if (empty($this->AltBody)) {
3281 $this->AltBody = 'To view this email message, open it in a program that understands HTML!' .
3282 self::CRLF . self::CRLF;
3288 * Convert an HTML string into plain text.
3289 * This is used by msgHTML().
3290 * Note - older versions of this function used a bundled advanced converter
3291 * which was been removed for license reasons in #232
3294 * // Use default conversion
3295 * $plain = $mail->html2text($html);
3296 * // Use your own custom converter
3297 * $plain = $mail->html2text($html, function($html) {
3298 * $converter = new MyHtml2text($html);
3299 * return $converter->get_text();
3302 * @param string $html The HTML text to convert
3303 * @param boolean|callable $advanced Any boolean value to use the internal converter,
3304 * or provide your own callable for custom conversion.
3307 public function html2text($html, $advanced = false)
3309 if (is_callable($advanced)) {
3310 return call_user_func($advanced, $html);
3312 return html_entity_decode(
3313 trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/si', '', $html))),
3320 * Get the MIME type for a file extension.
3321 * @param string $ext File extension
3323 * @return string MIME type of file.
3326 public static function _mime_types($ext = '')
3329 'xl' => 'application/excel',
3330 'js' => 'application/javascript',
3331 'hqx' => 'application/mac-binhex40',
3332 'cpt' => 'application/mac-compactpro',
3333 'bin' => 'application/macbinary',
3334 'doc' => 'application/msword',
3335 'word' => 'application/msword',
3336 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
3337 'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
3338 'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template',
3339 'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
3340 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
3341 'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
3342 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
3343 'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
3344 'xlam' => 'application/vnd.ms-excel.addin.macroEnabled.12',
3345 'xlsb' => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
3346 'class' => 'application/octet-stream',
3347 'dll' => 'application/octet-stream',
3348 'dms' => 'application/octet-stream',
3349 'exe' => 'application/octet-stream',
3350 'lha' => 'application/octet-stream',
3351 'lzh' => 'application/octet-stream',
3352 'psd' => 'application/octet-stream',
3353 'sea' => 'application/octet-stream',
3354 'so' => 'application/octet-stream',
3355 'oda' => 'application/oda',
3356 'pdf' => 'application/pdf',
3357 'ai' => 'application/postscript',
3358 'eps' => 'application/postscript',
3359 'ps' => 'application/postscript',
3360 'smi' => 'application/smil',
3361 'smil' => 'application/smil',
3362 'mif' => 'application/vnd.mif',
3363 'xls' => 'application/vnd.ms-excel',
3364 'ppt' => 'application/vnd.ms-powerpoint',
3365 'wbxml' => 'application/vnd.wap.wbxml',
3366 'wmlc' => 'application/vnd.wap.wmlc',
3367 'dcr' => 'application/x-director',
3368 'dir' => 'application/x-director',
3369 'dxr' => 'application/x-director',
3370 'dvi' => 'application/x-dvi',
3371 'gtar' => 'application/x-gtar',
3372 'php3' => 'application/x-httpd-php',
3373 'php4' => 'application/x-httpd-php',
3374 'php' => 'application/x-httpd-php',
3375 'phtml' => 'application/x-httpd-php',
3376 'phps' => 'application/x-httpd-php-source',
3377 'swf' => 'application/x-shockwave-flash',
3378 'sit' => 'application/x-stuffit',
3379 'tar' => 'application/x-tar',
3380 'tgz' => 'application/x-tar',
3381 'xht' => 'application/xhtml+xml',
3382 'xhtml' => 'application/xhtml+xml',
3383 'zip' => 'application/zip',
3384 'mid' => 'audio/midi',
3385 'midi' => 'audio/midi',
3386 'mp2' => 'audio/mpeg',
3387 'mp3' => 'audio/mpeg',
3388 'mpga' => 'audio/mpeg',
3389 'aif' => 'audio/x-aiff',
3390 'aifc' => 'audio/x-aiff',
3391 'aiff' => 'audio/x-aiff',
3392 'ram' => 'audio/x-pn-realaudio',
3393 'rm' => 'audio/x-pn-realaudio',
3394 'rpm' => 'audio/x-pn-realaudio-plugin',
3395 'ra' => 'audio/x-realaudio',
3396 'wav' => 'audio/x-wav',
3397 'bmp' => 'image/bmp',
3398 'gif' => 'image/gif',
3399 'jpeg' => 'image/jpeg',
3400 'jpe' => 'image/jpeg',
3401 'jpg' => 'image/jpeg',
3402 'png' => 'image/png',
3403 'tiff' => 'image/tiff',
3404 'tif' => 'image/tiff',
3405 'eml' => 'message/rfc822',
3406 'css' => 'text/css',
3407 'html' => 'text/html',
3408 'htm' => 'text/html',
3409 'shtml' => 'text/html',
3410 'log' => 'text/plain',
3411 'text' => 'text/plain',
3412 'txt' => 'text/plain',
3413 'rtx' => 'text/richtext',
3414 'rtf' => 'text/rtf',
3415 'vcf' => 'text/vcard',
3416 'vcard' => 'text/vcard',
3417 'xml' => 'text/xml',
3418 'xsl' => 'text/xml',
3419 'mpeg' => 'video/mpeg',
3420 'mpe' => 'video/mpeg',
3421 'mpg' => 'video/mpeg',
3422 'mov' => 'video/quicktime',
3423 'qt' => 'video/quicktime',
3424 'rv' => 'video/vnd.rn-realvideo',
3425 'avi' => 'video/x-msvideo',
3426 'movie' => 'video/x-sgi-movie'
3428 if (array_key_exists(strtolower($ext), $mimes)) {
3429 return $mimes[strtolower($ext)];
3431 return 'application/octet-stream';
3435 * Map a file name to a MIME type.
3436 * Defaults to 'application/octet-stream', i.e.. arbitrary binary data.
3437 * @param string $filename A file name or full path, does not need to exist as a file
3441 public static function filenameToType($filename)
3443 // In case the path is a URL, strip any query string before getting extension
3444 $qpos = strpos($filename, '?');
3445 if (false !== $qpos) {
3446 $filename = substr($filename, 0, $qpos);
3448 $pathinfo = self::mb_pathinfo($filename);
3449 return self::_mime_types($pathinfo['extension']);
3453 * Multi-byte-safe pathinfo replacement.
3454 * Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe.
3455 * Works similarly to the one in PHP >= 5.2.0
3456 * @link http://www.php.net/manual/en/function.pathinfo.php#107461
3457 * @param string $path A filename or path, does not need to exist as a file
3458 * @param integer|string $options Either a PATHINFO_* constant,
3459 * or a string name to return only the specified piece, allows 'filename' to work on PHP < 5.2
3460 * @return string|array
3463 public static function mb_pathinfo($path, $options = null)
3465 $ret = array('dirname' => '', 'basename' => '', 'extension' => '', 'filename' => '');
3466 $pathinfo = array();
3467 if (preg_match('%^(.*?)[\\\\/]*(([^/\\\\]*?)(\.([^\.\\\\/]+?)|))[\\\\/\.]*$%im', $path, $pathinfo)) {
3468 if (array_key_exists(1, $pathinfo)) {
3469 $ret['dirname'] = $pathinfo[1];
3471 if (array_key_exists(2, $pathinfo)) {
3472 $ret['basename'] = $pathinfo[2];
3474 if (array_key_exists(5, $pathinfo)) {
3475 $ret['extension'] = $pathinfo[5];
3477 if (array_key_exists(3, $pathinfo)) {
3478 $ret['filename'] = $pathinfo[3];
3482 case PATHINFO_DIRNAME:
3484 return $ret['dirname'];
3485 case PATHINFO_BASENAME:
3487 return $ret['basename'];
3488 case PATHINFO_EXTENSION:
3490 return $ret['extension'];
3491 case PATHINFO_FILENAME:
3493 return $ret['filename'];
3500 * Set or reset instance properties.
3501 * You should avoid this function - it's more verbose, less efficient, more error-prone and
3502 * harder to debug than setting properties directly.
3504 * `$mail->set('SMTPSecure', 'tls');`
3506 * `$mail->SMTPSecure = 'tls';`
3508 * @param string $name The property name to set
3509 * @param mixed $value The value to set the property to
3511 * @TODO Should this not be using the __set() magic function?
3513 public function set($name, $value = '')
3515 if (property_exists($this, $name)) {
3516 $this->$name = $value;
3519 $this->setError($this->lang('variable_set') . $name);
3525 * Strip newlines to prevent header injection.
3527 * @param string $str
3530 public function secureHeader($str)
3532 return trim(str_replace(array("\r", "\n"), '', $str));
3536 * Normalize line breaks in a string.
3537 * Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format.
3538 * Defaults to CRLF (for message bodies) and preserves consecutive breaks.
3539 * @param string $text
3540 * @param string $breaktype What kind of line break to use, defaults to CRLF
3545 public static function normalizeBreaks($text, $breaktype = "\r\n")
3547 return preg_replace('/(\r\n|\r|\n)/ms', $breaktype, $text);
3551 * Set the public and private key files and password for S/MIME signing.
3553 * @param string $cert_filename
3554 * @param string $key_filename
3555 * @param string $key_pass Password for private key
3556 * @param string $extracerts_filename Optional path to chain certificate
3558 public function sign($cert_filename, $key_filename, $key_pass, $extracerts_filename = '')
3560 $this->sign_cert_file = $cert_filename;
3561 $this->sign_key_file = $key_filename;
3562 $this->sign_key_pass = $key_pass;
3563 $this->sign_extracerts_file = $extracerts_filename;
3567 * Quoted-Printable-encode a DKIM header.
3569 * @param string $txt
3572 public function DKIM_QP($txt)
3575 for ($i = 0; $i < strlen($txt); $i++) {
3576 $ord = ord($txt[$i]);
3577 if (((0x21 <= $ord) && ($ord <= 0x3A)) || $ord == 0x3C || ((0x3E <= $ord) && ($ord <= 0x7E))) {
3580 $line .= '=' . sprintf('%02X', $ord);
3587 * Generate a DKIM signature.
3589 * @param string $signHeader
3590 * @throws phpmailerException
3593 public function DKIM_Sign($signHeader)
3595 if (!defined('PKCS7_TEXT')) {
3596 if ($this->exceptions) {
3597 throw new phpmailerException($this->lang('extension_missing') . 'openssl');
3601 $privKeyStr = file_get_contents($this->DKIM_private);
3602 if ($this->DKIM_passphrase != '') {
3603 $privKey = openssl_pkey_get_private($privKeyStr, $this->DKIM_passphrase);
3605 $privKey = $privKeyStr;
3607 if (openssl_sign($signHeader, $signature, $privKey)) {
3608 return base64_encode($signature);
3614 * Generate a DKIM canonicalization header.
3616 * @param string $signHeader Header
3619 public function DKIM_HeaderC($signHeader)
3621 $signHeader = preg_replace('/\r\n\s+/', ' ', $signHeader);
3622 $lines = explode("\r\n", $signHeader);
3623 foreach ($lines as $key => $line) {
3624 list($heading, $value) = explode(':', $line, 2);
3625 $heading = strtolower($heading);
3626 $value = preg_replace('/\s+/', ' ', $value); // Compress useless spaces
3627 $lines[$key] = $heading . ':' . trim($value); // Don't forget to remove WSP around the value
3629 $signHeader = implode("\r\n", $lines);
3634 * Generate a DKIM canonicalization body.
3636 * @param string $body Message Body
3639 public function DKIM_BodyC($body)
3644 // stabilize line endings
3645 $body = str_replace("\r\n", "\n", $body);
3646 $body = str_replace("\n", "\r\n", $body);
3647 // END stabilize line endings
3648 while (substr($body, strlen($body) - 4, 4) == "\r\n\r\n") {
3649 $body = substr($body, 0, strlen($body) - 2);
3655 * Create the DKIM header and body in a new message header.
3657 * @param string $headers_line Header lines
3658 * @param string $subject Subject
3659 * @param string $body Body
3662 public function DKIM_Add($headers_line, $subject, $body)
3664 $DKIMsignatureType = 'rsa-sha1'; // Signature & hash algorithms
3665 $DKIMcanonicalization = 'relaxed/simple'; // Canonicalization of header/body
3666 $DKIMquery = 'dns/txt'; // Query method
3667 $DKIMtime = time(); // Signature Timestamp = seconds since 00:00:00 - Jan 1, 1970 (UTC time zone)
3668 $subject_header = "Subject: $subject";
3669 $headers = explode($this->LE, $headers_line);
3673 foreach ($headers as $header) {
3674 if (strpos($header, 'From:') === 0) {
3675 $from_header = $header;
3676 $current = 'from_header';
3677 } elseif (strpos($header, 'To:') === 0) {
3678 $to_header = $header;
3679 $current = 'to_header';
3681 if (!empty($$current) && strpos($header, ' =?') === 0) {
3682 $$current .= $header;
3688 $from = str_replace('|', '=7C', $this->DKIM_QP($from_header));
3689 $to = str_replace('|', '=7C', $this->DKIM_QP($to_header));
3690 $subject = str_replace(
3693 $this->DKIM_QP($subject_header)
3694 ); // Copied header fields (dkim-quoted-printable)
3695 $body = $this->DKIM_BodyC($body);
3696 $DKIMlen = strlen($body); // Length of body
3697 $DKIMb64 = base64_encode(pack('H*', sha1($body))); // Base64 of packed binary SHA-1 hash of body
3698 if ('' == $this->DKIM_identity) {
3701 $ident = ' i=' . $this->DKIM_identity . ';';
3703 $dkimhdrs = 'DKIM-Signature: v=1; a=' .
3704 $DKIMsignatureType . '; q=' .
3705 $DKIMquery . '; l=' .
3707 $this->DKIM_selector .
3709 "\tt=" . $DKIMtime . '; c=' . $DKIMcanonicalization . ";\r\n" .
3710 "\th=From:To:Subject;\r\n" .
3711 "\td=" . $this->DKIM_domain . ';' . $ident . "\r\n" .
3714 "\t|$subject;\r\n" .
3715 "\tbh=" . $DKIMb64 . ";\r\n" .
3717 $toSign = $this->DKIM_HeaderC(
3718 $from_header . "\r\n" .
3719 $to_header . "\r\n" .
3720 $subject_header . "\r\n" .
3723 $signed = $this->DKIM_Sign($toSign);
3724 return $dkimhdrs . $signed . "\r\n";
3728 * Detect if a string contains a line longer than the maximum line length allowed.
3729 * @param string $str
3733 public static function hasLineLongerThanMax($str)
3735 //+2 to include CRLF line break for a 1000 total
3736 return (boolean)preg_match('/^(.{'.(self::MAX_LINE_LENGTH + 2).',})/m', $str);
3740 * Allows for public read access to 'to' property.
3741 * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
3745 public function getToAddresses()
3751 * Allows for public read access to 'cc' property.
3752 * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
3756 public function getCcAddresses()
3762 * Allows for public read access to 'bcc' property.
3763 * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
3767 public function getBccAddresses()
3773 * Allows for public read access to 'ReplyTo' property.
3774 * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
3778 public function getReplyToAddresses()
3780 return $this->ReplyTo;
3784 * Allows for public read access to 'all_recipients' property.
3785 * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
3789 public function getAllRecipientAddresses()
3791 return $this->all_recipients;
3795 * Perform a callback.
3796 * @param boolean $isSent
3800 * @param string $subject
3801 * @param string $body
3802 * @param string $from
3804 protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from)
3806 if (!empty($this->action_function) && is_callable($this->action_function)) {
3807 $params = array($isSent, $to, $cc, $bcc, $subject, $body, $from);
3808 call_user_func_array($this->action_function, $params);
3814 * PHPMailer exception handler
3815 * @package PHPMailer
3817 class phpmailerException extends Exception
3820 * Prettify error message output
3823 public function errorMessage()
3825 $errorMsg = '<strong>' . $this->getMessage() . "</strong><br />\n";