class.phpmailer.php 136 KB
Newer Older
Scott committed
1 2 3
<?php
/**
 * PHPMailer - PHP email creation and transport class.
Scott committed
4
 * PHP Version 5
Scott committed
5
 * @package PHPMailer
Scott committed
6 7
 * @link https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project
 * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
Scott committed
8 9 10
 * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
 * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
 * @author Brent R. Matzelle (original founder)
Scott committed
11
 * @copyright 2012 - 2014 Marcus Bointon
Scott committed
12 13 14 15 16 17 18 19 20 21 22
 * @copyright 2010 - 2012 Jim Jagielski
 * @copyright 2004 - 2009 Andy Prevost
 * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
 * @note This program is distributed in the hope that it will be useful - WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * PHPMailer - PHP email creation and transport class.
 * @package PHPMailer
Scott committed
23
 * @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
Scott committed
24 25 26 27 28 29 30 31
 * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
 * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
 * @author Brent R. Matzelle (original founder)
 */
class PHPMailer
{
    /**
     * The PHPMailer Version number.
Scott committed
32
     * @var string
Scott committed
33
     */
Scott committed
34
    public $Version = '5.2.14';
Scott committed
35 36 37

    /**
     * Email priority.
Scott committed
38 39
     * Options: null (default), 1 = High, 3 = Normal, 5 = low.
     * When null, the header is not set at all.
Scott committed
40
     * @var integer
Scott committed
41
     */
Scott committed
42
    public $Priority = null;
Scott committed
43 44 45

    /**
     * The character set of the message.
Scott committed
46
     * @var string
Scott committed
47 48 49 50 51
     */
    public $CharSet = 'iso-8859-1';

    /**
     * The MIME Content-type of the message.
Scott committed
52
     * @var string
Scott committed
53 54 55 56 57 58
     */
    public $ContentType = 'text/plain';

    /**
     * The message encoding.
     * Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".
Scott committed
59
     * @var string
Scott committed
60 61 62 63 64
     */
    public $Encoding = '8bit';

    /**
     * Holds the most recent mailer error message.
Scott committed
65
     * @var string
Scott committed
66 67 68 69 70
     */
    public $ErrorInfo = '';

    /**
     * The From email address for the message.
Scott committed
71
     * @var string
Scott committed
72 73 74 75 76
     */
    public $From = 'root@localhost';

    /**
     * The From name of the message.
Scott committed
77
     * @var string
Scott committed
78 79 80 81 82 83
     */
    public $FromName = 'Root User';

    /**
     * The Sender email (Return-Path) of the message.
     * If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
Scott committed
84
     * @var string
Scott committed
85 86 87 88 89 90
     */
    public $Sender = '';

    /**
     * The Return-Path of the message.
     * If empty, it will be set to either From or Sender.
Scott committed
91
     * @var string
Scott committed
92 93 94
     * @deprecated Email senders should never set a return-path header;
     * it's the receiver's job (RFC5321 section 4.4), so this no longer does anything.
     * @link https://tools.ietf.org/html/rfc5321#section-4.4 RFC5321 reference
Scott committed
95 96 97 98 99
     */
    public $ReturnPath = '';

    /**
     * The Subject of the message.
Scott committed
100
     * @var string
Scott committed
101 102 103 104 105 106
     */
    public $Subject = '';

    /**
     * An HTML or plain text message body.
     * If HTML then call isHTML(true).
Scott committed
107
     * @var string
Scott committed
108 109 110 111 112 113 114 115
     */
    public $Body = '';

    /**
     * The plain-text message body.
     * This body can be read by mail clients that do not have HTML email
     * capability such as mutt & Eudora.
     * Clients that can read HTML will view the normal Body.
Scott committed
116
     * @var string
Scott committed
117 118 119 120 121 122 123 124 125
     */
    public $AltBody = '';

    /**
     * An iCal message part body.
     * Only supported in simple alt or alt_inline message types
     * To generate iCal events, use the bundled extras/EasyPeasyICS.php class or iCalcreator
     * @link http://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/
     * @link http://kigkonsult.se/iCalcreator/
Scott committed
126
     * @var string
Scott committed
127 128 129 130 131 132
     */
    public $Ical = '';

    /**
     * The complete compiled MIME message body.
     * @access protected
Scott committed
133
     * @var string
Scott committed
134 135 136 137 138
     */
    protected $MIMEBody = '';

    /**
     * The complete compiled MIME message headers.
Scott committed
139
     * @var string
Scott committed
140 141 142 143 144 145
     * @access protected
     */
    protected $MIMEHeader = '';

    /**
     * Extra headers that createHeader() doesn't fold in.
Scott committed
146
     * @var string
Scott committed
147 148 149 150 151 152
     * @access protected
     */
    protected $mailHeader = '';

    /**
     * Word-wrap the message body to this number of chars.
Scott committed
153
     * Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance.
Scott committed
154
     * @var integer
Scott committed
155 156 157 158 159 160
     */
    public $WordWrap = 0;

    /**
     * Which method to use to send mail.
     * Options: "mail", "sendmail", or "smtp".
Scott committed
161
     * @var string
Scott committed
162 163 164 165 166
     */
    public $Mailer = 'mail';

    /**
     * The path to the sendmail program.
Scott committed
167
     * @var string
Scott committed
168 169 170 171 172 173
     */
    public $Sendmail = '/usr/sbin/sendmail';

    /**
     * Whether mail() uses a fully sendmail-compatible MTA.
     * One which supports sendmail's "-oi -f" options.
Scott committed
174
     * @var boolean
Scott committed
175 176 177 178 179 180
     */
    public $UseSendmailOptions = true;

    /**
     * Path to PHPMailer plugins.
     * Useful if the SMTP class is not in the PHP include path.
Scott committed
181
     * @var string
Scott committed
182 183 184 185 186
     * @deprecated Should not be needed now there is an autoloader.
     */
    public $PluginDir = '';

    /**
Scott committed
187 188
     * The email address that a reading confirmation should be sent to, also known as read receipt.
     * @var string
Scott committed
189 190 191 192
     */
    public $ConfirmReadingTo = '';

    /**
Scott committed
193 194 195 196 197
     * The hostname to use in the Message-ID header and as default HELO string.
     * If empty, PHPMailer attempts to find one with, in order,
     * $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value
     * 'localhost.localdomain'.
     * @var string
Scott committed
198 199 200 201
     */
    public $Hostname = '';

    /**
Scott committed
202
     * An ID to be used in the Message-ID header.
Scott committed
203
     * If empty, a unique id will be generated.
Scott committed
204
     * @var string
Scott committed
205 206 207 208 209 210
     */
    public $MessageID = '';

    /**
     * The message Date to be used in the Date header.
     * If empty, the current date will be added.
Scott committed
211
     * @var string
Scott committed
212 213 214 215 216 217 218 219 220
     */
    public $MessageDate = '';

    /**
     * SMTP hosts.
     * Either a single hostname or multiple semicolon-delimited hostnames.
     * You can also specify a different port
     * for each host by using this format: [hostname:port]
     * (e.g. "smtp1.example.com:25;smtp2.example.com").
Scott committed
221 222
     * You can also specify encryption type, for example:
     * (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465").
Scott committed
223
     * Hosts will be tried in order.
Scott committed
224
     * @var string
Scott committed
225 226 227 228 229
     */
    public $Host = 'localhost';

    /**
     * The default SMTP server port.
Scott committed
230
     * @var integer
Scott committed
231
     * @TODO Why is this needed when the SMTP class takes care of it?
Scott committed
232 233 234 235 236
     */
    public $Port = 25;

    /**
     * The SMTP HELO of the message.
Scott committed
237 238 239
     * Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find
     * one with the same method described above for $Hostname.
     * @var string
Scott committed
240 241 242 243 244
     * @see PHPMailer::$Hostname
     */
    public $Helo = '';

    /**
Scott committed
245 246
     * What kind of encryption to use on the SMTP connection.
     * Options: '', 'ssl' or 'tls'
Scott committed
247
     * @var string
Scott committed
248 249 250
     */
    public $SMTPSecure = '';

Scott committed
251 252 253 254
    /**
     * Whether to enable TLS encryption automatically if a server supports it,
     * even if `SMTPSecure` is not set to 'tls'.
     * Be aware that in PHP >= 5.6 this requires that the server's certificates are valid.
Scott committed
255
     * @var boolean
Scott committed
256 257 258
     */
    public $SMTPAutoTLS = true;

Scott committed
259 260 261
    /**
     * Whether to use SMTP authentication.
     * Uses the Username and Password properties.
Scott committed
262
     * @var boolean
Scott committed
263 264 265 266 267
     * @see PHPMailer::$Username
     * @see PHPMailer::$Password
     */
    public $SMTPAuth = false;

Scott committed
268 269
    /**
     * Options array passed to stream_context_create when connecting via SMTP.
Scott committed
270
     * @var array
Scott committed
271 272 273
     */
    public $SMTPOptions = array();

Scott committed
274 275
    /**
     * SMTP username.
Scott committed
276
     * @var string
Scott committed
277 278 279 280 281
     */
    public $Username = '';

    /**
     * SMTP password.
Scott committed
282
     * @var string
Scott committed
283 284 285 286 287 288
     */
    public $Password = '';

    /**
     * SMTP auth type.
     * Options are LOGIN (default), PLAIN, NTLM, CRAM-MD5
Scott committed
289
     * @var string
Scott committed
290 291 292 293 294 295
     */
    public $AuthType = '';

    /**
     * SMTP realm.
     * Used for NTLM auth
Scott committed
296
     * @var string
Scott committed
297 298 299 300 301 302
     */
    public $Realm = '';

    /**
     * SMTP workstation.
     * Used for NTLM auth
Scott committed
303
     * @var string
Scott committed
304 305 306 307 308
     */
    public $Workstation = '';

    /**
     * The SMTP server timeout in seconds.
Scott committed
309
     * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
Scott committed
310
     * @var integer
Scott committed
311
     */
Scott committed
312
    public $Timeout = 300;
Scott committed
313 314 315

    /**
     * SMTP class debug output mode.
Scott committed
316 317 318 319 320 321 322
     * Debug output level.
     * Options:
     * * `0` No output
     * * `1` Commands
     * * `2` Data and commands
     * * `3` As 2 plus connection status
     * * `4` Low-level data output
Scott committed
323
     * @var integer
Scott committed
324 325 326 327 328
     * @see SMTP::$do_debug
     */
    public $SMTPDebug = 0;

    /**
Scott committed
329 330 331 332 333 334 335 336 337 338
     * How to handle debug output.
     * Options:
     * * `echo` Output plain-text as-is, appropriate for CLI
     * * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output
     * * `error_log` Output to error log as configured in php.ini
     *
     * Alternatively, you can provide a callable expecting two params: a message string and the debug level:
     * <code>
     * $mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
     * </code>
Scott committed
339
     * @var string|callable
Scott committed
340 341
     * @see SMTP::$Debugoutput
     */
Scott committed
342
    public $Debugoutput = 'echo';
Scott committed
343 344 345 346 347

    /**
     * Whether to keep SMTP connection open after each message.
     * If this is set to true then to close the connection
     * requires an explicit call to smtpClose().
Scott committed
348
     * @var boolean
Scott committed
349 350 351 352 353 354
     */
    public $SMTPKeepAlive = false;

    /**
     * Whether to split multiple to addresses into multiple messages
     * or send them all in one message.
Scott committed
355
     * @var boolean
Scott committed
356 357 358 359 360
     */
    public $SingleTo = false;

    /**
     * Storage for addresses when SingleTo is enabled.
Scott committed
361
     * @var array
Scott committed
362
     * @TODO This should really not be public
Scott committed
363 364 365 366 367 368
     */
    public $SingleToArray = array();

    /**
     * Whether to generate VERP addresses on send.
     * Only applicable when sending via SMTP.
Scott committed
369
     * @link https://en.wikipedia.org/wiki/Variable_envelope_return_path
Scott committed
370
     * @link http://www.postfix.org/VERP_README.html Postfix VERP info
Scott committed
371
     * @var boolean
Scott committed
372 373 374 375 376
     */
    public $do_verp = false;

    /**
     * Whether to allow sending messages with an empty body.
Scott committed
377
     * @var boolean
Scott committed
378 379 380 381 382 383 384
     */
    public $AllowEmpty = false;

    /**
     * The default line ending.
     * @note The default remains "\n". We force CRLF where we know
     *        it must be used via self::CRLF.
Scott committed
385
     * @var string
Scott committed
386 387 388 389 390
     */
    public $LE = "\n";

    /**
     * DKIM selector.
Scott committed
391
     * @var string
Scott committed
392 393 394 395 396 397
     */
    public $DKIM_selector = '';

    /**
     * DKIM Identity.
     * Usually the email address used as the source of the email
Scott committed
398
     * @var string
Scott committed
399 400 401 402 403 404
     */
    public $DKIM_identity = '';

    /**
     * DKIM passphrase.
     * Used if your key is encrypted.
Scott committed
405
     * @var string
Scott committed
406 407 408 409 410 411
     */
    public $DKIM_passphrase = '';

    /**
     * DKIM signing domain name.
     * @example 'example.com'
Scott committed
412
     * @var string
Scott committed
413 414 415 416 417
     */
    public $DKIM_domain = '';

    /**
     * DKIM private key file path.
Scott committed
418
     * @var string
Scott committed
419 420 421 422 423 424 425 426 427 428 429 430
     */
    public $DKIM_private = '';

    /**
     * Callback Action function name.
     *
     * The function that handles the result of the send email action.
     * It is called out by send() for each email sent.
     *
     * Value can be any php callable: http://www.php.net/is_callable
     *
     * Parameters:
Scott committed
431
     *   boolean $result        result of the send action
Scott committed
432 433 434 435 436 437
     *   string  $to            email address of the recipient
     *   string  $cc            cc email addresses
     *   string  $bcc           bcc email addresses
     *   string  $subject       the subject
     *   string  $body          the email body
     *   string  $from          email address of sender
Scott committed
438
     * @var string
Scott committed
439 440 441 442
     */
    public $action_function = '';

    /**
Scott committed
443 444
     * What to put in the X-Mailer header.
     * Options: An empty string for PHPMailer default, whitespace for none, or a string to use
Scott committed
445
     * @var string
Scott committed
446 447
     */
    public $XMailer = '';
Scott committed
448

Scott committed
449 450
    /**
     * An instance of the SMTP sender class.
Scott committed
451
     * @var SMTP
Scott committed
452 453 454 455 456
     * @access protected
     */
    protected $smtp = null;

    /**
Scott committed
457 458
     * The array of 'to' names and addresses.
     * @var array
Scott committed
459 460 461 462 463
     * @access protected
     */
    protected $to = array();

    /**
Scott committed
464 465
     * The array of 'cc' names and addresses.
     * @var array
Scott committed
466 467 468 469 470
     * @access protected
     */
    protected $cc = array();

    /**
Scott committed
471 472
     * The array of 'bcc' names and addresses.
     * @var array
Scott committed
473 474 475 476 477 478
     * @access protected
     */
    protected $bcc = array();

    /**
     * The array of reply-to names and addresses.
Scott committed
479
     * @var array
Scott committed
480 481 482 483 484 485
     * @access protected
     */
    protected $ReplyTo = array();

    /**
     * An array of all kinds of addresses.
Scott committed
486
     * Includes all of $to, $cc, $bcc
Scott committed
487
     * @var array
Scott committed
488
     * @access protected
Scott committed
489
     * @see PHPMailer::$to @see PHPMailer::$cc @see PHPMailer::$bcc
Scott committed
490 491 492
     */
    protected $all_recipients = array();

Scott committed
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
    /**
     * An array of names and addresses queued for validation.
     * In send(), valid and non duplicate entries are moved to $all_recipients
     * and one of $to, $cc, or $bcc.
     * This array is used only for addresses with IDN.
     * @var array
     * @access protected
     * @see PHPMailer::$to @see PHPMailer::$cc @see PHPMailer::$bcc
     * @see PHPMailer::$all_recipients
     */
    protected $RecipientsQueue = array();

    /**
     * An array of reply-to names and addresses queued for validation.
     * In send(), valid and non duplicate entries are moved to $ReplyTo.
     * This array is used only for addresses with IDN.
     * @var array
     * @access protected
     * @see PHPMailer::$ReplyTo
     */
    protected $ReplyToQueue = array();

Scott committed
515 516
    /**
     * The array of attachments.
Scott committed
517
     * @var array
Scott committed
518 519 520 521 522 523
     * @access protected
     */
    protected $attachment = array();

    /**
     * The array of custom headers.
Scott committed
524
     * @var array
Scott committed
525 526 527 528 529 530
     * @access protected
     */
    protected $CustomHeader = array();

    /**
     * The most recent Message-ID (including angular brackets).
Scott committed
531
     * @var string
Scott committed
532 533 534 535 536 537
     * @access protected
     */
    protected $lastMessageID = '';

    /**
     * The message's MIME type.
Scott committed
538
     * @var string
Scott committed
539 540 541 542 543 544
     * @access protected
     */
    protected $message_type = '';

    /**
     * The array of MIME boundary strings.
Scott committed
545
     * @var array
Scott committed
546 547 548 549 550 551
     * @access protected
     */
    protected $boundary = array();

    /**
     * The array of available languages.
Scott committed
552
     * @var array
Scott committed
553 554 555 556 557 558
     * @access protected
     */
    protected $language = array();

    /**
     * The number of errors encountered.
Scott committed
559
     * @var integer
Scott committed
560 561 562 563 564 565
     * @access protected
     */
    protected $error_count = 0;

    /**
     * The S/MIME certificate file path.
Scott committed
566
     * @var string
Scott committed
567 568 569 570 571 572
     * @access protected
     */
    protected $sign_cert_file = '';

    /**
     * The S/MIME key file path.
Scott committed
573
     * @var string
Scott committed
574 575 576 577
     * @access protected
     */
    protected $sign_key_file = '';

Scott committed
578 579
    /**
     * The optional S/MIME extra certificates ("CA Chain") file path.
Scott committed
580
     * @var string
Scott committed
581 582 583 584
     * @access protected
     */
    protected $sign_extracerts_file = '';

Scott committed
585 586 587
    /**
     * The S/MIME password for the key.
     * Used only if the key is encrypted.
Scott committed
588
     * @var string
Scott committed
589 590 591 592 593 594
     * @access protected
     */
    protected $sign_key_pass = '';

    /**
     * Whether to throw exceptions for errors.
Scott committed
595
     * @var boolean
Scott committed
596 597 598 599 600
     * @access protected
     */
    protected $exceptions = false;

    /**
Scott committed
601
     * Unique ID used for message ID and boundaries.
Scott committed
602
     * @var string
Scott committed
603 604 605 606 607 608
     * @access protected
     */
    protected $uniqueid = '';

    /**
     * Error severity: message only, continue processing.
Scott committed
609 610 611 612
     */
    const STOP_MESSAGE = 0;

    /**
Scott committed
613
     * Error severity: message, likely ok to continue processing.
Scott committed
614 615 616 617
     */
    const STOP_CONTINUE = 1;

    /**
Scott committed
618
     * Error severity: message, plus full stop, critical error reached.
Scott committed
619 620 621 622
     */
    const STOP_CRITICAL = 2;

    /**
Scott committed
623
     * SMTP RFC standard line ending.
Scott committed
624 625 626 627
     */
    const CRLF = "\r\n";

    /**
Scott committed
628
     * The maximum line length allowed by RFC 2822 section 2.1.1
Scott committed
629
     * @var integer
Scott committed
630 631 632 633 634 635
     */
    const MAX_LINE_LENGTH = 998;

    /**
     * Constructor.
     * @param boolean $exceptions Should we throw external exceptions?
Scott committed
636 637 638
     */
    public function __construct($exceptions = false)
    {
Scott committed
639
        $this->exceptions = (boolean)$exceptions;
Scott committed
640 641 642 643 644 645 646
    }

    /**
     * Destructor.
     */
    public function __destruct()
    {
Scott committed
647 648
        //Close any open SMTP connection nicely
        if ($this->Mailer == 'smtp') {
Scott committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
            $this->smtpClose();
        }
    }

    /**
     * Call mail() in a safe_mode-aware fashion.
     * Also, unless sendmail_path points to sendmail (or something that
     * claims to be sendmail), don't pass params (not a perfect fix,
     * but it will do)
     * @param string $to To
     * @param string $subject Subject
     * @param string $body Message Body
     * @param string $header Additional Header(s)
     * @param string $params Params
     * @access private
Scott committed
664
     * @return boolean
Scott committed
665 666 667 668 669 670 671 672 673 674
     */
    private function mailPassthru($to, $subject, $body, $header, $params)
    {
        //Check overloading of mail function to avoid double-encoding
        if (ini_get('mbstring.func_overload') & 1) {
            $subject = $this->secureHeader($subject);
        } else {
            $subject = $this->encodeHeader($this->secureHeader($subject));
        }
        if (ini_get('safe_mode') || !($this->UseSendmailOptions)) {
Scott committed
675
            $result = @mail($to, $subject, $body, $header);
Scott committed
676
        } else {
Scott committed
677
            $result = @mail($to, $subject, $body, $header, $params);
Scott committed
678
        }
Scott committed
679
        return $result;
Scott committed
680 681 682 683
    }

    /**
     * Output debugging info via user-defined method.
Scott committed
684
     * Only generates output if SMTP debug output is enabled (@see SMTP::$do_debug).
Scott committed
685 686 687 688 689 690
     * @see PHPMailer::$Debugoutput
     * @see PHPMailer::$SMTPDebug
     * @param string $str
     */
    protected function edebug($str)
    {
Scott committed
691 692 693 694 695 696
        if ($this->SMTPDebug <= 0) {
            return;
        }
        //Avoid clash with built-in function names
        if (!in_array($this->Debugoutput, array('error_log', 'html', 'echo')) and is_callable($this->Debugoutput)) {
            call_user_func($this->Debugoutput, $str, $this->SMTPDebug);
Scott committed
697 698 699 700
            return;
        }
        switch ($this->Debugoutput) {
            case 'error_log':
Scott committed
701
                //Don't output, just log
Scott committed
702 703 704
                error_log($str);
                break;
            case 'html':
Scott committed
705 706 707 708 709 710 711
                //Cleans up output a bit for a better looking, HTML-safe output
                echo htmlentities(
                    preg_replace('/[\r\n]+/', '', $str),
                    ENT_QUOTES,
                    'UTF-8'
                )
                . "<br>\n";
Scott committed
712 713 714
                break;
            case 'echo':
            default:
Scott committed
715 716 717 718 719 720 721
                //Normalize line breaks
                $str = preg_replace('/(\r\n|\r|\n)/ms', "\n", $str);
                echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
                    "\n",
                    "\n                   \t                  ",
                    trim($str)
                ) . "\n";
Scott committed
722 723 724 725 726
        }
    }

    /**
     * Sets message type to HTML or plain.
Scott committed
727
     * @param boolean $isHtml True for HTML mode.
Scott committed
728 729
     * @return void
     */
Scott committed
730
    public function isHTML($isHtml = true)
Scott committed
731
    {
Scott committed
732
        if ($isHtml) {
Scott committed
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
            $this->ContentType = 'text/html';
        } else {
            $this->ContentType = 'text/plain';
        }
    }

    /**
     * Send messages using SMTP.
     * @return void
     */
    public function isSMTP()
    {
        $this->Mailer = 'smtp';
    }

    /**
     * Send messages using PHP's mail() function.
     * @return void
     */
    public function isMail()
    {
        $this->Mailer = 'mail';
    }

    /**
     * Send messages using $Sendmail.
     * @return void
     */
    public function isSendmail()
    {
Scott committed
763 764 765
        $ini_sendmail_path = ini_get('sendmail_path');

        if (!stristr($ini_sendmail_path, 'sendmail')) {
Scott committed
766
            $this->Sendmail = '/usr/sbin/sendmail';
Scott committed
767 768
        } else {
            $this->Sendmail = $ini_sendmail_path;
Scott committed
769 770 771 772 773 774 775 776 777 778
        }
        $this->Mailer = 'sendmail';
    }

    /**
     * Send messages using qmail.
     * @return void
     */
    public function isQmail()
    {
Scott committed
779 780 781
        $ini_sendmail_path = ini_get('sendmail_path');

        if (!stristr($ini_sendmail_path, 'qmail')) {
Scott committed
782
            $this->Sendmail = '/var/qmail/bin/qmail-inject';
Scott committed
783 784
        } else {
            $this->Sendmail = $ini_sendmail_path;
Scott committed
785 786 787 788 789 790
        }
        $this->Mailer = 'qmail';
    }

    /**
     * Add a "To" address.
Scott committed
791
     * @param string $address The email address to send to
Scott committed
792
     * @param string $name
Scott committed
793
     * @return boolean true on success, false if address already used or invalid in some way
Scott committed
794 795 796
     */
    public function addAddress($address, $name = '')
    {
Scott committed
797
        return $this->addOrEnqueueAnAddress('to', $address, $name);
Scott committed
798 799 800 801 802
    }

    /**
     * Add a "CC" address.
     * @note: This function works with the SMTP mailer on win32, not with the "mail" mailer.
Scott committed
803
     * @param string $address The email address to send to
Scott committed
804
     * @param string $name
Scott committed
805
     * @return boolean true on success, false if address already used or invalid in some way
Scott committed
806 807 808
     */
    public function addCC($address, $name = '')
    {
Scott committed
809
        return $this->addOrEnqueueAnAddress('cc', $address, $name);
Scott committed
810 811 812 813 814
    }

    /**
     * Add a "BCC" address.
     * @note: This function works with the SMTP mailer on win32, not with the "mail" mailer.
Scott committed
815
     * @param string $address The email address to send to
Scott committed
816
     * @param string $name
Scott committed
817
     * @return boolean true on success, false if address already used or invalid in some way
Scott committed
818 819 820
     */
    public function addBCC($address, $name = '')
    {
Scott committed
821
        return $this->addOrEnqueueAnAddress('bcc', $address, $name);
Scott committed
822 823 824
    }

    /**
Scott committed
825 826
     * Add a "Reply-To" address.
     * @param string $address The email address to reply to
Scott committed
827
     * @param string $name
Scott committed
828
     * @return boolean true on success, false if address already used or invalid in some way
Scott committed
829 830 831
     */
    public function addReplyTo($address, $name = '')
    {
Scott committed
832
        return $this->addOrEnqueueAnAddress('Reply-To', $address, $name);
Scott committed
833 834 835
    }

    /**
Scott committed
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
     * Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer
     * can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still
     * be modified after calling this function), addition of such addresses is delayed until send().
     * Addresses that have been added already return false, but do not throw exceptions.
     * @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo'
     * @param string $address The email address to send, resp. to reply to
     * @param string $name
     * @throws phpmailerException
     * @return boolean true on success, false if address already used or invalid in some way
     * @access protected
     */
    protected function addOrEnqueueAnAddress($kind, $address, $name)
    {
        $address = trim($address);
        $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
        if (($pos = strrpos($address, '@')) === false) {
            // At-sign is misssing.
            $error_message = $this->lang('invalid_address') . $address;
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new phpmailerException($error_message);
            }
            return false;
        }
        $params = array($kind, $address, $name);
        // Enqueue addresses with IDN until we know the PHPMailer::$CharSet.
        if ($this->has8bitChars(substr($address, ++$pos)) and $this->idnSupported()) {
            if ($kind != 'Reply-To') {
                if (!array_key_exists($address, $this->RecipientsQueue)) {
                    $this->RecipientsQueue[$address] = $params;
                    return true;
                }
            } else {
                if (!array_key_exists($address, $this->ReplyToQueue)) {
                    $this->ReplyToQueue[$address] = $params;
                    return true;
                }
            }
            return false;
        }
        // Immediately add standard addresses without IDN.
        return call_user_func_array(array($this, 'addAnAddress'), $params);
    }

    /**
     * Add an address to one of the recipient arrays or to the ReplyTo array.
     * Addresses that have been added already return false, but do not throw exceptions.
     * @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo'
     * @param string $address The email address to send, resp. to reply to
Scott committed
886 887
     * @param string $name
     * @throws phpmailerException
Scott committed
888
     * @return boolean true on success, false if address already used or invalid in some way
Scott committed
889 890 891 892
     * @access protected
     */
    protected function addAnAddress($kind, $address, $name = '')
    {
Scott committed
893 894 895 896
        if (!in_array($kind, array('to', 'cc', 'bcc', 'Reply-To'))) {
            $error_message = $this->lang('Invalid recipient kind: ') . $kind;
            $this->setError($error_message);
            $this->edebug($error_message);
Scott committed
897
            if ($this->exceptions) {
Scott committed
898
                throw new phpmailerException($error_message);
Scott committed
899 900 901 902
            }
            return false;
        }
        if (!$this->validateAddress($address)) {
Scott committed
903 904 905
            $error_message = $this->lang('invalid_address') . $address;
            $this->setError($error_message);
            $this->edebug($error_message);
Scott committed
906
            if ($this->exceptions) {
Scott committed
907
                throw new phpmailerException($error_message);
Scott committed
908 909 910 911
            }
            return false;
        }
        if ($kind != 'Reply-To') {
Scott committed
912
            if (!array_key_exists(strtolower($address), $this->all_recipients)) {
Scott committed
913 914 915 916 917 918 919 920 921 922 923 924 925
                array_push($this->$kind, array($address, $name));
                $this->all_recipients[strtolower($address)] = true;
                return true;
            }
        } else {
            if (!array_key_exists(strtolower($address), $this->ReplyTo)) {
                $this->ReplyTo[strtolower($address)] = array($address, $name);
                return true;
            }
        }
        return false;
    }

Scott committed
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
    /**
     * Parse and validate a string containing one or more RFC822-style comma-separated email addresses
     * of the form "display name <address>" into an array of name/address pairs.
     * Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available.
     * Note that quotes in the name part are removed.
     * @param string $addrstr The address list string
     * @param bool $useimap Whether to use the IMAP extension to parse the list
     * @return array
     * @link http://www.andrew.cmu.edu/user/agreen1/testing/mrbs/web/Mail/RFC822.php A more careful implementation
     */
    public function parseAddresses($addrstr, $useimap = true)
    {
        $addresses = array();
        if ($useimap and function_exists('imap_rfc822_parse_adrlist')) {
            //Use this built-in parser if it's available
            $list = imap_rfc822_parse_adrlist($addrstr, '');
            foreach ($list as $address) {
                if ($address->host != '.SYNTAX-ERROR.') {
                    if ($this->validateAddress($address->mailbox . '@' . $address->host)) {
                        $addresses[] = array(
                            'name' => (property_exists($address, 'personal') ? $address->personal : ''),
                            'address' => $address->mailbox . '@' . $address->host
                        );
                    }
                }
            }
        } else {
            //Use this simpler parser
            $list = explode(',', $addrstr);
            foreach ($list as $address) {
                $address = trim($address);
                //Is there a separate name part?
                if (strpos($address, '<') === false) {
                    //No separate name, just use the whole thing
                    if ($this->validateAddress($address)) {
                        $addresses[] = array(
                            'name' => '',
                            'address' => $address
                        );
                    }
                } else {
                    list($name, $email) = explode('<', $address);
                    $email = trim(str_replace('>', '', $email));
                    if ($this->validateAddress($email)) {
                        $addresses[] = array(
                            'name' => trim(str_replace(array('"', "'"), '', $name)),
                            'address' => $email
                        );
                    }
                }
            }
        }
        return $addresses;
    }

Scott committed
981 982 983 984
    /**
     * Set the From and FromName properties.
     * @param string $address
     * @param string $name
Scott committed
985
     * @param boolean $auto Whether to also set the Sender address, defaults to true
Scott committed
986
     * @throws phpmailerException
Scott committed
987
     * @return boolean
Scott committed
988 989 990 991 992
     */
    public function setFrom($address, $name = '', $auto = true)
    {
        $address = trim($address);
        $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
Scott committed
993 994 995 996 997 998 999
        // Don't validate now addresses with IDN. Will be done in send().
        if (($pos = strrpos($address, '@')) === false or
            (!$this->has8bitChars(substr($address, ++$pos)) or !$this->idnSupported()) and
            !$this->validateAddress($address)) {
            $error_message = $this->lang('invalid_address') . $address;
            $this->setError($error_message);
            $this->edebug($error_message);
Scott committed
1000
            if ($this->exceptions) {
Scott committed
1001
                throw new phpmailerException($error_message);
Scott committed
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
            }
            return false;
        }
        $this->From = $address;
        $this->FromName = $name;
        if ($auto) {
            if (empty($this->Sender)) {
                $this->Sender = $address;
            }
        }
        return true;
    }

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

    /**
     * Check that a string looks like an email address.
     * @param string $address The email address to check
     * @param string $patternselect A selector for the validation pattern to use :
Scott committed
1031
     * * `auto` Pick best pattern automatically;
Scott committed
1032 1033
     * * `pcre8` Use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14;
     * * `pcre` Use old PCRE implementation;
Scott committed
1034
     * * `php` Use PHP built-in FILTER_VALIDATE_EMAIL;
Scott committed
1035 1036 1037
     * * `html5` Use the pattern given by the HTML5 spec for 'email' type form input elements.
     * * `noregex` Don't use a regex: super fast, really dumb.
     * @return boolean
Scott committed
1038 1039 1040 1041 1042
     * @static
     * @access public
     */
    public static function validateAddress($address, $patternselect = 'auto')
    {
Scott committed
1043 1044 1045 1046
        //Reject line breaks in addresses; it's valid RFC5322, but not RFC5321
        if (strpos($address, "\n") !== false or strpos($address, "\r") !== false) {
            return false;
        }
Scott committed
1047 1048 1049 1050 1051 1052
        if (!$patternselect or $patternselect == 'auto') {
            //Check this constant first so it works when extension_loaded() is disabled by safe mode
            //Constant was added in PHP 5.2.4
            if (defined('PCRE_VERSION')) {
                //This pattern can get stuck in a recursive loop in PCRE <= 8.0.2
                if (version_compare(PCRE_VERSION, '8.0.3') >= 0) {
Scott committed
1053 1054 1055 1056
                    $patternselect = 'pcre8';
                } else {
                    $patternselect = 'pcre';
                }
Scott committed
1057 1058 1059
            } elseif (function_exists('extension_loaded') and extension_loaded('pcre')) {
                //Fall back to older PCRE
                $patternselect = 'pcre';
Scott committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
            } else {
                //Filter_var appeared in PHP 5.2.0 and does not require the PCRE extension
                if (version_compare(PHP_VERSION, '5.2.0') >= 0) {
                    $patternselect = 'php';
                } else {
                    $patternselect = 'noregex';
                }
            }
        }
        switch ($patternselect) {
            case 'pcre8':
                /**
Scott committed
1072
                 * Uses the same RFC5322 regex on which FILTER_VALIDATE_EMAIL is based, but allows dotless domains.
Scott committed
1073 1074 1075 1076
                 * @link http://squiloople.com/2009/12/20/email-address-validation/
                 * @copyright 2009-2010 Michael Rushton
                 * Feel free to use and redistribute this code. But please keep this copyright notice.
                 */
Scott committed
1077
                return (boolean)preg_match(
Scott committed
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
                    '/^(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){255,})(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){65,}@)' .
                    '((?>(?>(?>((?>(?>(?>\x0D\x0A)?[\t ])+|(?>[\t ]*\x0D\x0A)?[\t ]+)?)(\((?>(?2)' .
                    '(?>[\x01-\x08\x0B\x0C\x0E-\'*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\)))+(?2))|(?2))?)' .
                    '([!#-\'*+\/-9=?^-~-]+|"(?>(?2)(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\x7F]))*' .
                    '(?2)")(?>(?1)\.(?1)(?4))*(?1)@(?!(?1)[a-z0-9-]{64,})(?1)(?>([a-z0-9](?>[a-z0-9-]*[a-z0-9])?)' .
                    '(?>(?1)\.(?!(?1)[a-z0-9-]{64,})(?1)(?5)){0,126}|\[(?:(?>IPv6:(?>([a-f0-9]{1,4})(?>:(?6)){7}' .
                    '|(?!(?:.*[a-f0-9][:\]]){8,})((?6)(?>:(?6)){0,6})?::(?7)?))|(?>(?>IPv6:(?>(?6)(?>:(?6)){5}:' .
                    '|(?!(?:.*[a-f0-9]:){6,})(?8)?::(?>((?6)(?>:(?6)){0,4}):)?))?(25[0-5]|2[0-4][0-9]|1[0-9]{2}' .
                    '|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD',
                    $address
                );
            case 'pcre':
                //An older regex that doesn't need a recent PCRE
Scott committed
1091
                return (boolean)preg_match(
Scott committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
                    '/^(?!(?>"?(?>\\\[ -~]|[^"])"?){255,})(?!(?>"?(?>\\\[ -~]|[^"])"?){65,}@)(?>' .
                    '[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*")' .
                    '(?>\.(?>[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*"))*' .
                    '@(?>(?![a-z0-9-]{64,})(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)(?>\.(?![a-z0-9-]{64,})' .
                    '(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)){0,126}|\[(?:(?>IPv6:(?>(?>[a-f0-9]{1,4})(?>:' .
                    '[a-f0-9]{1,4}){7}|(?!(?:.*[a-f0-9][:\]]){8,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?' .
                    '::(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?))|(?>(?>IPv6:(?>[a-f0-9]{1,4}(?>:' .
                    '[a-f0-9]{1,4}){5}:|(?!(?:.*[a-f0-9]:){6,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4})?' .
                    '::(?>(?:[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4}):)?))?(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}' .
                    '|[1-9]?[0-9])(?>\.(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}))\])$/isD',
                    $address
                );
Scott committed
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
            case 'html5':
                /**
                 * This is the pattern used in the HTML5 spec for validation of 'email' type form input elements.
                 * @link http://www.whatwg.org/specs/web-apps/current-work/#e-mail-state-(type=email)
                 */
                return (boolean)preg_match(
                    '/^[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}' .
                    '[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/sD',
                    $address
                );
Scott committed
1114 1115 1116 1117 1118 1119
            case 'noregex':
                //No PCRE! Do something _very_ approximate!
                //Check the address is 3 chars or longer and contains an @ that's not the first or last char
                return (strlen($address) >= 3
                    and strpos($address, '@') >= 1
                    and strpos($address, '@') != strlen($address) - 1);
Scott committed
1120 1121 1122
            case 'php':
            default:
                return (boolean)filter_var($address, FILTER_VALIDATE_EMAIL);
Scott committed
1123 1124 1125
        }
    }

Scott committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
    /**
     * Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the
     * "intl" and "mbstring" PHP extensions.
     * @return bool "true" if required functions for IDN support are present
     */
    public function idnSupported()
    {
        // @TODO: Write our own "idn_to_ascii" function for PHP <= 5.2.
        return function_exists('idn_to_ascii') and function_exists('mb_convert_encoding');
    }

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

Scott committed
1168 1169 1170 1171
    /**
     * Create a message and send it.
     * Uses the sending method specified by $Mailer.
     * @throws phpmailerException
Scott committed
1172
     * @return boolean false on error - See the ErrorInfo property for details of the error.
Scott committed
1173 1174 1175 1176 1177 1178 1179 1180
     */
    public function send()
    {
        try {
            if (!$this->preSend()) {
                return false;
            }
            return $this->postSend();
Scott committed
1181
        } catch (phpmailerException $exc) {
Scott committed
1182
            $this->mailHeader = '';
Scott committed
1183
            $this->setError($exc->getMessage());
Scott committed
1184
            if ($this->exceptions) {
Scott committed
1185
                throw $exc;
Scott committed
1186 1187 1188 1189 1190 1191 1192 1193
            }
            return false;
        }
    }

    /**
     * Prepare a message for sending.
     * @throws phpmailerException
Scott committed
1194
     * @return boolean
Scott committed
1195 1196 1197 1198
     */
    public function preSend()
    {
        try {
Scott committed
1199
            $this->error_count = 0; // Reset errors
Scott committed
1200
            $this->mailHeader = '';
Scott committed
1201 1202 1203 1204 1205 1206

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

Scott committed
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
            // Validate From, Sender, and ConfirmReadingTo addresses
            foreach (array('From', 'Sender', 'ConfirmReadingTo') as $address_kind) {
                $this->$address_kind = trim($this->$address_kind);
                if (empty($this->$address_kind)) {
                    continue;
                }
                $this->$address_kind = $this->punyencodeAddress($this->$address_kind);
                if (!$this->validateAddress($this->$address_kind)) {
                    $error_message = $this->lang('invalid_address') . $this->$address_kind;
                    $this->setError($error_message);
                    $this->edebug($error_message);
                    if ($this->exceptions) {
                        throw new phpmailerException($error_message);
                    }
                    return false;
                }
            }

Scott committed
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
            // Set whether the message is multipart/alternative
            if (!empty($this->AltBody)) {
                $this->ContentType = 'multipart/alternative';
            }

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

Scott committed
1240 1241
            // Create body before headers in case body makes changes to headers (e.g. altering transfer encoding)
            $this->MIMEHeader = '';
Scott committed
1242
            $this->MIMEBody = $this->createBody();
Scott committed
1243 1244 1245 1246
            // createBody may have added some headers, so retain them
            $tempheaders = $this->MIMEHeader;
            $this->MIMEHeader = $this->createHeader();
            $this->MIMEHeader .= $tempheaders;
Scott committed
1247 1248 1249 1250 1251

            // To capture the complete message when using mail(), create
            // an extra header list which createHeader() doesn't fold in
            if ($this->Mailer == 'mail') {
                if (count($this->to) > 0) {
Scott committed
1252
                    $this->mailHeader .= $this->addrAppend('To', $this->to);
Scott committed
1253
                } else {
Scott committed
1254
                    $this->mailHeader .= $this->headerLine('To', 'undisclosed-recipients:;');
Scott committed
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
                }
                $this->mailHeader .= $this->headerLine(
                    'Subject',
                    $this->encodeHeader($this->secureHeader(trim($this->Subject)))
                );
            }

            // Sign with DKIM if enabled
            if (!empty($this->DKIM_domain)
                && !empty($this->DKIM_private)
                && !empty($this->DKIM_selector)
                && file_exists($this->DKIM_private)) {
                $header_dkim = $this->DKIM_Add(
                    $this->MIMEHeader . $this->mailHeader,
                    $this->encodeHeader($this->secureHeader($this->Subject)),
                    $this->MIMEBody
                );
                $this->MIMEHeader = rtrim($this->MIMEHeader, "\r\n ") . self::CRLF .
                    str_replace("\r\n", "\n", $header_dkim) . self::CRLF;
            }
            return true;
Scott committed
1276 1277
        } catch (phpmailerException $exc) {
            $this->setError($exc->getMessage());
Scott committed
1278
            if ($this->exceptions) {
Scott committed
1279
                throw $exc;
Scott committed
1280 1281 1282 1283 1284 1285 1286 1287 1288
            }
            return false;
        }
    }

    /**
     * Actually send a message.
     * Send the email via the selected mechanism
     * @throws phpmailerException
Scott committed
1289
     * @return boolean
Scott committed
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
     */
    public function postSend()
    {
        try {
            // Choose the mailer and send through it
            switch ($this->Mailer) {
                case 'sendmail':
                case 'qmail':
                    return $this->sendmailSend($this->MIMEHeader, $this->MIMEBody);
                case 'smtp':
                    return $this->smtpSend($this->MIMEHeader, $this->MIMEBody);
                case 'mail':
                    return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
                default:
Scott committed
1304 1305
                    $sendMethod = $this->Mailer.'Send';
                    if (method_exists($this, $sendMethod)) {
Scott committed
1306 1307
                        return $this->$sendMethod($this->MIMEHeader, $this->MIMEBody);
                    }
Scott committed
1308 1309

                    return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
Scott committed
1310
            }
Scott committed
1311 1312 1313
        } catch (phpmailerException $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
Scott committed
1314
            if ($this->exceptions) {
Scott committed
1315
                throw $exc;
Scott committed
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
            }
        }
        return false;
    }

    /**
     * Send mail using the $Sendmail program.
     * @param string $header The message headers
     * @param string $body The message body
     * @see PHPMailer::$Sendmail
     * @throws phpmailerException
     * @access protected
Scott committed
1328
     * @return boolean
Scott committed
1329 1330 1331 1332 1333
     */
    protected function sendmailSend($header, $body)
    {
        if ($this->Sender != '') {
            if ($this->Mailer == 'qmail') {
Scott committed
1334
                $sendmail = sprintf('%s -f%s', escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
Scott committed
1335
            } else {
Scott committed
1336
                $sendmail = sprintf('%s -oi -f%s -t', escapeshellcmd($this->Sendmail), escapeshellarg($this->Sender));
Scott committed
1337 1338 1339
            }
        } else {
            if ($this->Mailer == 'qmail') {
Scott committed
1340
                $sendmail = sprintf('%s', escapeshellcmd($this->Sendmail));
Scott committed
1341
            } else {
Scott committed
1342
                $sendmail = sprintf('%s -oi -t', escapeshellcmd($this->Sendmail));
Scott committed
1343 1344
            }
        }
Scott committed
1345 1346
        if ($this->SingleTo) {
            foreach ($this->SingleToArray as $toAddr) {
Scott committed
1347 1348 1349
                if (!@$mail = popen($sendmail, 'w')) {
                    throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
                }
Scott committed
1350
                fputs($mail, 'To: ' . $toAddr . "\n");
Scott committed
1351 1352 1353
                fputs($mail, $header);
                fputs($mail, $body);
                $result = pclose($mail);
Scott committed
1354 1355 1356 1357 1358 1359 1360 1361 1362
                $this->doCallback(
                    ($result == 0),
                    array($toAddr),
                    $this->cc,
                    $this->bcc,
                    $this->Subject,
                    $body,
                    $this->From
                );
Scott committed
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
                if ($result != 0) {
                    throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
                }
            }
        } else {
            if (!@$mail = popen($sendmail, 'w')) {
                throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
            }
            fputs($mail, $header);
            fputs($mail, $body);
            $result = pclose($mail);
Scott committed
1374 1375 1376 1377 1378 1379 1380 1381 1382
            $this->doCallback(
                ($result == 0),
                $this->to,
                $this->cc,
                $this->bcc,
                $this->Subject,
                $body,
                $this->From
            );
Scott committed
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
            if ($result != 0) {
                throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
            }
        }
        return true;
    }

    /**
     * Send mail using the PHP mail() function.
     * @param string $header The message headers
     * @param string $body The message body
     * @link http://www.php.net/manual/en/book.mail.php
     * @throws phpmailerException
     * @access protected
Scott committed
1397
     * @return boolean
Scott committed
1398 1399 1400 1401
     */
    protected function mailSend($header, $body)
    {
        $toArr = array();
Scott committed
1402 1403
        foreach ($this->to as $toaddr) {
            $toArr[] = $this->addrFormat($toaddr);
Scott committed
1404 1405 1406 1407
        }
        $to = implode(', ', $toArr);

        if (empty($this->Sender)) {
Scott committed
1408
            $params = ' ';
Scott committed
1409
        } else {
Scott committed
1410
            $params = sprintf('-f%s', $this->Sender);
Scott committed
1411 1412 1413 1414 1415
        }
        if ($this->Sender != '' and !ini_get('safe_mode')) {
            $old_from = ini_get('sendmail_from');
            ini_set('sendmail_from', $this->Sender);
        }
Scott committed
1416 1417 1418 1419 1420
        $result = false;
        if ($this->SingleTo && count($toArr) > 1) {
            foreach ($toArr as $toAddr) {
                $result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params);
                $this->doCallback($result, array($toAddr), $this->cc, $this->bcc, $this->Subject, $body, $this->From);
Scott committed
1421 1422
            }
        } else {
Scott committed
1423 1424
            $result = $this->mailPassthru($to, $this->Subject, $body, $header, $params);
            $this->doCallback($result, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
Scott committed
1425 1426 1427 1428
        }
        if (isset($old_from)) {
            ini_set('sendmail_from', $old_from);
        }
Scott committed
1429
        if (!$result) {
Scott committed
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
            throw new phpmailerException($this->lang('instantiate'), self::STOP_CRITICAL);
        }
        return true;
    }

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

    /**
     * Send mail via SMTP.
     * Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
     * Uses the PHPMailerSMTP class by default.
     * @see PHPMailer::getSMTPInstance() to use a different class.
     * @param string $header The message headers
     * @param string $body The message body
     * @throws phpmailerException
     * @uses SMTP
     * @access protected
Scott committed
1458
     * @return boolean
Scott committed
1459 1460 1461 1462
     */
    protected function smtpSend($header, $body)
    {
        $bad_rcpt = array();
Scott committed
1463
        if (!$this->smtpConnect($this->SMTPOptions)) {
Scott committed
1464 1465
            throw new phpmailerException($this->lang('smtp_connect_failed'), self::STOP_CRITICAL);
        }
Scott committed
1466 1467 1468 1469 1470
        if ('' == $this->Sender) {
            $smtp_from = $this->From;
        } else {
            $smtp_from = $this->Sender;
        }
Scott committed
1471 1472 1473 1474 1475 1476
        if (!$this->smtp->mail($smtp_from)) {
            $this->setError($this->lang('from_failed') . $smtp_from . ' : ' . implode(',', $this->smtp->getError()));
            throw new phpmailerException($this->ErrorInfo, self::STOP_CRITICAL);
        }

        // Attempt to send to all recipients
Scott committed
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
        foreach (array($this->to, $this->cc, $this->bcc) as $togroup) {
            foreach ($togroup as $to) {
                if (!$this->smtp->recipient($to[0])) {
                    $error = $this->smtp->getError();
                    $bad_rcpt[] = array('to' => $to[0], 'error' => $error['detail']);
                    $isSent = false;
                } else {
                    $isSent = true;
                }
                $this->doCallback($isSent, array($to[0]), array(), array(), $this->Subject, $body, $this->From);
Scott committed
1487 1488 1489
            }
        }

Scott committed
1490
        // Only send the DATA command if we have viable recipients
Scott committed
1491 1492 1493
        if ((count($this->all_recipients) > count($bad_rcpt)) and !$this->smtp->data($header . $body)) {
            throw new phpmailerException($this->lang('data_not_accepted'), self::STOP_CRITICAL);
        }
Scott committed
1494
        if ($this->SMTPKeepAlive) {
Scott committed
1495 1496 1497 1498 1499
            $this->smtp->reset();
        } else {
            $this->smtp->quit();
            $this->smtp->close();
        }
Scott committed
1500 1501 1502 1503 1504 1505
        //Create error message for any bad addresses
        if (count($bad_rcpt) > 0) {
            $errstr = '';
            foreach ($bad_rcpt as $bad) {
                $errstr .= $bad['to'] . ': ' . $bad['error'];
            }
Scott committed
1506
            throw new phpmailerException(
Scott committed
1507
                $this->lang('recipients_failed') . $errstr,
Scott committed
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
                self::STOP_CONTINUE
            );
        }
        return true;
    }

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

Scott committed
1529
        // Already connected?
Scott committed
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
        if ($this->smtp->connected()) {
            return true;
        }

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

        foreach ($hosts as $hostentry) {
            $hostinfo = array();
            if (!preg_match('/^((ssl|tls):\/\/)*([a-zA-Z0-9\.-]*):?([0-9]*)$/', trim($hostentry), $hostinfo)) {
Scott committed
1544
                // Not a valid host entry
Scott committed
1545 1546
                continue;
            }
Scott committed
1547 1548 1549 1550 1551
            // $hostinfo[2]: optional ssl or tls prefix
            // $hostinfo[3]: the hostname
            // $hostinfo[4]: optional port number
            // The host string prefix can temporarily override the current setting for SMTPSecure
            // If it's not specified, the default value is used
Scott committed
1552
            $prefix = '';
Scott committed
1553
            $secure = $this->SMTPSecure;
Scott committed
1554
            $tls = ($this->SMTPSecure == 'tls');
Scott committed
1555
            if ('ssl' == $hostinfo[2] or ('' == $hostinfo[2] and 'ssl' == $this->SMTPSecure)) {
Scott committed
1556
                $prefix = 'ssl://';
Scott committed
1557 1558
                $tls = false; // Can't have SSL and TLS at the same time
                $secure = 'ssl';
Scott committed
1559 1560
            } elseif ($hostinfo[2] == 'tls') {
                $tls = true;
Scott committed
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
                // tls doesn't use a prefix
                $secure = 'tls';
            }
            //Do we need the OpenSSL extension?
            $sslext = defined('OPENSSL_ALGO_SHA1');
            if ('tls' === $secure or 'ssl' === $secure) {
                //Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled
                if (!$sslext) {
                    throw new phpmailerException($this->lang('extension_missing').'openssl', self::STOP_CRITICAL);
                }
Scott committed
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
            }
            $host = $hostinfo[3];
            $port = $this->Port;
            $tport = (integer)$hostinfo[4];
            if ($tport > 0 and $tport < 65536) {
                $port = $tport;
            }
            if ($this->smtp->connect($prefix . $host, $port, $this->Timeout, $options)) {
                try {
                    if ($this->Helo) {
                        $hello = $this->Helo;
                    } else {
                        $hello = $this->serverHostname();
                    }
                    $this->smtp->hello($hello);
Scott committed
1586 1587 1588 1589 1590 1591 1592 1593
                    //Automatically enable TLS encryption if:
                    // * it's not disabled
                    // * we have openssl extension
                    // * we are not already using SSL
                    // * the server offers STARTTLS
                    if ($this->SMTPAutoTLS and $sslext and $secure != 'ssl' and $this->smtp->getServerExt('STARTTLS')) {
                        $tls = true;
                    }
Scott committed
1594 1595 1596 1597
                    if ($tls) {
                        if (!$this->smtp->startTLS()) {
                            throw new phpmailerException($this->lang('connect_host'));
                        }
Scott committed
1598
                        // We must resend HELO after tls negotiation
Scott committed
1599 1600 1601 1602
                        $this->smtp->hello($hello);
                    }
                    if ($this->SMTPAuth) {
                        if (!$this->smtp->authenticate(
Scott committed
1603 1604 1605 1606
                            $this->Username,
                            $this->Password,
                            $this->AuthType,
                            $this->Realm,
Scott committed
1607 1608 1609 1610 1611 1612 1613
                            $this->Workstation
                        )
                        ) {
                            throw new phpmailerException($this->lang('authenticate'));
                        }
                    }
                    return true;
Scott committed
1614 1615 1616 1617
                } catch (phpmailerException $exc) {
                    $lastexception = $exc;
                    $this->edebug($exc->getMessage());
                    // We must have connected, but then failed TLS or Auth, so close connection nicely
Scott committed
1618 1619 1620 1621
                    $this->smtp->quit();
                }
            }
        }
Scott committed
1622
        // If we get here, all connection attempts have failed, so close connection hard
Scott committed
1623
        $this->smtp->close();
Scott committed
1624
        // As we've caught all exceptions, just report whatever the last one was
Scott committed
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
        if ($this->exceptions and !is_null($lastexception)) {
            throw $lastexception;
        }
        return false;
    }

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

    /**
     * Set the language for error messages.
     * Returns false if it cannot load the language file.
     * The default language is English.
     * @param string $langcode ISO 639-1 2-character language code (e.g. French is "fr")
     * @param string $lang_path Path to the language file directory, with trailing separator (slash)
Scott committed
1651
     * @return boolean
Scott committed
1652 1653
     * @access public
     */
Scott committed
1654
    public function setLanguage($langcode = 'en', $lang_path = '')
Scott committed
1655
    {
Scott committed
1656
        // Define full set of translatable strings in English
Scott committed
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
        $PHPMAILER_LANG = array(
            'authenticate' => 'SMTP Error: Could not authenticate.',
            'connect_host' => 'SMTP Error: Could not connect to SMTP host.',
            'data_not_accepted' => 'SMTP Error: data not accepted.',
            'empty_message' => 'Message body empty',
            'encoding' => 'Unknown encoding: ',
            'execute' => 'Could not execute: ',
            'file_access' => 'Could not access file: ',
            'file_open' => 'File Error: Could not open file: ',
            'from_failed' => 'The following From address failed: ',
            'instantiate' => 'Could not instantiate mail function.',
Scott committed
1668
            'invalid_address' => 'Invalid address: ',
Scott committed
1669 1670 1671 1672 1673 1674
            'mailer_not_supported' => ' mailer is not supported.',
            'provide_address' => 'You must provide at least one recipient email address.',
            'recipients_failed' => 'SMTP Error: The following recipients failed: ',
            'signing' => 'Signing Error: ',
            'smtp_connect_failed' => 'SMTP connect() failed.',
            'smtp_error' => 'SMTP server error: ',
Scott committed
1675 1676
            'variable_set' => 'Cannot set or reset variable: ',
            'extension_missing' => 'Extension missing: '
Scott committed
1677
        );
Scott committed
1678 1679 1680 1681 1682
        if (empty($lang_path)) {
            // Calculate an absolute path so it can work if CWD is not here
            $lang_path = dirname(__FILE__). DIRECTORY_SEPARATOR . 'language'. DIRECTORY_SEPARATOR;
        }
        $foundlang = true;
Scott committed
1683
        $lang_file = $lang_path . 'phpmailer.lang-' . $langcode . '.php';
Scott committed
1684 1685 1686
        // There is no English translation file
        if ($langcode != 'en') {
            // Make sure language file path is readable
Scott committed
1687
            if (!is_readable($lang_file)) {
Scott committed
1688
                $foundlang = false;
Scott committed
1689
            } else {
Scott committed
1690 1691 1692
                // Overwrite language-specific strings.
                // This way we'll never have missing translation keys.
                $foundlang = include $lang_file;
Scott committed
1693 1694 1695
            }
        }
        $this->language = $PHPMAILER_LANG;
Scott committed
1696
        return (boolean)$foundlang; // Returns false if language not found
Scott committed
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
    }

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

    /**
     * Create recipient headers.
     * @access public
     * @param string $type
     * @param array $addr An array of recipient,
     * where each recipient is a 2-element indexed array with element 0 containing an address
     * and element 1 containing a name, like:
     * array(array('joe@example.com', 'Joe User'), array('zoe@example.com', 'Zoe User'))
     * @return string
     */
    public function addrAppend($type, $addr)
    {
        $addresses = array();
Scott committed
1721 1722
        foreach ($addr as $address) {
            $addresses[] = $this->addrFormat($address);
Scott committed
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
        }
        return $type . ': ' . implode(', ', $addresses) . $this->LE;
    }

    /**
     * Format an address for use in a message header.
     * @access public
     * @param array $addr A 2-element indexed array, element 0 containing an address, element 1 containing a name
     *      like array('joe@example.com', 'Joe User')
     * @return string
     */
    public function addrFormat($addr)
    {
        if (empty($addr[1])) { // No name provided
            return $this->secureHeader($addr[0]);
        } else {
Scott committed
1739
            return $this->encodeHeader($this->secureHeader($addr[1]), 'phrase') . ' <' . $this->secureHeader(
Scott committed
1740
                $addr[0]
Scott committed
1741
            ) . '>';
Scott committed
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
        }
    }

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

        $message = $this->fixEOL($message);
Scott committed
1770
        //Remove a trailing line break
Scott committed
1771 1772 1773 1774
        if (substr($message, -$lelen) == $this->LE) {
            $message = substr($message, 0, -$lelen);
        }

Scott committed
1775 1776 1777
        //Split message into lines
        $lines = explode($this->LE, $message);
        //Message will be rebuilt in here
Scott committed
1778
        $message = '';
Scott committed
1779 1780
        foreach ($lines as $line) {
            $words = explode(' ', $line);
Scott committed
1781
            $buf = '';
Scott committed
1782 1783
            $firstword = true;
            foreach ($words as $word) {
Scott committed
1784 1785
                if ($qp_mode and (strlen($word) > $length)) {
                    $space_left = $length - strlen($buf) - $crlflen;
Scott committed
1786
                    if (!$firstword) {
Scott committed
1787 1788 1789 1790
                        if ($space_left > 20) {
                            $len = $space_left;
                            if ($is_utf8) {
                                $len = $this->utf8CharBoundary($word, $len);
Scott committed
1791
                            } elseif (substr($word, $len - 1, 1) == '=') {
Scott committed
1792
                                $len--;
Scott committed
1793
                            } elseif (substr($word, $len - 2, 1) == '=') {
Scott committed
1794 1795 1796 1797 1798
                                $len -= 2;
                            }
                            $part = substr($word, 0, $len);
                            $word = substr($word, $len);
                            $buf .= ' ' . $part;
Scott committed
1799
                            $message .= $buf . sprintf('=%s', self::CRLF);
Scott committed
1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
                        } else {
                            $message .= $buf . $soft_break;
                        }
                        $buf = '';
                    }
                    while (strlen($word) > 0) {
                        if ($length <= 0) {
                            break;
                        }
                        $len = $length;
                        if ($is_utf8) {
                            $len = $this->utf8CharBoundary($word, $len);
Scott committed
1812
                        } elseif (substr($word, $len - 1, 1) == '=') {
Scott committed
1813
                            $len--;
Scott committed
1814
                        } elseif (substr($word, $len - 2, 1) == '=') {
Scott committed
1815 1816 1817 1818 1819 1820
                            $len -= 2;
                        }
                        $part = substr($word, 0, $len);
                        $word = substr($word, $len);

                        if (strlen($word) > 0) {
Scott committed
1821
                            $message .= $part . sprintf('=%s', self::CRLF);
Scott committed
1822 1823 1824 1825 1826 1827
                        } else {
                            $buf = $part;
                        }
                    }
                } else {
                    $buf_o = $buf;
Scott committed
1828 1829 1830 1831
                    if (!$firstword) {
                        $buf .= ' ';
                    }
                    $buf .= $word;
Scott committed
1832 1833 1834 1835 1836 1837

                    if (strlen($buf) > $length and $buf_o != '') {
                        $message .= $buf_o . $soft_break;
                        $buf = $word;
                    }
                }
Scott committed
1838
                $firstword = false;
Scott committed
1839 1840 1841 1842 1843 1844 1845 1846 1847
            }
            $message .= $buf . self::CRLF;
        }

        return $message;
    }

    /**
     * Find the last character boundary prior to $maxLength in a utf-8
Scott committed
1848
     * quoted-printable encoded string.
Scott committed
1849 1850 1851
     * Original written by Colin Brown.
     * @access public
     * @param string $encodedText utf-8 QP text
Scott committed
1852 1853
     * @param integer $maxLength Find the last character boundary prior to this length
     * @return integer
Scott committed
1854 1855 1856 1857 1858 1859 1860
     */
    public function utf8CharBoundary($encodedText, $maxLength)
    {
        $foundSplitPos = false;
        $lookBack = 3;
        while (!$foundSplitPos) {
            $lastChunk = substr($encodedText, $maxLength - $lookBack, $lookBack);
Scott committed
1861 1862
            $encodedCharPos = strpos($lastChunk, '=');
            if (false !== $encodedCharPos) {
Scott committed
1863 1864 1865 1866
                // Found start of encoded character byte within $lookBack block.
                // Check the encoded byte value (the 2 chars after the '=')
                $hex = substr($encodedText, $maxLength - $lookBack + $encodedCharPos + 1, 2);
                $dec = hexdec($hex);
Scott committed
1867 1868
                if ($dec < 128) {
                    // Single byte character.
Scott committed
1869 1870
                    // If the encoded char was found at pos 0, it will fit
                    // otherwise reduce maxLength to start of the encoded char
Scott committed
1871 1872 1873
                    if ($encodedCharPos > 0) {
                        $maxLength = $maxLength - ($lookBack - $encodedCharPos);
                    }
Scott committed
1874
                    $foundSplitPos = true;
Scott committed
1875 1876
                } elseif ($dec >= 192) {
                    // First byte of a multi byte character
Scott committed
1877 1878 1879
                    // Reduce maxLength to split at start of character
                    $maxLength = $maxLength - ($lookBack - $encodedCharPos);
                    $foundSplitPos = true;
Scott committed
1880 1881
                } elseif ($dec < 192) {
                    // Middle byte of a multi byte character, look further back
Scott committed
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
                    $lookBack += 3;
                }
            } else {
                // No encoded character found
                $foundSplitPos = true;
            }
        }
        return $maxLength;
    }

    /**
Scott committed
1893 1894 1895 1896
     * Apply word wrapping to the message body.
     * Wraps the message body to the number of chars set in the WordWrap property.
     * You should only do this to plain-text bodies as wrapping HTML tags may break them.
     * This is called automatically by createBody(), so you don't need to call it yourself.
Scott committed
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
     * @access public
     * @return void
     */
    public function setWordWrap()
    {
        if ($this->WordWrap < 1) {
            return;
        }

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

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

        if ($this->MessageDate == '') {
Scott committed
1929
            $this->MessageDate = self::rfcDate();
Scott committed
1930
        }
Scott committed
1931
        $result .= $this->headerLine('Date', $this->MessageDate);
Scott committed
1932 1933

        // To be created automatically by mail()
Scott committed
1934 1935 1936 1937
        if ($this->SingleTo) {
            if ($this->Mailer != 'mail') {
                foreach ($this->to as $toaddr) {
                    $this->SingleToArray[] = $this->addrFormat($toaddr);
Scott committed
1938
                }
Scott committed
1939 1940 1941 1942
            }
        } else {
            if (count($this->to) > 0) {
                if ($this->Mailer != 'mail') {
Scott committed
1943 1944
                    $result .= $this->addrAppend('To', $this->to);
                }
Scott committed
1945 1946
            } elseif (count($this->cc) == 0) {
                $result .= $this->headerLine('To', 'undisclosed-recipients:;');
Scott committed
1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
            }
        }

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

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

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

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

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

        if ($this->MessageID != '') {
            $this->lastMessageID = $this->MessageID;
        } else {
Scott committed
1978
            $this->lastMessageID = sprintf('<%s@%s>', $this->uniqueid, $this->serverHostname());
Scott committed
1979 1980 1981 1982
        }
        $result .= $this->headerLine('Message-ID', $this->lastMessageID);
        if (!is_null($this->Priority)) {
            $result .= $this->headerLine('X-Priority', $this->Priority);
Scott committed
1983 1984 1985 1986
        }
        if ($this->XMailer == '') {
            $result .= $this->headerLine(
                'X-Mailer',
Scott committed
1987
                'PHPMailer ' . $this->Version . ' (https://github.com/PHPMailer/PHPMailer)'
Scott committed
1988 1989 1990 1991 1992 1993 1994 1995 1996
            );
        } else {
            $myXmailer = trim($this->XMailer);
            if ($myXmailer) {
                $result .= $this->headerLine('X-Mailer', $myXmailer);
            }
        }

        if ($this->ConfirmReadingTo != '') {
Scott committed
1997
            $result .= $this->headerLine('Disposition-Notification-To', '<' . $this->ConfirmReadingTo . '>');
Scott committed
1998 1999 2000
        }

        // Add custom headers
Scott committed
2001
        foreach ($this->CustomHeader as $header) {
Scott committed
2002
            $result .= $this->headerLine(
Scott committed
2003 2004
                trim($header[0]),
                $this->encodeHeader(trim($header[1]))
Scott committed
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022
            );
        }
        if (!$this->sign_key_file) {
            $result .= $this->headerLine('MIME-Version', '1.0');
            $result .= $this->getMailMIME();
        }

        return $result;
    }

    /**
     * Get the message MIME type headers.
     * @access public
     * @return string
     */
    public function getMailMIME()
    {
        $result = '';
Scott committed
2023
        $ismultipart = true;
Scott committed
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
        switch ($this->message_type) {
            case 'inline':
                $result .= $this->headerLine('Content-Type', 'multipart/related;');
                $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
                break;
            case 'attach':
            case 'inline_attach':
            case 'alt_attach':
            case 'alt_inline_attach':
                $result .= $this->headerLine('Content-Type', 'multipart/mixed;');
                $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
                break;
            case 'alt':
            case 'alt_inline':
                $result .= $this->headerLine('Content-Type', 'multipart/alternative;');
                $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
                break;
            default:
                // Catches case 'plain': and case '':
                $result .= $this->textLine('Content-Type: ' . $this->ContentType . '; charset=' . $this->CharSet);
Scott committed
2044
                $ismultipart = false;
Scott committed
2045 2046
                break;
        }
Scott committed
2047
        // RFC1341 part 5 says 7bit is assumed if not specified
Scott committed
2048
        if ($this->Encoding != '7bit') {
Scott committed
2049 2050 2051 2052 2053 2054 2055 2056 2057
            // RFC 2045 section 6.4 says multipart MIME parts may only use 7bit, 8bit or binary CTE
            if ($ismultipart) {
                if ($this->Encoding == '8bit') {
                    $result .= $this->headerLine('Content-Transfer-Encoding', '8bit');
                }
                // The only remaining alternatives are quoted-printable and base64, which are both 7bit compatible
            } else {
                $result .= $this->headerLine('Content-Transfer-Encoding', $this->Encoding);
            }
Scott committed
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
        }

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

        return $result;
    }

    /**
     * Returns the whole MIME message.
     * Includes complete headers and body.
Scott committed
2070 2071
     * Only valid post preSend().
     * @see PHPMailer::preSend()
Scott committed
2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
     * @access public
     * @return string
     */
    public function getSentMIMEMessage()
    {
        return $this->MIMEHeader . $this->mailHeader . self::CRLF . $this->MIMEBody;
    }

    /**
     * Assemble the message body.
     * Returns an empty string on failure.
     * @access public
     * @throws phpmailerException
     * @return string The assembled message body
     */
    public function createBody()
    {
        $body = '';
Scott committed
2090 2091 2092 2093 2094
        //Create unique IDs and preset boundaries
        $this->uniqueid = md5(uniqid(time()));
        $this->boundary[1] = 'b1_' . $this->uniqueid;
        $this->boundary[2] = 'b2_' . $this->uniqueid;
        $this->boundary[3] = 'b3_' . $this->uniqueid;
Scott committed
2095 2096 2097 2098 2099 2100 2101 2102 2103

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

        $this->setWordWrap();

        $bodyEncoding = $this->Encoding;
        $bodyCharSet = $this->CharSet;
Scott committed
2104 2105
        //Can we do a 7-bit downgrade?
        if ($bodyEncoding == '8bit' and !$this->has8bitChars($this->Body)) {
Scott committed
2106 2107 2108
            $bodyEncoding = '7bit';
            $bodyCharSet = 'us-ascii';
        }
Scott committed
2109 2110 2111 2112 2113 2114 2115
        //If lines are too long, and we're not already using an encoding that will shorten them,
        //change to quoted-printable transfer encoding
        if ('base64' != $this->Encoding and self::hasLineLongerThanMax($this->Body)) {
            $this->Encoding = 'quoted-printable';
            $bodyEncoding = 'quoted-printable';
        }

Scott committed
2116 2117
        $altBodyEncoding = $this->Encoding;
        $altBodyCharSet = $this->CharSet;
Scott committed
2118 2119
        //Can we do a 7-bit downgrade?
        if ($altBodyEncoding == '8bit' and !$this->has8bitChars($this->AltBody)) {
Scott committed
2120 2121 2122
            $altBodyEncoding = '7bit';
            $altBodyCharSet = 'us-ascii';
        }
Scott committed
2123 2124 2125 2126 2127 2128
        //If lines are too long, change to quoted-printable transfer encoding
        if (self::hasLineLongerThanMax($this->AltBody)) {
            $altBodyEncoding = 'quoted-printable';
        }
        //Use this as a preamble in all multipart message types
        $mimepre = "This is a multi-part message in MIME format." . $this->LE . $this->LE;
Scott committed
2129 2130
        switch ($this->message_type) {
            case 'inline':
Scott committed
2131
                $body .= $mimepre;
Scott committed
2132 2133 2134 2135 2136 2137
                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[1]);
                break;
            case 'attach':
Scott committed
2138
                $body .= $mimepre;
Scott committed
2139 2140 2141 2142 2143 2144
                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            case 'inline_attach':
Scott committed
2145
                $body .= $mimepre;
Scott committed
2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/related;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            case 'alt':
Scott committed
2158
                $body .= $mimepre;
Scott committed
2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172
                $body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                if (!empty($this->Ical)) {
                    $body .= $this->getBoundary($this->boundary[1], '', 'text/calendar; method=REQUEST', '');
                    $body .= $this->encodeString($this->Ical, $this->Encoding);
                    $body .= $this->LE . $this->LE;
                }
                $body .= $this->endBoundary($this->boundary[1]);
                break;
            case 'alt_inline':
Scott committed
2173
                $body .= $mimepre;
Scott committed
2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
                $body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/related;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->endBoundary($this->boundary[1]);
                break;
            case 'alt_attach':
Scott committed
2189
                $body .= $mimepre;
Scott committed
2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/alternative;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->endBoundary($this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            case 'alt_inline_attach':
Scott committed
2205
                $body .= $mimepre;
Scott committed
2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/alternative;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->textLine('--' . $this->boundary[2]);
                $body .= $this->headerLine('Content-Type', 'multipart/related;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[3] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[3], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[3]);
                $body .= $this->LE;
                $body .= $this->endBoundary($this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            default:
                // catch case 'plain' and case ''
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                break;
        }

        if ($this->isError()) {
            $body = '';
        } elseif ($this->sign_key_file) {
            try {
                if (!defined('PKCS7_TEXT')) {
Scott committed
2237
                    throw new phpmailerException($this->lang('extension_missing') . 'openssl');
Scott committed
2238
                }
Scott committed
2239
                // @TODO would be nice to use php://temp streams here, but need to wrap for PHP < 5.1
Scott committed
2240
                $file = tempnam(sys_get_temp_dir(), 'mail');
Scott committed
2241 2242 2243
                if (false === file_put_contents($file, $body)) {
                    throw new phpmailerException($this->lang('signing') . ' Could not write temp file');
                }
Scott committed
2244
                $signed = tempnam(sys_get_temp_dir(), 'signed');
Scott committed
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
                //Workaround for PHP bug https://bugs.php.net/bug.php?id=69197
                if (empty($this->sign_extracerts_file)) {
                    $sign = @openssl_pkcs7_sign(
                        $file,
                        $signed,
                        'file://' . realpath($this->sign_cert_file),
                        array('file://' . realpath($this->sign_key_file), $this->sign_key_pass),
                        null
                    );
                } else {
                    $sign = @openssl_pkcs7_sign(
                        $file,
                        $signed,
                        'file://' . realpath($this->sign_cert_file),
                        array('file://' . realpath($this->sign_key_file), $this->sign_key_pass),
                        null,
                        PKCS7_DETACHED,
                        $this->sign_extracerts_file
                    );
                }
                if ($sign) {
Scott committed
2266 2267 2268
                    @unlink($file);
                    $body = file_get_contents($signed);
                    @unlink($signed);
Scott committed
2269 2270 2271 2272
                    //The message returned by openssl contains both headers and body, so need to split them up
                    $parts = explode("\n\n", $body, 2);
                    $this->MIMEHeader .= $parts[0] . $this->LE . $this->LE;
                    $body = $parts[1];
Scott committed
2273 2274 2275 2276 2277
                } else {
                    @unlink($file);
                    @unlink($signed);
                    throw new phpmailerException($this->lang('signing') . openssl_error_string());
                }
Scott committed
2278
            } catch (phpmailerException $exc) {
Scott committed
2279 2280
                $body = '';
                if ($this->exceptions) {
Scott committed
2281
                    throw $exc;
Scott committed
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
                }
            }
        }
        return $body;
    }

    /**
     * Return the start of a message boundary.
     * @access protected
     * @param string $boundary
     * @param string $charSet
     * @param string $contentType
     * @param string $encoding
     * @return string
     */
    protected function getBoundary($boundary, $charSet, $contentType, $encoding)
    {
        $result = '';
        if ($charSet == '') {
            $charSet = $this->CharSet;
        }
        if ($contentType == '') {
            $contentType = $this->ContentType;
        }
        if ($encoding == '') {
            $encoding = $this->Encoding;
        }
        $result .= $this->textLine('--' . $boundary);
Scott committed
2310
        $result .= sprintf('Content-Type: %s; charset=%s', $contentType, $charSet);
Scott committed
2311
        $result .= $this->LE;
Scott committed
2312
        // RFC1341 part 5 says 7bit is assumed if not specified
Scott committed
2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340
        if ($encoding != '7bit') {
            $result .= $this->headerLine('Content-Transfer-Encoding', $encoding);
        }
        $result .= $this->LE;

        return $result;
    }

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

    /**
     * Set the message type.
     * PHPMailer only supports some preset message types,
     * not arbitrary MIME structures.
     * @access protected
     * @return void
     */
    protected function setMessageType()
    {
Scott committed
2341
        $type = array();
Scott committed
2342
        if ($this->alternativeExists()) {
Scott committed
2343
            $type[] = 'alt';
Scott committed
2344 2345
        }
        if ($this->inlineImageExists()) {
Scott committed
2346
            $type[] = 'inline';
Scott committed
2347 2348
        }
        if ($this->attachmentExists()) {
Scott committed
2349
            $type[] = 'attach';
Scott committed
2350
        }
Scott committed
2351 2352 2353
        $this->message_type = implode('_', $type);
        if ($this->message_type == '') {
            $this->message_type = 'plain';
Scott committed
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388
        }
    }

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

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

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

Scott committed
2398
            // If a MIME type is not specified, try to work it out from the file name
Scott committed
2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418
            if ($type == '') {
                $type = self::filenameToType($path);
            }

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

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

Scott committed
2419 2420 2421
        } catch (phpmailerException $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
Scott committed
2422
            if ($this->exceptions) {
Scott committed
2423
                throw $exc;
Scott committed
2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477
            }
            return false;
        }
        return true;
    }

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

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

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

                $inclhash = md5(serialize($attachment));
                if (in_array($inclhash, $incl)) {
                    continue;
                }
                $incl[] = $inclhash;
                $name = $attachment[2];
                $encoding = $attachment[3];
                $type = $attachment[4];
                $disposition = $attachment[6];
                $cid = $attachment[7];
Scott committed
2478
                if ($disposition == 'inline' && array_key_exists($cid, $cidUniq)) {
Scott committed
2479 2480 2481 2482
                    continue;
                }
                $cidUniq[$cid] = true;

Scott committed
2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499
                $mime[] = sprintf('--%s%s', $boundary, $this->LE);
                //Only include a filename property if we have one
                if (!empty($name)) {
                    $mime[] = sprintf(
                        'Content-Type: %s; name="%s"%s',
                        $type,
                        $this->encodeHeader($this->secureHeader($name)),
                        $this->LE
                    );
                } else {
                    $mime[] = sprintf(
                        'Content-Type: %s%s',
                        $type,
                        $this->LE
                    );
                }
                // RFC1341 part 5 says 7bit is assumed if not specified
Scott committed
2500
                if ($encoding != '7bit') {
Scott committed
2501
                    $mime[] = sprintf('Content-Transfer-Encoding: %s%s', $encoding, $this->LE);
Scott committed
2502 2503 2504
                }

                if ($disposition == 'inline') {
Scott committed
2505
                    $mime[] = sprintf('Content-ID: <%s>%s', $cid, $this->LE);
Scott committed
2506 2507 2508 2509 2510 2511 2512
                }

                // If a filename contains any of these chars, it should be quoted,
                // but not otherwise: RFC2183 & RFC2045 5.1
                // Fixes a warning in IETF's msglint MIME checker
                // Allow for bypassing the Content-Disposition header totally
                if (!(empty($disposition))) {
Scott committed
2513 2514
                    $encoded_name = $this->encodeHeader($this->secureHeader($name));
                    if (preg_match('/[ \(\)<>@,;:\\"\/\[\]\?=]/', $encoded_name)) {
Scott committed
2515
                        $mime[] = sprintf(
Scott committed
2516
                            'Content-Disposition: %s; filename="%s"%s',
Scott committed
2517
                            $disposition,
Scott committed
2518
                            $encoded_name,
Scott committed
2519 2520 2521
                            $this->LE . $this->LE
                        );
                    } else {
Scott committed
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535
                        if (!empty($encoded_name)) {
                            $mime[] = sprintf(
                                'Content-Disposition: %s; filename=%s%s',
                                $disposition,
                                $encoded_name,
                                $this->LE . $this->LE
                            );
                        } else {
                            $mime[] = sprintf(
                                'Content-Disposition: %s%s',
                                $disposition,
                                $this->LE . $this->LE
                            );
                        }
Scott committed
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557
                    }
                } else {
                    $mime[] = $this->LE;
                }

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

Scott committed
2558
        $mime[] = sprintf('--%s--%s', $boundary, $this->LE);
Scott committed
2559

Scott committed
2560
        return implode('', $mime);
Scott committed
2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580
    }

    /**
     * Encode a file attachment in requested format.
     * Returns an empty string on failure.
     * @param string $path The full path to the file
     * @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
     * @throws phpmailerException
     * @access protected
     * @return string
     */
    protected function encodeFile($path, $encoding = 'base64')
    {
        try {
            if (!is_readable($path)) {
                throw new phpmailerException($this->lang('file_open') . $path, self::STOP_CONTINUE);
            }
            $magic_quotes = get_magic_quotes_runtime();
            if ($magic_quotes) {
                if (version_compare(PHP_VERSION, '5.3.0', '<')) {
Scott committed
2581
                    set_magic_quotes_runtime(false);
Scott committed
2582
                } else {
Scott committed
2583 2584 2585 2586
                    //Doesn't exist in PHP 5.4, but we don't need to check because
                    //get_magic_quotes_runtime always returns false in 5.4+
                    //so it will never get here
                    ini_set('magic_quotes_runtime', false);
Scott committed
2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598
                }
            }
            $file_buffer = file_get_contents($path);
            $file_buffer = $this->encodeString($file_buffer, $encoding);
            if ($magic_quotes) {
                if (version_compare(PHP_VERSION, '5.3.0', '<')) {
                    set_magic_quotes_runtime($magic_quotes);
                } else {
                    ini_set('magic_quotes_runtime', $magic_quotes);
                }
            }
            return $file_buffer;
Scott committed
2599 2600
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
Scott committed
2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
            return '';
        }
    }

    /**
     * Encode a string in requested format.
     * Returns an empty string on failure.
     * @param string $str The text to encode
     * @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
     * @access public
     * @return string
     */
    public function encodeString($str, $encoding = 'base64')
    {
        $encoded = '';
        switch (strtolower($encoding)) {
            case 'base64':
                $encoded = chunk_split(base64_encode($str), 76, $this->LE);
                break;
            case '7bit':
            case '8bit':
                $encoded = $this->fixEOL($str);
Scott committed
2623
                // Make sure it ends with a line break
Scott committed
2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650
                if (substr($encoded, -(strlen($this->LE))) != $this->LE) {
                    $encoded .= $this->LE;
                }
                break;
            case 'binary':
                $encoded = $str;
                break;
            case 'quoted-printable':
                $encoded = $this->encodeQP($str);
                break;
            default:
                $this->setError($this->lang('encoding') . $encoding);
                break;
        }
        return $encoded;
    }

    /**
     * Encode a header string optimally.
     * Picks shortest of Q, B, quoted-printable or none.
     * @access public
     * @param string $str
     * @param string $position
     * @return string
     */
    public function encodeHeader($str, $position = 'text')
    {
Scott committed
2651
        $matchcount = 0;
Scott committed
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662
        switch (strtolower($position)) {
            case 'phrase':
                if (!preg_match('/[\200-\377]/', $str)) {
                    // Can't use addslashes as we don't know the value of magic_quotes_sybase
                    $encoded = addcslashes($str, "\0..\37\177\\\"");
                    if (($str == $encoded) && !preg_match('/[^A-Za-z0-9!#$%&\'*+\/=?^_`{|}~ -]/', $str)) {
                        return ($encoded);
                    } else {
                        return ("\"$encoded\"");
                    }
                }
Scott committed
2663
                $matchcount = preg_match_all('/[^\040\041\043-\133\135-\176]/', $str, $matches);
Scott committed
2664 2665 2666
                break;
            /** @noinspection PhpMissingBreakStatementInspection */
            case 'comment':
Scott committed
2667
                $matchcount = preg_match_all('/[()"]/', $str, $matches);
Scott committed
2668 2669 2670
                // Intentional fall-through
            case 'text':
            default:
Scott committed
2671
                $matchcount += preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $str, $matches);
Scott committed
2672 2673 2674
                break;
        }

Scott committed
2675 2676
        //There are no chars that need encoding
        if ($matchcount == 0) {
Scott committed
2677 2678 2679 2680 2681
            return ($str);
        }

        $maxlen = 75 - 7 - strlen($this->CharSet);
        // Try to select the encoding which should produce the shortest output
Scott committed
2682 2683
        if ($matchcount > strlen($str) / 3) {
            // More than a third of the content will need encoding, so B encoding will be most efficient
Scott committed
2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710
            $encoding = 'B';
            if (function_exists('mb_strlen') && $this->hasMultiBytes($str)) {
                // Use a custom function which correctly encodes and wraps long
                // multibyte strings without breaking lines within a character
                $encoded = $this->base64EncodeWrapMB($str, "\n");
            } else {
                $encoded = base64_encode($str);
                $maxlen -= $maxlen % 4;
                $encoded = trim(chunk_split($encoded, $maxlen, "\n"));
            }
        } else {
            $encoding = 'Q';
            $encoded = $this->encodeQ($str, $position);
            $encoded = $this->wrapText($encoded, $maxlen, true);
            $encoded = str_replace('=' . self::CRLF, "\n", trim($encoded));
        }

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

        return $encoded;
    }

    /**
     * Check if a string contains multi-byte characters.
     * @access public
     * @param string $str multi-byte text to wrap encode
Scott committed
2711
     * @return boolean
Scott committed
2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724
     */
    public function hasMultiBytes($str)
    {
        if (function_exists('mb_strlen')) {
            return (strlen($str) > mb_strlen($str, $this->CharSet));
        } else { // Assume no multibytes (we can't handle without mbstring functions anyway)
            return false;
        }
    }

    /**
     * Does a string contain any 8-bit chars (in any charset)?
     * @param string $text
Scott committed
2725
     * @return boolean
Scott committed
2726 2727 2728
     */
    public function has8bitChars($text)
    {
Scott committed
2729
        return (boolean)preg_match('/[\x80-\xFF]/', $text);
Scott committed
2730 2731 2732 2733 2734 2735 2736 2737 2738
    }

    /**
     * Encode and wrap long multibyte strings for mail headers
     * without breaking lines within a character.
     * Adapted from a function by paravoid
     * @link http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283
     * @access public
     * @param string $str multi-byte text to wrap encode
Scott committed
2739
     * @param string $linebreak string to use as linefeed/end-of-line
Scott committed
2740 2741
     * @return string
     */
Scott committed
2742
    public function base64EncodeWrapMB($str, $linebreak = null)
Scott committed
2743
    {
Scott committed
2744 2745 2746 2747 2748
        $start = '=?' . $this->CharSet . '?B?';
        $end = '?=';
        $encoded = '';
        if ($linebreak === null) {
            $linebreak = $this->LE;
Scott committed
2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766
        }

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

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

        // Chomp the last linefeed
Scott committed
2771
        $encoded = substr($encoded, 0, -strlen($linebreak));
Scott committed
2772 2773 2774 2775 2776 2777 2778 2779 2780 2781
        return $encoded;
    }

    /**
     * Encode a string in quoted-printable format.
     * According to RFC2045 section 6.7.
     * @access public
     * @param string $string The text to encode
     * @param integer $line_max Number of chars allowed on a line before wrapping
     * @return string
Scott committed
2782
     * @link http://www.php.net/manual/en/function.quoted-printable-decode.php#89417 Adapted from this comment
Scott committed
2783 2784 2785
     */
    public function encodeQP($string, $line_max = 76)
    {
Scott committed
2786 2787 2788
        // Use native function if it's available (>= PHP5.3)
        if (function_exists('quoted_printable_encode')) {
            return quoted_printable_encode($string);
Scott committed
2789
        }
Scott committed
2790
        // Fall back to a pure PHP implementation
Scott committed
2791 2792 2793 2794 2795
        $string = str_replace(
            array('%20', '%0D%0A.', '%0D%0A', '%'),
            array(' ', "\r\n=2E", "\r\n", '='),
            rawurlencode($string)
        );
Scott committed
2796
        return preg_replace('/[^\r\n]{' . ($line_max - 3) . '}[^=\r\n]{2}/', "$0=\r\n", $string);
Scott committed
2797 2798 2799 2800 2801 2802 2803 2804
    }

    /**
     * Backward compatibility wrapper for an old QP encoding function that was removed.
     * @see PHPMailer::encodeQP()
     * @access public
     * @param string $string
     * @param integer $line_max
Scott committed
2805
     * @param boolean $space_conv
Scott committed
2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826
     * @return string
     * @deprecated Use encodeQP instead.
     */
    public function encodeQPphp(
        $string,
        $line_max = 76,
        /** @noinspection PhpUnusedParameterInspection */ $space_conv = false
    ) {
        return $this->encodeQP($string, $line_max);
    }

    /**
     * Encode a string using Q encoding.
     * @link http://tools.ietf.org/html/rfc2047
     * @param string $str the text to encode
     * @param string $position Where the text is going to be used, see the RFC for what that means
     * @access public
     * @return string
     */
    public function encodeQ($str, $position = 'text')
    {
Scott committed
2827
        // There should not be any EOL in the string
Scott committed
2828 2829 2830 2831
        $pattern = '';
        $encoded = str_replace(array("\r", "\n"), '', $str);
        switch (strtolower($position)) {
            case 'phrase':
Scott committed
2832
                // RFC 2047 section 5.3
Scott committed
2833 2834 2835 2836
                $pattern = '^A-Za-z0-9!*+\/ -';
                break;
            /** @noinspection PhpMissingBreakStatementInspection */
            case 'comment':
Scott committed
2837
                // RFC 2047 section 5.2
Scott committed
2838
                $pattern = '\(\)"';
Scott committed
2839 2840
                // intentional fall-through
                // for this reason we build the $pattern without including delimiters and []
Scott committed
2841 2842
            case 'text':
            default:
Scott committed
2843 2844
                // RFC 2047 section 5.1
                // Replace every high ascii, control, =, ? and _ characters
Scott committed
2845 2846 2847 2848 2849
                $pattern = '\000-\011\013\014\016-\037\075\077\137\177-\377' . $pattern;
                break;
        }
        $matches = array();
        if (preg_match_all("/[{$pattern}]/", $encoded, $matches)) {
Scott committed
2850 2851 2852 2853 2854
            // If the string contains an '=', make sure it's the first thing we replace
            // so as to avoid double-encoding
            $eqkey = array_search('=', $matches[0]);
            if (false !== $eqkey) {
                unset($matches[0][$eqkey]);
Scott committed
2855 2856 2857 2858 2859 2860
                array_unshift($matches[0], '=');
            }
            foreach (array_unique($matches[0]) as $char) {
                $encoded = str_replace($char, '=' . sprintf('%02X', ord($char)), $encoded);
            }
        }
Scott committed
2861
        // Replace every spaces to _ (more readable than =20)
Scott committed
2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882
        return str_replace(' ', '_', $encoded);
    }

    /**
     * Add a string or binary attachment (non-filesystem).
     * This method can be used to attach ascii or binary data,
     * such as a BLOB record from a database.
     * @param string $string String attachment data.
     * @param string $filename Name of the attachment.
     * @param string $encoding File encoding (see $Encoding).
     * @param string $type File extension (MIME) type.
     * @param string $disposition Disposition to use
     * @return void
     */
    public function addStringAttachment(
        $string,
        $filename,
        $encoding = 'base64',
        $type = '',
        $disposition = 'attachment'
    ) {
Scott committed
2883
        // If a MIME type is not specified, try to work it out from the file name
Scott committed
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902
        if ($type == '') {
            $type = self::filenameToType($filename);
        }
        // Append to $attachment array
        $this->attachment[] = array(
            0 => $string,
            1 => $filename,
            2 => basename($filename),
            3 => $encoding,
            4 => $type,
            5 => true, // isStringAttachment
            6 => $disposition,
            7 => 0
        );
    }

    /**
     * Add an embedded (inline) attachment from a file.
     * This can include images, sounds, and just about any other document type.
Scott committed
2903
     * These differ from 'regular' attachments in that they are intended to be
Scott committed
2904 2905 2906 2907 2908 2909 2910 2911 2912 2913
     * displayed inline with the message, not just attached for download.
     * This is used in HTML messages that embed the images
     * the HTML refers to using the $cid value.
     * @param string $path Path to the attachment.
     * @param string $cid Content ID of the attachment; Use this to reference
     *        the content when using an embedded image in HTML.
     * @param string $name Overrides the attachment name.
     * @param string $encoding File encoding (see $Encoding).
     * @param string $type File MIME type.
     * @param string $disposition Disposition to use
Scott committed
2914
     * @return boolean True on successfully adding an attachment
Scott committed
2915 2916 2917 2918 2919 2920 2921 2922
     */
    public function addEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = '', $disposition = 'inline')
    {
        if (!@is_file($path)) {
            $this->setError($this->lang('file_access') . $path);
            return false;
        }

Scott committed
2923
        // If a MIME type is not specified, try to work it out from the file name
Scott committed
2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958
        if ($type == '') {
            $type = self::filenameToType($path);
        }

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

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

    /**
     * Add an embedded stringified attachment.
     * This can include images, sounds, and just about any other document type.
     * Be sure to set the $type to an image type for images:
     * JPEG images use 'image/jpeg', GIF uses 'image/gif', PNG uses 'image/png'.
     * @param string $string The attachment binary data.
     * @param string $cid Content ID of the attachment; Use this to reference
     *        the content when using an embedded image in HTML.
     * @param string $name
     * @param string $encoding File encoding (see $Encoding).
     * @param string $type MIME type.
     * @param string $disposition Disposition to use
Scott committed
2959
     * @return boolean True on successfully adding an attachment
Scott committed
2960 2961 2962 2963 2964 2965 2966 2967 2968
     */
    public function addStringEmbeddedImage(
        $string,
        $cid,
        $name = '',
        $encoding = 'base64',
        $type = '',
        $disposition = 'inline'
    ) {
Scott committed
2969 2970
        // If a MIME type is not specified, try to work it out from the name
        if ($type == '' and !empty($name)) {
Scott committed
2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990
            $type = self::filenameToType($name);
        }

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

    /**
     * Check if an inline attachment is present.
     * @access public
Scott committed
2991
     * @return boolean
Scott committed
2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004
     */
    public function inlineImageExists()
    {
        foreach ($this->attachment as $attachment) {
            if ($attachment[6] == 'inline') {
                return true;
            }
        }
        return false;
    }

    /**
     * Check if an attachment (non-inline) is present.
Scott committed
3005
     * @return boolean
Scott committed
3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018
     */
    public function attachmentExists()
    {
        foreach ($this->attachment as $attachment) {
            if ($attachment[6] == 'attachment') {
                return true;
            }
        }
        return false;
    }

    /**
     * Check if this message has an alternative body set.
Scott committed
3019
     * @return boolean
Scott committed
3020 3021 3022 3023 3024 3025
     */
    public function alternativeExists()
    {
        return !empty($this->AltBody);
    }

Scott committed
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
    /**
     * Clear queued addresses of given kind.
     * @access protected
     * @param string $kind 'to', 'cc', or 'bcc'
     * @return void
     */
    public function clearQueuedAddresses($kind)
    {
        $RecipientsQueue = $this->RecipientsQueue;
        foreach ($RecipientsQueue as $address => $params) {
            if ($params[0] == $kind) {
                unset($this->RecipientsQueue[$address]);
            }
        }
    }

Scott committed
3042 3043 3044 3045 3046 3047 3048 3049 3050 3051
    /**
     * Clear all To recipients.
     * @return void
     */
    public function clearAddresses()
    {
        foreach ($this->to as $to) {
            unset($this->all_recipients[strtolower($to[0])]);
        }
        $this->to = array();
Scott committed
3052
        $this->clearQueuedAddresses('to');
Scott committed
3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064
    }

    /**
     * Clear all CC recipients.
     * @return void
     */
    public function clearCCs()
    {
        foreach ($this->cc as $cc) {
            unset($this->all_recipients[strtolower($cc[0])]);
        }
        $this->cc = array();
Scott committed
3065
        $this->clearQueuedAddresses('cc');
Scott committed
3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077
    }

    /**
     * Clear all BCC recipients.
     * @return void
     */
    public function clearBCCs()
    {
        foreach ($this->bcc as $bcc) {
            unset($this->all_recipients[strtolower($bcc[0])]);
        }
        $this->bcc = array();
Scott committed
3078
        $this->clearQueuedAddresses('bcc');
Scott committed
3079 3080 3081 3082 3083 3084 3085 3086 3087
    }

    /**
     * Clear all ReplyTo recipients.
     * @return void
     */
    public function clearReplyTos()
    {
        $this->ReplyTo = array();
Scott committed
3088
        $this->ReplyToQueue = array();
Scott committed
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100
    }

    /**
     * Clear all recipient types.
     * @return void
     */
    public function clearAllRecipients()
    {
        $this->to = array();
        $this->cc = array();
        $this->bcc = array();
        $this->all_recipients = array();
Scott committed
3101
        $this->RecipientsQueue = array();
Scott committed
3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132
    }

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

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

    /**
     * Add an error message to the error container.
     * @access protected
     * @param string $msg
     * @return void
     */
    protected function setError($msg)
    {
        $this->error_count++;
        if ($this->Mailer == 'smtp' and !is_null($this->smtp)) {
            $lasterror = $this->smtp->getError();
Scott committed
3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143
            if (!empty($lasterror['error'])) {
                $msg .= $this->lang('smtp_error') . $lasterror['error'];
                if (!empty($lasterror['detail'])) {
                    $msg .= ' Detail: '. $lasterror['detail'];
                }
                if (!empty($lasterror['smtp_code'])) {
                    $msg .= ' SMTP code: ' . $lasterror['smtp_code'];
                }
                if (!empty($lasterror['smtp_code_ex'])) {
                    $msg .= ' Additional SMTP info: ' . $lasterror['smtp_code_ex'];
                }
Scott committed
3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156
            }
        }
        $this->ErrorInfo = $msg;
    }

    /**
     * Return an RFC 822 formatted date.
     * @access public
     * @return string
     * @static
     */
    public static function rfcDate()
    {
Scott committed
3157 3158
        // Set the time zone to whatever the default is to avoid 500 errors
        // Will default to UTC if it's not set properly in php.ini
Scott committed
3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195
        date_default_timezone_set(@date_default_timezone_get());
        return date('D, j M Y H:i:s O');
    }

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

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

Scott committed
3196 3197 3198 3199 3200 3201 3202
        if (array_key_exists($key, $this->language)) {
            if ($key == 'smtp_connect_failed') {
                //Include a link to troubleshooting docs on SMTP connection failure
                //this is by far the biggest cause of support questions
                //but it's usually not PHPMailer's fault.
                return $this->language[$key] . ' https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting';
            }
Scott committed
3203 3204
            return $this->language[$key];
        } else {
Scott committed
3205 3206
            //Return the key as a fallback
            return $key;
Scott committed
3207 3208 3209 3210 3211 3212
        }
    }

    /**
     * Check if an error occurred.
     * @access public
Scott committed
3213
     * @return boolean True if an error did occur.
Scott committed
3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256
     */
    public function isError()
    {
        return ($this->error_count > 0);
    }

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

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

Scott committed
3257
    /**
Scott committed
3258
     * Returns all custom headers.
Scott committed
3259 3260 3261 3262 3263 3264 3265
     * @return array
     */
    public function getCustomHeaders()
    {
        return $this->CustomHeader;
    }

Scott committed
3266 3267 3268 3269 3270 3271 3272 3273
    /**
     * Create a message from an HTML string.
     * Automatically makes modifications for inline images and backgrounds
     * and creates a plain-text version by converting the HTML.
     * Overwrites any existing values in $this->Body and $this->AltBody
     * @access public
     * @param string $message HTML message string
     * @param string $basedir baseline directory for path
Scott committed
3274
     * @param boolean|callable $advanced Whether to use the internal HTML to text converter
Scott committed
3275
     *    or your own custom converter @see PHPMailer::html2text()
Scott committed
3276 3277 3278 3279
     * @return string $message
     */
    public function msgHTML($message, $basedir = '', $advanced = false)
    {
Scott committed
3280
        preg_match_all('/(src|background)=["\'](.*)["\']/Ui', $message, $images);
Scott committed
3281
        if (array_key_exists(2, $images)) {
Scott committed
3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300
            foreach ($images[2] as $imgindex => $url) {
                // Convert data URIs into embedded images
                if (preg_match('#^data:(image[^;,]*)(;base64)?,#', $url, $match)) {
                    $data = substr($url, strpos($url, ','));
                    if ($match[2]) {
                        $data = base64_decode($data);
                    } else {
                        $data = rawurldecode($data);
                    }
                    $cid = md5($url) . '@phpmailer.0'; // RFC2392 S 2
                    if ($this->addStringEmbeddedImage($data, $cid, 'embed' . $imgindex, 'base64', $match[1])) {
                        $message = str_replace(
                            $images[0][$imgindex],
                            $images[1][$imgindex] . '="cid:' . $cid . '"',
                            $message
                        );
                    }
                } elseif (substr($url, 0, 4) !== 'cid:' && !preg_match('#^[A-z]+://#', $url)) {
                    // Do not change urls for absolute images (thanks to corvuscorax)
Scott committed
3301
                    // Do not change urls that are already inline images
Scott committed
3302 3303 3304 3305 3306
                    $filename = basename($url);
                    $directory = dirname($url);
                    if ($directory == '.') {
                        $directory = '';
                    }
Scott committed
3307
                    $cid = md5($url) . '@phpmailer.0'; // RFC2392 S 2
Scott committed
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318
                    if (strlen($basedir) > 1 && substr($basedir, -1) != '/') {
                        $basedir .= '/';
                    }
                    if (strlen($directory) > 1 && substr($directory, -1) != '/') {
                        $directory .= '/';
                    }
                    if ($this->addEmbeddedImage(
                        $basedir . $directory . $filename,
                        $cid,
                        $filename,
                        'base64',
Scott committed
3319
                        self::_mime_types((string)self::mb_pathinfo($filename, PATHINFO_EXTENSION))
Scott committed
3320 3321 3322
                    )
                    ) {
                        $message = preg_replace(
Scott committed
3323 3324
                            '/' . $images[1][$imgindex] . '=["\']' . preg_quote($url, '/') . '["\']/Ui',
                            $images[1][$imgindex] . '="cid:' . $cid . '"',
Scott committed
3325 3326 3327 3328 3329 3330 3331
                            $message
                        );
                    }
                }
            }
        }
        $this->isHTML(true);
Scott committed
3332
        // Convert all message body line breaks to CRLF, makes quoted-printable encoding work much better
Scott committed
3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343
        $this->Body = $this->normalizeBreaks($message);
        $this->AltBody = $this->normalizeBreaks($this->html2text($message, $advanced));
        if (empty($this->AltBody)) {
            $this->AltBody = 'To view this email message, open it in a program that understands HTML!' .
                self::CRLF . self::CRLF;
        }
        return $this->Body;
    }

    /**
     * Convert an HTML string into plain text.
Scott committed
3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356
     * This is used by msgHTML().
     * Note - older versions of this function used a bundled advanced converter
     * which was been removed for license reasons in #232
     * Example usage:
     * <code>
     * // Use default conversion
     * $plain = $mail->html2text($html);
     * // Use your own custom converter
     * $plain = $mail->html2text($html, function($html) {
     *     $converter = new MyHtml2text($html);
     *     return $converter->get_text();
     * });
     * </code>
Scott committed
3357
     * @param string $html The HTML text to convert
Scott committed
3358 3359
     * @param boolean|callable $advanced Any boolean value to use the internal converter,
     *   or provide your own callable for custom conversion.
Scott committed
3360 3361 3362 3363
     * @return string
     */
    public function html2text($html, $advanced = false)
    {
Scott committed
3364 3365
        if (is_callable($advanced)) {
            return call_user_func($advanced, $html);
Scott committed
3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383
        }
        return html_entity_decode(
            trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/si', '', $html))),
            ENT_QUOTES,
            $this->CharSet
        );
    }

    /**
     * Get the MIME type for a file extension.
     * @param string $ext File extension
     * @access public
     * @return string MIME type of file.
     * @static
     */
    public static function _mime_types($ext = '')
    {
        $mimes = array(
Scott committed
3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400
            'xl'    => 'application/excel',
            'js'    => 'application/javascript',
            'hqx'   => 'application/mac-binhex40',
            'cpt'   => 'application/mac-compactpro',
            'bin'   => 'application/macbinary',
            'doc'   => 'application/msword',
            'word'  => 'application/msword',
            'xlsx'  => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
            'xltx'  => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
            'potx'  => 'application/vnd.openxmlformats-officedocument.presentationml.template',
            'ppsx'  => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
            'pptx'  => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
            'sldx'  => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
            'docx'  => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
            'dotx'  => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
            'xlam'  => 'application/vnd.ms-excel.addin.macroEnabled.12',
            'xlsb'  => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
Scott committed
3401
            'class' => 'application/octet-stream',
Scott committed
3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419
            'dll'   => 'application/octet-stream',
            'dms'   => 'application/octet-stream',
            'exe'   => 'application/octet-stream',
            'lha'   => 'application/octet-stream',
            'lzh'   => 'application/octet-stream',
            'psd'   => 'application/octet-stream',
            'sea'   => 'application/octet-stream',
            'so'    => 'application/octet-stream',
            'oda'   => 'application/oda',
            'pdf'   => 'application/pdf',
            'ai'    => 'application/postscript',
            'eps'   => 'application/postscript',
            'ps'    => 'application/postscript',
            'smi'   => 'application/smil',
            'smil'  => 'application/smil',
            'mif'   => 'application/vnd.mif',
            'xls'   => 'application/vnd.ms-excel',
            'ppt'   => 'application/vnd.ms-powerpoint',
Scott committed
3420
            'wbxml' => 'application/vnd.wap.wbxml',
Scott committed
3421 3422 3423 3424 3425 3426 3427 3428 3429
            'wmlc'  => 'application/vnd.wap.wmlc',
            'dcr'   => 'application/x-director',
            'dir'   => 'application/x-director',
            'dxr'   => 'application/x-director',
            'dvi'   => 'application/x-dvi',
            'gtar'  => 'application/x-gtar',
            'php3'  => 'application/x-httpd-php',
            'php4'  => 'application/x-httpd-php',
            'php'   => 'application/x-httpd-php',
Scott committed
3430
            'phtml' => 'application/x-httpd-php',
Scott committed
3431 3432 3433 3434 3435 3436
            'phps'  => 'application/x-httpd-php-source',
            'swf'   => 'application/x-shockwave-flash',
            'sit'   => 'application/x-stuffit',
            'tar'   => 'application/x-tar',
            'tgz'   => 'application/x-tar',
            'xht'   => 'application/xhtml+xml',
Scott committed
3437
            'xhtml' => 'application/xhtml+xml',
Scott committed
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463
            'zip'   => 'application/zip',
            'mid'   => 'audio/midi',
            'midi'  => 'audio/midi',
            'mp2'   => 'audio/mpeg',
            'mp3'   => 'audio/mpeg',
            'mpga'  => 'audio/mpeg',
            'aif'   => 'audio/x-aiff',
            'aifc'  => 'audio/x-aiff',
            'aiff'  => 'audio/x-aiff',
            'ram'   => 'audio/x-pn-realaudio',
            'rm'    => 'audio/x-pn-realaudio',
            'rpm'   => 'audio/x-pn-realaudio-plugin',
            'ra'    => 'audio/x-realaudio',
            'wav'   => 'audio/x-wav',
            'bmp'   => 'image/bmp',
            'gif'   => 'image/gif',
            'jpeg'  => 'image/jpeg',
            'jpe'   => 'image/jpeg',
            'jpg'   => 'image/jpeg',
            'png'   => 'image/png',
            'tiff'  => 'image/tiff',
            'tif'   => 'image/tiff',
            'eml'   => 'message/rfc822',
            'css'   => 'text/css',
            'html'  => 'text/html',
            'htm'   => 'text/html',
Scott committed
3464
            'shtml' => 'text/html',
Scott committed
3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480
            'log'   => 'text/plain',
            'text'  => 'text/plain',
            'txt'   => 'text/plain',
            'rtx'   => 'text/richtext',
            'rtf'   => 'text/rtf',
            'vcf'   => 'text/vcard',
            'vcard' => 'text/vcard',
            'xml'   => 'text/xml',
            'xsl'   => 'text/xml',
            'mpeg'  => 'video/mpeg',
            'mpe'   => 'video/mpeg',
            'mpg'   => 'video/mpeg',
            'mov'   => 'video/quicktime',
            'qt'    => 'video/quicktime',
            'rv'    => 'video/vnd.rn-realvideo',
            'avi'   => 'video/x-msvideo',
Scott committed
3481 3482
            'movie' => 'video/x-sgi-movie'
        );
Scott committed
3483 3484 3485 3486
        if (array_key_exists(strtolower($ext), $mimes)) {
            return $mimes[strtolower($ext)];
        }
        return 'application/octet-stream';
Scott committed
3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497
    }

    /**
     * Map a file name to a MIME type.
     * Defaults to 'application/octet-stream', i.e.. arbitrary binary data.
     * @param string $filename A file name or full path, does not need to exist as a file
     * @return string
     * @static
     */
    public static function filenameToType($filename)
    {
Scott committed
3498
        // In case the path is a URL, strip any query string before getting extension
Scott committed
3499
        $qpos = strpos($filename, '?');
Scott committed
3500
        if (false !== $qpos) {
Scott committed
3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520
            $filename = substr($filename, 0, $qpos);
        }
        $pathinfo = self::mb_pathinfo($filename);
        return self::_mime_types($pathinfo['extension']);
    }

    /**
     * Multi-byte-safe pathinfo replacement.
     * Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe.
     * Works similarly to the one in PHP >= 5.2.0
     * @link http://www.php.net/manual/en/function.pathinfo.php#107461
     * @param string $path A filename or path, does not need to exist as a file
     * @param integer|string $options Either a PATHINFO_* constant,
     *      or a string name to return only the specified piece, allows 'filename' to work on PHP < 5.2
     * @return string|array
     * @static
     */
    public static function mb_pathinfo($path, $options = null)
    {
        $ret = array('dirname' => '', 'basename' => '', 'extension' => '', 'filename' => '');
Scott committed
3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534
        $pathinfo = array();
        if (preg_match('%^(.*?)[\\\\/]*(([^/\\\\]*?)(\.([^\.\\\\/]+?)|))[\\\\/\.]*$%im', $path, $pathinfo)) {
            if (array_key_exists(1, $pathinfo)) {
                $ret['dirname'] = $pathinfo[1];
            }
            if (array_key_exists(2, $pathinfo)) {
                $ret['basename'] = $pathinfo[2];
            }
            if (array_key_exists(5, $pathinfo)) {
                $ret['extension'] = $pathinfo[5];
            }
            if (array_key_exists(3, $pathinfo)) {
                $ret['filename'] = $pathinfo[3];
            }
Scott committed
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555
        }
        switch ($options) {
            case PATHINFO_DIRNAME:
            case 'dirname':
                return $ret['dirname'];
            case PATHINFO_BASENAME:
            case 'basename':
                return $ret['basename'];
            case PATHINFO_EXTENSION:
            case 'extension':
                return $ret['extension'];
            case PATHINFO_FILENAME:
            case 'filename':
                return $ret['filename'];
            default:
                return $ret;
        }
    }

    /**
     * Set or reset instance properties.
Scott committed
3556 3557
     * You should avoid this function - it's more verbose, less efficient, more error-prone and
     * harder to debug than setting properties directly.
Scott committed
3558
     * Usage Example:
Scott committed
3559 3560 3561
     * `$mail->set('SMTPSecure', 'tls');`
     *   is the same as:
     * `$mail->SMTPSecure = 'tls';`
Scott committed
3562
     * @access public
Scott committed
3563 3564 3565 3566
     * @param string $name The property name to set
     * @param mixed $value The value to set the property to
     * @return boolean
     * @TODO Should this not be using the __set() magic function?
Scott committed
3567 3568 3569
     */
    public function set($name, $value = '')
    {
Scott committed
3570 3571 3572 3573 3574 3575
        if (property_exists($this, $name)) {
            $this->$name = $value;
            return true;
        } else {
            $this->setError($this->lang('variable_set') . $name);
            return false;
Scott committed
3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610
        }
    }

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

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

    /**
     * Set the public and private key files and password for S/MIME signing.
     * @access public
     * @param string $cert_filename
     * @param string $key_filename
     * @param string $key_pass Password for private key
Scott committed
3611
     * @param string $extracerts_filename Optional path to chain certificate
Scott committed
3612
     */
Scott committed
3613
    public function sign($cert_filename, $key_filename, $key_pass, $extracerts_filename = '')
Scott committed
3614 3615 3616 3617
    {
        $this->sign_cert_file = $cert_filename;
        $this->sign_key_file = $key_filename;
        $this->sign_key_pass = $key_pass;
Scott committed
3618
        $this->sign_extracerts_file = $extracerts_filename;
Scott committed
3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634
    }

    /**
     * Quoted-Printable-encode a DKIM header.
     * @access public
     * @param string $txt
     * @return string
     */
    public function DKIM_QP($txt)
    {
        $line = '';
        for ($i = 0; $i < strlen($txt); $i++) {
            $ord = ord($txt[$i]);
            if (((0x21 <= $ord) && ($ord <= 0x3A)) || $ord == 0x3C || ((0x3E <= $ord) && ($ord <= 0x7E))) {
                $line .= $txt[$i];
            } else {
Scott committed
3635
                $line .= '=' . sprintf('%02X', $ord);
Scott committed
3636 3637 3638 3639 3640 3641 3642 3643
            }
        }
        return $line;
    }

    /**
     * Generate a DKIM signature.
     * @access public
Scott committed
3644
     * @param string $signHeader
Scott committed
3645 3646 3647
     * @throws phpmailerException
     * @return string
     */
Scott committed
3648
    public function DKIM_Sign($signHeader)
Scott committed
3649 3650 3651
    {
        if (!defined('PKCS7_TEXT')) {
            if ($this->exceptions) {
Scott committed
3652
                throw new phpmailerException($this->lang('extension_missing') . 'openssl');
Scott committed
3653 3654 3655 3656 3657 3658 3659 3660 3661
            }
            return '';
        }
        $privKeyStr = file_get_contents($this->DKIM_private);
        if ($this->DKIM_passphrase != '') {
            $privKey = openssl_pkey_get_private($privKeyStr, $this->DKIM_passphrase);
        } else {
            $privKey = $privKeyStr;
        }
Scott committed
3662
        if (openssl_sign($signHeader, $signature, $privKey)) {
Scott committed
3663 3664 3665 3666 3667 3668 3669 3670
            return base64_encode($signature);
        }
        return '';
    }

    /**
     * Generate a DKIM canonicalization header.
     * @access public
Scott committed
3671
     * @param string $signHeader Header
Scott committed
3672 3673
     * @return string
     */
Scott committed
3674
    public function DKIM_HeaderC($signHeader)
Scott committed
3675
    {
Scott committed
3676 3677
        $signHeader = preg_replace('/\r\n\s+/', ' ', $signHeader);
        $lines = explode("\r\n", $signHeader);
Scott committed
3678
        foreach ($lines as $key => $line) {
Scott committed
3679
            list($heading, $value) = explode(':', $line, 2);
Scott committed
3680
            $heading = strtolower($heading);
Scott committed
3681 3682
            $value = preg_replace('/\s+/', ' ', $value); // Compress useless spaces
            $lines[$key] = $heading . ':' . trim($value); // Don't forget to remove WSP around the value
Scott committed
3683
        }
Scott committed
3684 3685
        $signHeader = implode("\r\n", $lines);
        return $signHeader;
Scott committed
3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735
    }

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

    /**
     * Create the DKIM header and body in a new message header.
     * @access public
     * @param string $headers_line Header lines
     * @param string $subject Subject
     * @param string $body Body
     * @return string
     */
    public function DKIM_Add($headers_line, $subject, $body)
    {
        $DKIMsignatureType = 'rsa-sha1'; // Signature & hash algorithms
        $DKIMcanonicalization = 'relaxed/simple'; // Canonicalization of header/body
        $DKIMquery = 'dns/txt'; // Query method
        $DKIMtime = time(); // Signature Timestamp = seconds since 00:00:00 - Jan 1, 1970 (UTC time zone)
        $subject_header = "Subject: $subject";
        $headers = explode($this->LE, $headers_line);
        $from_header = '';
        $to_header = '';
        $current = '';
        foreach ($headers as $header) {
            if (strpos($header, 'From:') === 0) {
                $from_header = $header;
                $current = 'from_header';
            } elseif (strpos($header, 'To:') === 0) {
                $to_header = $header;
                $current = 'to_header';
            } else {
Scott committed
3736 3737
                if (!empty($$current) && strpos($header, ' =?') === 0) {
                    $$current .= $header;
Scott committed
3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751
                } else {
                    $current = '';
                }
            }
        }
        $from = str_replace('|', '=7C', $this->DKIM_QP($from_header));
        $to = str_replace('|', '=7C', $this->DKIM_QP($to_header));
        $subject = str_replace(
            '|',
            '=7C',
            $this->DKIM_QP($subject_header)
        ); // Copied header fields (dkim-quoted-printable)
        $body = $this->DKIM_BodyC($body);
        $DKIMlen = strlen($body); // Length of body
Scott committed
3752 3753 3754 3755 3756 3757 3758 3759 3760 3761
        $DKIMb64 = base64_encode(pack('H*', sha1($body))); // Base64 of packed binary SHA-1 hash of body
        if ('' == $this->DKIM_identity) {
            $ident = '';
        } else {
            $ident = ' i=' . $this->DKIM_identity . ';';
        }
        $dkimhdrs = 'DKIM-Signature: v=1; a=' .
            $DKIMsignatureType . '; q=' .
            $DKIMquery . '; l=' .
            $DKIMlen . '; s=' .
Scott committed
3762 3763
            $this->DKIM_selector .
            ";\r\n" .
Scott committed
3764
            "\tt=" . $DKIMtime . '; c=' . $DKIMcanonicalization . ";\r\n" .
Scott committed
3765
            "\th=From:To:Subject;\r\n" .
Scott committed
3766
            "\td=" . $this->DKIM_domain . ';' . $ident . "\r\n" .
Scott committed
3767 3768 3769 3770 3771 3772
            "\tz=$from\r\n" .
            "\t|$to\r\n" .
            "\t|$subject;\r\n" .
            "\tbh=" . $DKIMb64 . ";\r\n" .
            "\tb=";
        $toSign = $this->DKIM_HeaderC(
Scott committed
3773 3774 3775 3776
            $from_header . "\r\n" .
            $to_header . "\r\n" .
            $subject_header . "\r\n" .
            $dkimhdrs
Scott committed
3777 3778 3779 3780 3781
        );
        $signed = $this->DKIM_Sign($toSign);
        return $dkimhdrs . $signed . "\r\n";
    }

Scott committed
3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793
    /**
     * Detect if a string contains a line longer than the maximum line length allowed.
     * @param string $str
     * @return boolean
     * @static
     */
    public static function hasLineLongerThanMax($str)
    {
        //+2 to include CRLF line break for a 1000 total
        return (boolean)preg_match('/^(.{'.(self::MAX_LINE_LENGTH + 2).',})/m', $str);
    }

Scott committed
3794 3795
    /**
     * Allows for public read access to 'to' property.
Scott committed
3796
     * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
Scott committed
3797 3798 3799 3800 3801 3802 3803 3804 3805 3806
     * @access public
     * @return array
     */
    public function getToAddresses()
    {
        return $this->to;
    }

    /**
     * Allows for public read access to 'cc' property.
Scott committed
3807
     * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
Scott committed
3808 3809 3810 3811 3812 3813 3814 3815 3816 3817
     * @access public
     * @return array
     */
    public function getCcAddresses()
    {
        return $this->cc;
    }

    /**
     * Allows for public read access to 'bcc' property.
Scott committed
3818
     * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
Scott committed
3819 3820 3821 3822 3823 3824 3825 3826 3827 3828
     * @access public
     * @return array
     */
    public function getBccAddresses()
    {
        return $this->bcc;
    }

    /**
     * Allows for public read access to 'ReplyTo' property.
Scott committed
3829
     * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
Scott committed
3830 3831 3832 3833 3834 3835 3836 3837 3838 3839
     * @access public
     * @return array
     */
    public function getReplyToAddresses()
    {
        return $this->ReplyTo;
    }

    /**
     * Allows for public read access to 'all_recipients' property.
Scott committed
3840
     * @note: Before the send() call, queued addresses (i.e. with IDN) are not yet included.
Scott committed
3841 3842 3843 3844 3845 3846 3847 3848 3849 3850
     * @access public
     * @return array
     */
    public function getAllRecipientAddresses()
    {
        return $this->all_recipients;
    }

    /**
     * Perform a callback.
Scott committed
3851 3852 3853 3854
     * @param boolean $isSent
     * @param array $to
     * @param array $cc
     * @param array $bcc
Scott committed
3855 3856 3857 3858
     * @param string $subject
     * @param string $body
     * @param string $from
     */
Scott committed
3859
    protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from)
Scott committed
3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883
    {
        if (!empty($this->action_function) && is_callable($this->action_function)) {
            $params = array($isSent, $to, $cc, $bcc, $subject, $body, $from);
            call_user_func_array($this->action_function, $params);
        }
    }
}

/**
 * PHPMailer exception handler
 * @package PHPMailer
 */
class phpmailerException extends Exception
{
    /**
     * Prettify error message output
     * @return string
     */
    public function errorMessage()
    {
        $errorMsg = '<strong>' . $this->getMessage() . "</strong><br />\n";
        return $errorMsg;
    }
}