PHPMailer::smtpConnect( array $options = null ): 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

$optionsarrayoptional

An array of options compatible with stream_context_create()Default: null

Return value

bool

Performance profile

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

60–179

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

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 7

• \PHPMailer\PHPMailer\PHPMailer::getSMTPInstance()
• \PHPMailer\PHPMailer\PHPMailer::edebug()
• \PHPMailer\PHPMailer\PHPMailer::lang()
• static::isValidHost()
• \PHPMailer\PHPMailer\Exception::__construct()
• \PHPMailer\PHPMailer\PHPMailer::serverHostname()
• \PHPMailer\PHPMailer\PHPMailer::getSmtpErrorMessage()

Source code

View on Trac ↗View on GitHub ↗

2324    public function smtpConnect($options = null)2325    {2326        if (null === $this->smtp) {2327            $this->smtp = $this->getSMTPInstance();2328        }2329 2330        //If no options are provided, use whatever is set in the instance2331        if (null === $options) {2332            $options = $this->SMTPOptions;2333        }2334 2335        //Already connected?2336        if ($this->smtp->connected()) {2337            return true;2338        }2339 2340        $this->smtp->setTimeout($this->Timeout);2341        $this->smtp->setDebugLevel($this->SMTPDebug);2342        $this->smtp->setDebugOutput($this->Debugoutput);2343        $this->smtp->setVerp($this->do_verp);2344        $this->smtp->setSMTPUTF8($this->UseSMTPUTF8);2345        if ($this->Host === null) {2346            $this->Host = 'localhost';2347        }2348        $hosts = explode(';', $this->Host);2349        $lastexception = null;2350 2351        foreach ($hosts as $hostentry) {2352            $hostinfo = [];2353            if (2354                !preg_match(2355                    '/^(?:(ssl|tls):\/\/)?(.+?)(?::(\d+))?$/',2356                    trim($hostentry),2357                    $hostinfo2358                )2359            ) {2360                $this->edebug(self::lang('invalid_hostentry') . ' ' . trim($hostentry));2361                //Not a valid host entry2362                continue;2363            }2364            //$hostinfo[1]: optional ssl or tls prefix2365            //$hostinfo[2]: the hostname2366            //$hostinfo[3]: optional port number2367            //The host string prefix can temporarily override the current setting for SMTPSecure2368            //If it's not specified, the default value is used2369 2370            //Check the host name is a valid name or IP address before trying to use it2371            if (!static::isValidHost($hostinfo[2])) {2372                $this->edebug(self::lang('invalid_host') . ' ' . $hostinfo[2]);2373                continue;2374            }2375            $prefix = '';2376            $secure = $this->SMTPSecure;2377            $tls = (static::ENCRYPTION_STARTTLS === $this->SMTPSecure);2378            if ('ssl' === $hostinfo[1] || ('' === $hostinfo[1] && static::ENCRYPTION_SMTPS === $this->SMTPSecure)) {2379                $prefix = 'ssl://';2380                $tls = false; //Can't have SSL and TLS at the same time2381                $secure = static::ENCRYPTION_SMTPS;2382            } elseif ('tls' === $hostinfo[1]) {2383                $tls = true;2384                //TLS doesn't use a prefix2385                $secure = static::ENCRYPTION_STARTTLS;2386            }2387            //Do we need the OpenSSL extension?2388            $sslext = defined('OPENSSL_ALGO_SHA256');2389            if (static::ENCRYPTION_STARTTLS === $secure || static::ENCRYPTION_SMTPS === $secure) {2390                //Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled2391                if (!$sslext) {2392                    throw new Exception(self::lang('extension_missing') . 'openssl', self::STOP_CRITICAL);2393                }2394            }2395            $host = $hostinfo[2];2396            $port = $this->Port;2397            if (2398                array_key_exists(3, $hostinfo) &&2399                is_numeric($hostinfo[3]) &&2400                $hostinfo[3] > 0 &&2401                $hostinfo[3] < 655362402            ) {2403                $port = (int) $hostinfo[3];

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.