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

Description

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::smtpSend() 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

26–96

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

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 · 42 distinct outcomes

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

Uses · 6

• static::stripTrailingWSP()
• \PHPMailer\PHPMailer\PHPMailer::smtpConnect()
• \PHPMailer\PHPMailer\Exception::__construct()
• \PHPMailer\PHPMailer\PHPMailer::lang()
• \PHPMailer\PHPMailer\PHPMailer::setError()
• \PHPMailer\PHPMailer\PHPMailer::doCallback()

Source code

View on Trac ↗View on GitHub ↗

2231    protected function smtpSend($header, $body)2232    {2233        $header = static::stripTrailingWSP($header) . static::$LE . static::$LE;2234        $bad_rcpt = [];2235        if (!$this->smtpConnect($this->SMTPOptions)) {2236            throw new Exception(self::lang('smtp_connect_failed'), self::STOP_CRITICAL);2237        }2238        //If we have recipient addresses that need Unicode support,2239        //but the server doesn't support it, stop here2240        if ($this->UseSMTPUTF8 && !$this->smtp->getServerExt('SMTPUTF8')) {2241            throw new Exception(self::lang('no_smtputf8'), self::STOP_CRITICAL);2242        }2243        //Sender already validated in preSend()2244        if ('' === $this->Sender) {2245            $smtp_from = $this->From;2246        } else {2247            $smtp_from = $this->Sender;2248        }2249        if (count($this->SMTPXClient)) {2250            $this->smtp->xclient($this->SMTPXClient);2251        }2252        if (!$this->smtp->mail($smtp_from)) {2253            $this->setError(self::lang('from_failed') . $smtp_from . ' : ' . implode(',', $this->smtp->getError()));2254            throw new Exception($this->ErrorInfo, self::STOP_CRITICAL);2255        }2256 2257        $callbacks = [];2258        //Attempt to send to all recipients2259        foreach ([$this->to, $this->cc, $this->bcc] as $togroup) {2260            foreach ($togroup as $to) {2261                if (!$this->smtp->recipient($to[0], $this->dsn)) {2262                    $error = $this->smtp->getError();2263                    $bad_rcpt[] = ['to' => $to[0], 'error' => $error['detail']];2264                    $isSent = false;2265                } else {2266                    $isSent = true;2267                }2268 2269                $callbacks[] = ['issent' => $isSent, 'to' => $to[0], 'name' => $to[1]];2270            }2271        }2272 2273        //Only send the DATA command if we have viable recipients2274        if ((count($this->all_recipients) > count($bad_rcpt)) && !$this->smtp->data($header . $body)) {2275            throw new Exception(self::lang('data_not_accepted'), self::STOP_CRITICAL);2276        }2277 2278        $smtp_transaction_id = $this->smtp->getLastTransactionID();2279 2280        if ($this->SMTPKeepAlive) {2281            $this->smtp->reset();2282        } else {2283            $this->smtp->quit();2284            $this->smtp->close();2285        }2286 2287        foreach ($callbacks as $cb) {2288            $this->doCallback(2289                $cb['issent'],2290                [[$cb['to'], $cb['name']]],2291                [],2292                [],2293                $this->Subject,2294                $body,2295                $this->From,2296                ['smtp_transaction_id' => $smtp_transaction_id]2297            );2298        }2299 2300        //Create error message for any bad addresses2301        if (count($bad_rcpt) > 0) {2302            $errstr = '';2303            foreach ($bad_rcpt as $bad) {2304                $errstr .= $bad['to'] . ': ' . $bad['error'];2305            }2306            throw new Exception(self::lang('recipients_failed') . $errstr, self::STOP_CONTINUE);2307        }2308 2309        return true;2310    }

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.