wppaste
WordPress

SMTP::getServerExt( string $name ): string|bool|null

Source
wp-includes/PHPMailer/SMTP.php:1298
Get metadata about the SMTP server from its HELO/EHLO response.

Description

The method works in three ways, dependent on argument value and current state:

  1. HELO/EHLO has not been sent - returns null and populates $this->error.
  2. HELO has been sent - $name == 'HELO': returns server name $name == 'EHLO': returns boolean false $name == any other string: returns null and populates $this->error
  3. EHLO has been sent - $name == 'HELO'|'EHLO': returns the server name $name == any other string: if extension $name exists, returns True or its options (e.g. AUTH mechanisms supported). Otherwise, returns False.

Compatibility

WordPress
core
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$namestring
Name of SMTP extension or 'HELO'|'EHLO'

Return value

string|bool|null

Performance profile

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

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

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

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

WhenInstructionsCalls it makes
always7–17->setError()
always9–14none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 28 instructions, 7–17 executed per call, 5 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

  • \PHPMailer\PHPMailer\SMTP::setError()

Source code

View on Trac View on GitHub 

    public function getServerExt($name)    {        if (!$this->server_caps) {            $this->setError('No HELO/EHLO was sent');             return null;        }         if (!array_key_exists($name, $this->server_caps)) {            if ('HELO' === $name) {                return $this->server_caps['EHLO'];            }            if ('EHLO' === $name || array_key_exists('EHLO', $this->server_caps)) {                return false;            }            $this->setError('HELO handshake was used; No information about server extensions available');             return null;        }         return $this->server_caps[$name];    }

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.