PHPMailer::parseAddresses( string $addrstr, bool $useimap = true, string $charset = self::CHARSET_ISO88591 ): array

Description

Compatibility

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

Parameters

$addrstrstring

The address list string

$useimapbooloptional

Whether to use the IMAP extension to parse the listDefault: true

$charsetstringoptional

The charset to use when decoding the address list string.Default: self::CHARSET_ISO88591

Return value

array

Performance profile

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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

13–20

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

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

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

Uses · 1

• static::validateAddress()

Source code

View on Trac ↗View on GitHub ↗

1222    public static function parseAddresses($addrstr, $useimap = true, $charset = self::CHARSET_ISO88591)1223    {1224        $addresses = [];1225        if ($useimap && function_exists('imap_rfc822_parse_adrlist')) {1226            //Use this built-in parser if it's available1227            $list = imap_rfc822_parse_adrlist($addrstr, '');1228            // Clear any potential IMAP errors to get rid of notices being thrown at end of script.1229            imap_errors();1230            foreach ($list as $address) {1231                if (1232                    '.SYNTAX-ERROR.' !== $address->host &&1233                    static::validateAddress($address->mailbox . '@' . $address->host)1234                ) {1235                    //Decode the name part if it's present and encoded1236                    if (1237                        property_exists($address, 'personal') &&1238                        //Check for a Mbstring constant rather than using extension_loaded, which is sometimes disabled1239                        defined('MB_CASE_UPPER') &&1240                        preg_match('/^=\?.*\?=$/s', $address->personal)1241                    ) {1242                        $origCharset = mb_internal_encoding();1243                        mb_internal_encoding($charset);1244                        //Undo any RFC2047-encoded spaces-as-underscores1245                        $address->personal = str_replace('_', '=20', $address->personal);1246                        //Decode the name1247                        $address->personal = mb_decode_mimeheader($address->personal);1248                        mb_internal_encoding($origCharset);1249                    }1250 1251                    $addresses[] = [1252                        'name' => (property_exists($address, 'personal') ? $address->personal : ''),1253                        'address' => $address->mailbox . '@' . $address->host,1254                    ];1255                }1256            }1257        } else {1258            //Use this simpler parser1259            $list = explode(',', $addrstr);1260            foreach ($list as $address) {1261                $address = trim($address);1262                //Is there a separate name part?1263                if (strpos($address, '<') === false) {1264                    //No separate name, just use the whole thing1265                    if (static::validateAddress($address)) {1266                        $addresses[] = [1267                            'name' => '',1268                            'address' => $address,1269                        ];1270                    }1271                } else {1272                    list($name, $email) = explode('<', $address);1273                    $email = trim(str_replace('>', '', $email));1274                    $name = trim($name);1275                    if (static::validateAddress($email)) {1276                        //Check for a Mbstring constant rather than using extension_loaded, which is sometimes disabled1277                        //If this name is encoded, decode it1278                        if (defined('MB_CASE_UPPER') && preg_match('/^=\?.*\?=$/s', $name)) {1279                            $origCharset = mb_internal_encoding();1280                            mb_internal_encoding($charset);1281                            //Undo any RFC2047-encoded spaces-as-underscores1282                            $name = str_replace('_', '=20', $name);1283                            //Decode the name1284                            $name = mb_decode_mimeheader($name);1285                            mb_internal_encoding($origCharset);1286                        }1287                        $addresses[] = [1288                            //Remove any surrounding quotes and spaces from the name1289                            'name' => trim($name, '\'" '),1290                            'address' => $email,1291                        ];1292                    }1293                }1294            }1295        }1296 1297        return $addresses;1298    }

Changelog

2 changes between 6.7.10 and 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.11 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.