SMTP::getSMTPConnection( string $host, int $port = null, int $timeout = 30, array $options = [] ): false|resource

Compatibility

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

Parameters

$hoststring

SMTP server IP or host name

$portintoptional

The port number to connect toDefault: null

$timeoutintoptional

How long to wait for the connection to openDefault: 30

$optionsarrayoptional

An array of options for stream_context_create()Default: []

Return value

false|resource

Performance profile

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

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::getSMTPConnection() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

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

Source code

View on Trac ↗View on GitHub ↗

407    protected function getSMTPConnection($host, $port = null, $timeout = 30, $options = [])408    {409        static $streamok;410        //This is enabled by default since 5.0.0 but some providers disable it411        //Check this once and cache the result412        if (null === $streamok) {413            $streamok = function_exists('stream_socket_client');414        }415 416        $errno = 0;417        $errstr = '';418        if ($streamok) {419            $socket_context = stream_context_create($options);420            set_error_handler(function () {421                call_user_func_array([$this, 'errorHandler'], func_get_args());422            });423            $connection = stream_socket_client(424                $host . ':' . $port,425                $errno,426                $errstr,427                $timeout,428                STREAM_CLIENT_CONNECT,429                $socket_context430            );431        } else {432            //Fall back to fsockopen which should work in more places, but is missing some features433            $this->edebug(434                'Connection: stream_socket_client not available, falling back to fsockopen',435                self::DEBUG_CONNECTION436            );437            set_error_handler(function () {438                call_user_func_array([$this, 'errorHandler'], func_get_args());439            });440            $connection = fsockopen(441                $host,442                $port,443                $errno,444                $errstr,445                $timeout446            );447        }448        restore_error_handler();449 450        //Verify we connected properly451        if (!is_resource($connection)) {452            $this->setError(453                'Failed to connect to server',454                '',455                (string) $errno,456                $errstr457            );458            $this->edebug(459                'SMTP ERROR: ' . $this->error['error']460                . ": $errstr ($errno)",461                self::DEBUG_CLIENT462            );463 464            return false;465        }466 467        //SMTP server can take longer to respond, give longer timeout for first read468        //Windows does not have support for this timeout function469        if (strpos(PHP_OS, 'WIN') !== 0) {470            $max = (int)ini_get('max_execution_time');471            //Don't bother if unlimited, or if set_time_limit is disabled472            if (0 !== $max && $timeout > $max && strpos(ini_get('disable_functions'), 'set_time_limit') === false) {473                @set_time_limit($timeout);474            }475            stream_set_timeout($connection, $timeout, 0);476        }477 478        return $connection;479    }

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.