PHPMailer::sendmailSend( string $header, string $body ): bool

Compatibility

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

Parameters

$headerstring

The message headers

$bodystring

The message body

Return value

bool

Performance profile

How much work a call to PHPMailer::sendmailSend() 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 fwrite().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

60–165

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

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 accessfwrite()called directly

What one call costs · 36 distinct outcomes

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

Uses · 8

• \PHPMailer\PHPMailer\PHPMailer::edebug()
• static::stripTrailingWSP()
• static::validateAddress()
• \PHPMailer\PHPMailer\PHPMailer::isShellSafe()
• \PHPMailer\PHPMailer\Exception::__construct()
• \PHPMailer\PHPMailer\PHPMailer::lang()
• static::parseAddresses()
• \PHPMailer\PHPMailer\PHPMailer::doCallback()

Source code

View on Trac ↗View on GitHub ↗

1726    protected function sendmailSend($header, $body)1727    {1728        if ($this->Mailer === 'qmail') {1729            $this->edebug('Sending with qmail');1730        } else {1731            $this->edebug('Sending with sendmail');1732        }1733        $header = static::stripTrailingWSP($header) . static::$LE . static::$LE;1734        //This sets the SMTP envelope sender which gets turned into a return-path header by the receiver1735        //A space after `-f` is optional, but there is a long history of its presence1736        //causing problems, so we don't use one1737        //Exim docs: https://www.exim.org/exim-html-current/doc/html/spec_html/ch-the_exim_command_line.html1738        //Sendmail docs: https://www.sendmail.org/~ca/email/man/sendmail.html1739        //Example problem: https://www.drupal.org/node/10579541740 1741        //PHP 5.6 workaround1742        $sendmail_from_value = ini_get('sendmail_from');1743        if (empty($this->Sender) && !empty($sendmail_from_value)) {1744            //PHP config has a sender address we can use1745            $this->Sender = ini_get('sendmail_from');1746        }1747        //CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped.1748        if (!empty($this->Sender) && static::validateAddress($this->Sender) && self::isShellSafe($this->Sender)) {1749            if ($this->Mailer === 'qmail') {1750                $sendmailFmt = '%s -f%s';1751            } else {1752                $sendmailFmt = '%s -oi -f%s -t';1753            }1754        } else {1755            //allow sendmail to choose a default envelope sender. It may1756            //seem preferable to force it to use the From header as with1757            //SMTP, but that introduces new problems (see1758            //<https://github.com/PHPMailer/PHPMailer/issues/2298>), and1759            //it has historically worked this way.1760            $sendmailFmt = '%s -oi -t';1761        }1762 1763        $sendmail = sprintf($sendmailFmt, escapeshellcmd($this->Sendmail), $this->Sender);1764        $this->edebug('Sendmail path: ' . $this->Sendmail);1765        $this->edebug('Sendmail command: ' . $sendmail);1766        $this->edebug('Envelope sender: ' . $this->Sender);1767        $this->edebug("Headers: {$header}");1768 1769        if ($this->SingleTo) {1770            foreach ($this->SingleToArray as $toAddr) {1771                $mail = @popen($sendmail, 'w');1772                if (!$mail) {1773                    throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);1774                }1775                $this->edebug("To: {$toAddr}");1776                fwrite($mail, 'To: ' . $toAddr . "\n");1777                fwrite($mail, $header);1778                fwrite($mail, $body);1779                $result = pclose($mail);1780                $addrinfo = static::parseAddresses($toAddr, true, $this->CharSet);1781                $this->doCallback(1782                    ($result === 0),1783                    [[$addrinfo['address'], $addrinfo['name']]],1784                    $this->cc,1785                    $this->bcc,1786                    $this->Subject,1787                    $body,1788                    $this->From,1789                    []1790                );1791                $this->edebug("Result: " . ($result === 0 ? 'true' : 'false'));1792                if (0 !== $result) {1793                    throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);1794                }1795            }1796        } else {1797            $mail = @popen($sendmail, 'w');1798            if (!$mail) {1799                throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);1800            }1801            fwrite($mail, $header);1802            fwrite($mail, $body);1803            $result = pclose($mail);1804            $this->doCallback(1805                ($result === 0),

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.7.10 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.