PHPMailer::preSend(): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

Performance profile

How much work a call to PHPMailer::preSend() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

49–186

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 292.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• filesystemfilesystem accessfile_exists()called directly

What one call costs · 90 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost PHPMailer::preSend() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 22

• stripos()
• static::setLE()
• \PHPMailer\PHPMailer\PHPMailer::lang()
• \PHPMailer\PHPMailer\PHPMailer::anyAddressHasUnicodeLocalPart()
• \PHPMailer\PHPMailer\PHPMailer::addressHasUnicodeLocalPart()
• \PHPMailer\PHPMailer\PHPMailer::punyencodeAddress()
• \PHPMailer\PHPMailer\Exception::__construct()
• static::validateAddress()
• \PHPMailer\PHPMailer\PHPMailer::setError()
• \PHPMailer\PHPMailer\PHPMailer::edebug()
• \PHPMailer\PHPMailer\PHPMailer::alternativeExists()
• \PHPMailer\PHPMailer\PHPMailer::setMessageType()

Source code

View on Trac ↗View on GitHub ↗

1689    public function preSend()1690    {1691        if (1692            'smtp' === $this->Mailer1693            || ('mail' === $this->Mailer && (\PHP_VERSION_ID >= 80000 || stripos(PHP_OS, 'WIN') === 0))1694        ) {1695            //SMTP mandates RFC-compliant line endings1696            //and it's also used with mail() on Windows1697            static::setLE(self::CRLF);1698        } else {1699            //Maintain backward compatibility with legacy Linux command line mailers1700            static::setLE(PHP_EOL);1701        }1702        //Check for buggy PHP versions that add a header with an incorrect line break1703        if (1704            'mail' === $this->Mailer1705            && ((\PHP_VERSION_ID >= 70000 && \PHP_VERSION_ID < 70017)1706                || (\PHP_VERSION_ID >= 70100 && \PHP_VERSION_ID < 70103))1707            && ini_get('mail.add_x_header') === '1'1708            && stripos(PHP_OS, 'WIN') === 01709        ) {1710            trigger_error(self::lang('buggy_php'), E_USER_WARNING);1711        }1712 1713        try {1714            $this->error_count = 0; //Reset errors1715            $this->mailHeader = '';1716 1717            //The code below tries to support full use of Unicode,1718            //while remaining compatible with legacy SMTP servers to1719            //the greatest degree possible: If the message uses1720            //Unicode in the local parts of any addresses, it is sent1721            //using SMTPUTF8. If not, it it sent using1722            //punycode-encoded domains and plain SMTP.1723            if (1724                static::CHARSET_UTF8 === strtolower($this->CharSet) &&1725                ($this->anyAddressHasUnicodeLocalPart($this->RecipientsQueue) ||1726                 $this->anyAddressHasUnicodeLocalPart(array_keys($this->all_recipients)) ||1727                 $this->anyAddressHasUnicodeLocalPart($this->ReplyToQueue) ||1728                 $this->addressHasUnicodeLocalPart($this->From))1729            ) {1730                $this->UseSMTPUTF8 = true;1731            }1732            //Dequeue recipient and Reply-To addresses with IDN1733            foreach (array_merge($this->RecipientsQueue, $this->ReplyToQueue) as $params) {1734                if (!$this->UseSMTPUTF8) {1735                    $params[1] = $this->punyencodeAddress($params[1]);1736                }1737                call_user_func_array([$this, 'addAnAddress'], $params);1738            }1739            if (count($this->to) + count($this->cc) + count($this->bcc) < 1) {1740                throw new Exception(self::lang('provide_address'), self::STOP_CRITICAL);1741            }1742 1743            //Validate From, Sender, and ConfirmReadingTo addresses1744            foreach (['From', 'Sender', 'ConfirmReadingTo'] as $address_kind) {1745                if ($this->{$address_kind} === null) {1746                    $this->{$address_kind} = '';1747                    continue;1748                }1749                $this->{$address_kind} = trim($this->{$address_kind});1750                if (empty($this->{$address_kind})) {1751                    continue;1752                }1753                $this->{$address_kind} = $this->punyencodeAddress($this->{$address_kind});1754                if (!static::validateAddress($this->{$address_kind})) {1755                    $error_message = sprintf(1756                        '%s (%s): %s',1757                        self::lang('invalid_address'),1758                        $address_kind,1759                        $this->{$address_kind}1760                    );1761                    $this->setError($error_message);1762                    $this->edebug($error_message);1763                    if ($this->exceptions) {1764                        throw new Exception($error_message);1765                    }1766 1767                    return false;1768                }

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/PHPMailer/PHPMailer.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.