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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), 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::mailSend() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

40–111

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

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 one call costs · 48 distinct outcomes

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

Uses · 9

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

Source code

View on Trac ↗View on GitHub ↗

2084    protected function mailSend($header, $body)2085    {2086        $header = static::stripTrailingWSP($header) . static::$LE . static::$LE;2087 2088        $toArr = [];2089        foreach ($this->to as $toaddr) {2090            $toArr[] = $this->addrFormat($toaddr);2091        }2092        $to = trim(implode(', ', $toArr));2093 2094        //If there are no To-addresses (e.g. when sending only to BCC-addresses)2095        //the following should be added to get a correct DKIM-signature.2096        //Compare with $this->preSend()2097        if ($to === '') {2098            $to = 'undisclosed-recipients:;';2099        }2100 2101        $params = null;2102        //This sets the SMTP envelope sender which gets turned into a return-path header by the receiver2103        //A space after `-f` is optional, but there is a long history of its presence2104        //causing problems, so we don't use one2105        //Exim docs: https://www.exim.org/exim-html-current/doc/html/spec_html/ch-the_exim_command_line.html2106        //Sendmail docs: https://www.sendmail.org/~ca/email/man/sendmail.html2107        //Example problem: https://www.drupal.org/node/10579542108        //CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped.2109 2110        //PHP 5.6 workaround2111        $sendmail_from_value = ini_get('sendmail_from');2112        if (empty($this->Sender) && !empty($sendmail_from_value)) {2113            //PHP config has a sender address we can use2114            $this->Sender = ini_get('sendmail_from');2115        }2116        if (!empty($this->Sender) && static::validateAddress($this->Sender)) {2117            $phpmailer_path = ini_get('sendmail_path');2118            if (self::isShellSafe($this->Sender) && strpos($phpmailer_path, ' -f') === false) {2119                $params = sprintf('-f%s', $this->Sender);2120            }2121            $old_from = ini_get('sendmail_from');2122            ini_set('sendmail_from', $this->Sender);2123        }2124        $result = false;2125        if ($this->SingleTo && count($toArr) > 1) {2126            foreach ($toArr as $toAddr) {2127                $result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params);2128                $addrinfo = static::parseAddresses($toAddr, null, $this->CharSet);2129                foreach ($addrinfo as $addr) {2130                    $this->doCallback(2131                        $result,2132                        [[$addr['address'], $addr['name']]],2133                        $this->cc,2134                        $this->bcc,2135                        $this->Subject,2136                        $body,2137                        $this->From,2138                        []2139                    );2140                }2141            }2142        } else {2143            $result = $this->mailPassthru($to, $this->Subject, $body, $header, $params);2144            $this->doCallback($result, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From, []);2145        }2146        if (isset($old_from)) {2147            ini_set('sendmail_from', $old_from);2148        }2149        if (!$result) {2150            throw new Exception(self::lang('instantiate'), self::STOP_CRITICAL);2151        }2152 2153        return true;2154    }

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.