SMTP::authenticate( string $username, string $password, string $authtype = null, PHPMailer\PHPMailer\OAuthTokenProvider $OAuth = 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

$usernamestring

The user name

$passwordstring

The password

$authtypestringoptional

The auth type (CRAM-MD5, PLAIN, LOGIN, XOAUTH2)Default: null

$OAuthPHPMailer\PHPMailer\OAuthTokenProvideroptional

An optional OAuthTokenProvider instance for XOAUTH2 authenticationDefault: null

Return value

bool

True if successfully authenticated

Performance profile

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

10–111

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

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

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

Uses · 5

• \PHPMailer\PHPMailer\SMTP::setError()
• \PHPMailer\PHPMailer\SMTP::edebug()
• \PHPMailer\PHPMailer\SMTP::sendCommand()
• \PHPMailer\PHPMailer\SMTP::hmac()
• \PHPMailer\PHPMailer\Exception::__construct()

Source code

View on Trac ↗View on GitHub ↗

531    public function authenticate(532        $username,533        $password,534        $authtype = null,535        $OAuth = null536    ) {537        if (!$this->server_caps) {538            $this->setError('Authentication is not allowed before HELO/EHLO');539 540            return false;541        }542 543        if (array_key_exists('EHLO', $this->server_caps)) {544            //SMTP extensions are available; try to find a proper authentication method545            if (!array_key_exists('AUTH', $this->server_caps)) {546                $this->setError('Authentication is not allowed at this stage');547                //'at this stage' means that auth may be allowed after the stage changes548                //e.g. after STARTTLS549 550                return false;551            }552 553            $this->edebug('Auth method requested: ' . ($authtype ?: 'UNSPECIFIED'), self::DEBUG_LOWLEVEL);554            $this->edebug(555                'Auth methods available on the server: ' . implode(',', $this->server_caps['AUTH']),556                self::DEBUG_LOWLEVEL557            );558 559            //If we have requested a specific auth type, check the server supports it before trying others560            if (null !== $authtype && !in_array($authtype, $this->server_caps['AUTH'], true)) {561                $this->edebug('Requested auth method not available: ' . $authtype, self::DEBUG_LOWLEVEL);562                $authtype = null;563            }564 565            if (empty($authtype)) {566                //If no auth mechanism is specified, attempt to use these, in this order567                //Try CRAM-MD5 first as it's more secure than the others568                foreach (['CRAM-MD5', 'LOGIN', 'PLAIN', 'XOAUTH2'] as $method) {569                    if (in_array($method, $this->server_caps['AUTH'], true)) {570                        $authtype = $method;571                        break;572                    }573                }574                if (empty($authtype)) {575                    $this->setError('No supported authentication methods found');576 577                    return false;578                }579                $this->edebug('Auth method selected: ' . $authtype, self::DEBUG_LOWLEVEL);580            }581 582            if (!in_array($authtype, $this->server_caps['AUTH'], true)) {583                $this->setError("The requested authentication method \"$authtype\" is not supported by the server");584 585                return false;586            }587        } elseif (empty($authtype)) {588            $authtype = 'LOGIN';589        }590        switch ($authtype) {591            case 'PLAIN':592                //Start authentication593                if (!$this->sendCommand('AUTH', 'AUTH PLAIN', 334)) {594                    return false;595                }596                //Send encoded username and password597                if (598                    //Format from https://www.rfc-editor.org/rfc/rfc4616#section-2599                    //We skip the first field (it's forgery), so the string starts with a null byte600                    !$this->sendCommand(601                        'User & Password',602                        base64_encode("\0" . $username . "\0" . $password),603                        235604                    )605                ) {606                    return false;607                }608                break;609            case 'LOGIN':610                //Start authentication

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.