SMTP::get_lines(): string

Description

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

string

Performance profile

How much work a call to SMTP::get_lines() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9

Executed per call on PHP 8.5. The body compiles to 163.

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 · 1 distinct outcome

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

Uses · 4

• stripos()
• \PHPMailer\PHPMailer\SMTP::getError()
• \PHPMailer\PHPMailer\SMTP::edebug()
• \PHPMailer\PHPMailer\SMTP::setError()

Source code

View on Trac ↗View on GitHub ↗

1340    protected function get_lines()1341    {1342        //If the connection is bad, give up straight away1343        if (!is_resource($this->smtp_conn)) {1344            return '';1345        }1346        $data = '';1347        $endtime = 0;1348        stream_set_timeout($this->smtp_conn, $this->Timeout);1349        if ($this->Timelimit > 0) {1350            $endtime = time() + $this->Timelimit;1351        }1352        $selR = [$this->smtp_conn];1353        $selW = null;1354        while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {1355            //Must pass vars in here as params are by reference1356            //solution for signals inspired by https://github.com/symfony/symfony/pull/65401357            set_error_handler(function () {1358                call_user_func_array([$this, 'errorHandler'], func_get_args());1359            });1360            $n = stream_select($selR, $selW, $selW, $this->Timelimit);1361            restore_error_handler();1362 1363            if ($n === false) {1364                $message = $this->getError()['detail'];1365 1366                $this->edebug(1367                    'SMTP -> get_lines(): select failed (' . $message . ')',1368                    self::DEBUG_LOWLEVEL1369                );1370 1371                //stream_select returns false when the `select` system call is interrupted1372                //by an incoming signal, try the select again1373                if (1374                    stripos($message, 'interrupted system call') !== false ||1375                    (1376                        // on applications with a different locale than english, the message above is not found because1377                        // it's translated. So we also check for the SOCKET_EINTR constant which is defined under1378                        // Windows and UNIX-like platforms (if available on the platform).1379                        defined('SOCKET_EINTR') &&1380                        stripos($message, 'stream_select(): Unable to select [' . SOCKET_EINTR . ']') !== false1381                    )1382                ) {1383                    $this->edebug(1384                        'SMTP -> get_lines(): retrying stream_select',1385                        self::DEBUG_LOWLEVEL1386                    );1387                    $this->setError('');1388                    continue;1389                }1390 1391                break;1392            }1393 1394            if (!$n) {1395                $this->edebug(1396                    'SMTP -> get_lines(): select timed-out in (' . $this->Timelimit . ' sec)',1397                    self::DEBUG_LOWLEVEL1398                );1399                break;1400            }1401 1402            //Deliberate noise suppression - errors are handled afterwards1403            $str = @fgets($this->smtp_conn, self::MAX_REPLY_LENGTH);1404            $this->edebug('SMTP INBOUND: "' . trim($str) . '"', self::DEBUG_LOWLEVEL);1405            $data .= $str;1406            //If response is only 3 chars (not valid, but RFC5321 S4.2 says it must be handled),1407            //or 4th character is a space or a line break char, we are done reading, break the loop.1408            //String array access is a significant micro-optimisation over strlen1409            if (!isset($str[3]) || $str[3] === ' ' || $str[3] === "\r" || $str[3] === "\n") {1410                break;1411            }1412            //Timed-out? Log and break1413            $info = stream_get_meta_data($this->smtp_conn);1414            if ($info['timed_out']) {1415                $this->edebug(1416                    'SMTP -> get_lines(): stream timed-out (' . $this->Timeout . ' sec)',1417                    self::DEBUG_LOWLEVEL1418                );1419                break;

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/SMTP.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.