POP3::uidl( $msgNum = "" )

Compatibility

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

Parameters

$msgNumoptional

Default: ""

Performance profile

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

Heavy

Reads or writes the filesystem via fwrite().

Scaling

Scales with input

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

Instructions

10–56

Executed per call on PHP 8.4, depending on the branch taken. The body compiles to 129.

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 it touches

• regexregular expression over the whole inputpreg_split()called directly
• filesystemfilesystem accessfwrite()called directly

What one call costs · 8 distinct outcomes

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

Uses · 5

• _()Compat function to mimic _(), an alias of gettext().
• POP3::send_cmd()
• POP3::is_ok()
• POP3::update_timer()
• POP3::strip_clf()

Source code

View on Trac ↗View on GitHub ↗

519    function uidl ($msgNum = "")520    {521        //  Returns the UIDL of the msg specified. If called with522        //  no arguments, returns an associative array where each523        //  undeleted msg num is a key, and the msg's uidl is the element524        //  Array element 0 will contain the total number of msgs525 526        if(!isset($this->FP)) {527            $this->ERROR = "POP3 uidl: " . _("No connection to server");528            return false;529        }530 531        $fp = $this->FP;532        $buffer = $this->BUFFER;533 534        if(!empty($msgNum)) {535            $cmd = "UIDL $msgNum";536            $reply = $this->send_cmd($cmd);537            if(!$this->is_ok($reply))538            {539                $this->ERROR = "POP3 uidl: " . _("Error ") . "[$reply]";540                return false;541            }542            list ($ok,$num,$myUidl) = preg_split('/\s+/',$reply);543            return $myUidl;544        } else {545            $this->update_timer();546 547            $UIDLArray = array();548            $Total = $this->COUNT;549            $UIDLArray[0] = $Total;550 551            if ($Total < 1)552            {553                return $UIDLArray;554            }555            $cmd = "UIDL";556            fwrite($fp, "UIDL\r\n");557            $reply = fgets($fp, $buffer);558            $reply = $this->strip_clf($reply);559            if($this->DEBUG) { @error_log("POP3 SEND [$cmd] GOT [$reply]",0); }560            if(!$this->is_ok($reply))561            {562                $this->ERROR = "POP3 uidl: " . _("Error ") . "[$reply]";563                return false;564            }565 566            $line = "";567            $count = 1;568            $line = fgets($fp,$buffer);569            while ( !preg_match('/^\.\r\n/',$line)) {570                list ($msg,$msgUidl) = preg_split('/\s+/',$line);571                $msgUidl = $this->strip_clf($msgUidl);572                if($count == $msg) {573                    $UIDLArray[$msg] = $msgUidl;574                }575                else576                {577                    $UIDLArray[$count] = 'deleted';578                }579                $count++;580                $line = fgets($fp,$buffer);581            }582        }583        return $UIDLArray;584    }

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.0.4 tag, from src/wp-includes/class-pop3.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.