wppaste
WordPress

PHPMailer::addOrEnqueueAnAddress( string $kind, string $address, string $name ): bool

Source
wp-includes/PHPMailer/PHPMailer.php:1142
Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still be modified after calling this function), addition of such addresses is delayed until send().

Description

Addresses that have been added already return false, but do not throw exceptions.

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

$kindstring
One of 'to', 'cc', 'bcc', or 'Reply-To'
$addressstring
The email address
$namestring
An optional username associated with the address

Return value

bool
true on success, false if address already used or invalid in some way

Performance profile

How much work a call to PHPMailer::addOrEnqueueAnAddress() 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
25–45

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

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

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

WhenInstructionsCalls it makes
$address === null && $pos !== false && ->has8bitChars()25–39->has8bitChars(), ::idnSupported()
$address === null && $pos === false25–28::lang(), ->setError(), ->edebug()
$address === null && $pos !== false && !->has8bitChars()29–35->has8bitChars(), call_user_func_array()
$address !== null && $pos !== false && ->has8bitChars()31–45strrpos(), ->has8bitChars(), ::idnSupported()
$address !== null && $pos === false31–34strrpos(), ::lang(), ->setError(), ->edebug()
$address !== null && $pos !== false && !->has8bitChars()35–41strrpos(), ->has8bitChars(), call_user_func_array()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev8325–4510
8.58325–4510
8.48325–451012 fewer instructions than PHP 8.3
8.39527–5510
8.29527–5510
8.19527–55101 more instruction than PHP 7.4
7.49427–5510

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 · 6

  • \PHPMailer\PHPMailer\PHPMailer::lang()
  • \PHPMailer\PHPMailer\PHPMailer::setError()
  • \PHPMailer\PHPMailer\PHPMailer::edebug()
  • \PHPMailer\PHPMailer\Exception::__construct()
  • \PHPMailer\PHPMailer\PHPMailer::has8bitChars()
  • static::idnSupported()

Source code

View on Trac View on GitHub 

    protected function addOrEnqueueAnAddress($kind, $address, $name)    {        $pos = false;        if ($address !== null) {            $address = trim($address);            $pos = strrpos($address, '@');        }        if (false === $pos) {            //At-sign is missing.            $error_message = sprintf(                '%s (%s): %s',                self::lang('invalid_address'),                $kind,                $address            );            $this->setError($error_message);            $this->edebug($error_message);            if ($this->exceptions) {                throw new Exception($error_message);            }             return false;        }        if ($name !== null && is_string($name)) {            $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim        } else {            $name = '';        }        $params = [$kind, $address, $name];        //Enqueue addresses with IDN until we know the PHPMailer::$CharSet.        //Domain is assumed to be whatever is after the last @ symbol in the address        if ($this->has8bitChars(substr($address, ++$pos))) {            if (static::idnSupported()) {                if ('Reply-To' !== $kind) {                    if (!array_key_exists($address, $this->RecipientsQueue)) {                        $this->RecipientsQueue[$address] = $params;                         return true;                    }                } elseif (!array_key_exists($address, $this->ReplyToQueue)) {                    $this->ReplyToQueue[$address] = $params;                     return true;                }            }            //We have an 8-bit domain, but we are missing the necessary extensions to support it            //Or we are already sending to this address            return false;        }         //Immediately add standard addresses without IDN.        return call_user_func_array([$this, 'addAnAddress'], $params);    }

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.