PHPMailer::preSend(): bool

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), 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

42–154

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

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 · 18 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.

Uses · 20

• stripos()
• static::setLE()
• \PHPMailer\PHPMailer\PHPMailer::lang()
• \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()
• \PHPMailer\PHPMailer\PHPMailer::createBody()
• \PHPMailer\PHPMailer\PHPMailer::createHeader()

Source code

View on Trac ↗View on GitHub ↗

1542    public function preSend()1543    {1544        if (1545            'smtp' === $this->Mailer1546            || ('mail' === $this->Mailer && (\PHP_VERSION_ID >= 80000 || stripos(PHP_OS, 'WIN') === 0))1547        ) {1548            //SMTP mandates RFC-compliant line endings1549            //and it's also used with mail() on Windows1550            static::setLE(self::CRLF);1551        } else {1552            //Maintain backward compatibility with legacy Linux command line mailers1553            static::setLE(PHP_EOL);1554        }1555        //Check for buggy PHP versions that add a header with an incorrect line break1556        if (1557            'mail' === $this->Mailer1558            && ((\PHP_VERSION_ID >= 70000 && \PHP_VERSION_ID < 70017)1559                || (\PHP_VERSION_ID >= 70100 && \PHP_VERSION_ID < 70103))1560            && ini_get('mail.add_x_header') === '1'1561            && stripos(PHP_OS, 'WIN') === 01562        ) {1563            trigger_error($this->lang('buggy_php'), E_USER_WARNING);1564        }1565 1566        try {1567            $this->error_count = 0; //Reset errors1568            $this->mailHeader = '';1569 1570            //Dequeue recipient and Reply-To addresses with IDN1571            foreach (array_merge($this->RecipientsQueue, $this->ReplyToQueue) as $params) {1572                $params[1] = $this->punyencodeAddress($params[1]);1573                call_user_func_array([$this, 'addAnAddress'], $params);1574            }1575            if (count($this->to) + count($this->cc) + count($this->bcc) < 1) {1576                throw new Exception($this->lang('provide_address'), self::STOP_CRITICAL);1577            }1578 1579            //Validate From, Sender, and ConfirmReadingTo addresses1580            foreach (['From', 'Sender', 'ConfirmReadingTo'] as $address_kind) {1581                if ($this->{$address_kind} === null) {1582                    $this->{$address_kind} = '';1583                    continue;1584                }1585                $this->{$address_kind} = trim($this->{$address_kind});1586                if (empty($this->{$address_kind})) {1587                    continue;1588                }1589                $this->{$address_kind} = $this->punyencodeAddress($this->{$address_kind});1590                if (!static::validateAddress($this->{$address_kind})) {1591                    $error_message = sprintf(1592                        '%s (%s): %s',1593                        $this->lang('invalid_address'),1594                        $address_kind,1595                        $this->{$address_kind}1596                    );1597                    $this->setError($error_message);1598                    $this->edebug($error_message);1599                    if ($this->exceptions) {1600                        throw new Exception($error_message);1601                    }1602 1603                    return false;1604                }1605            }1606 1607            //Set whether the message is multipart/alternative1608            if ($this->alternativeExists()) {1609                $this->ContentType = static::CONTENT_TYPE_MULTIPART_ALTERNATIVE;1610            }1611 1612            $this->setMessageType();1613            //Refuse to send an empty message unless we are specifically allowing it1614            if (!$this->AllowEmpty && empty($this->Body)) {1615                throw new Exception($this->lang('empty_message'), self::STOP_CRITICAL);1616            }1617 1618            //Trim subject consistently1619            $this->Subject = trim($this->Subject);1620            //Create body before headers in case body makes changes to headers (e.g. altering transfer encoding)1621            $this->MIMEHeader = '';

Changelog

Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.8.11 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.