POP3::apop( $login, $pass )

Compatibility

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

Parameters

$login

$pass

Performance profile

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

11–49

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

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

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

Uses · 5

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

Source code

View on Trac ↗View on GitHub ↗

169    function apop ($login,$pass) {170        //  Attempts an APOP login. If this fails, it'll171        //  try a standard login. YOUR SERVER MUST SUPPORT172        //  THE USE OF THE APOP COMMAND!173        //  (apop is optional per rfc1939)174 175        if(!isset($this->FP)) {176            $this->ERROR = "POP3 apop: " . _("No connection to server");177            return false;178        } elseif(!$this->ALLOWAPOP) {179            $retVal = $this->login($login,$pass);180            return $retVal;181        } elseif(empty($login)) {182            $this->ERROR = "POP3 apop: " . _("No login ID submitted");183            return false;184        } elseif(empty($pass)) {185            $this->ERROR = "POP3 apop: " . _("No password submitted");186            return false;187        } else {188            $banner = $this->BANNER;189            if( (!$banner) or (empty($banner)) ) {190                $this->ERROR = "POP3 apop: " . _("No server banner") . ' - ' . _("abort");191                $retVal = $this->login($login,$pass);192                return $retVal;193            } else {194                $AuthString = $banner;195                $AuthString .= $pass;196                $APOPString = md5($AuthString);197                $cmd = "APOP $login $APOPString";198                $reply = $this->send_cmd($cmd);199                if(!$this->is_ok($reply)) {200                    $this->ERROR = "POP3 apop: " . _("apop authentication failed") . ' - ' . _("abort");201                    $retVal = $this->login($login,$pass);202                    return $retVal;203                } else {204                    //  Auth successful.205                    $count = $this->last("count");206                    $this->COUNT = $count;207                    return $count;208                }209            }210        }211    }

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 6.9.7 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.