Collaboration diagram for POP3:

Public Member Functions
	authorise ($host, $port=false, $timeout=false, $username='', $password='', $debug_level=0)
	Authenticate with a POP3 server. More...

	connect ($host, $port=false, $tval=30)
	Connect to a POP3 server. More...

	login ($username='', $password='')
	Log in to the POP3 server. More...

	disconnect ()
	Disconnect from the POP3 server. More...

	getErrors ()
	Get an array of error messages, if any. More...

Static Public Member Functions
static	popBeforeSmtp ( $host, $port=false, $timeout=false, $username='', $password='', $debug_level=0)
	Simple static wrapper for all-in-one POP before SMTP. More...

Data Fields
	$Version = '5.2.22'

	$POP3_PORT = 110

	$POP3_TIMEOUT = 30

	$CRLF = "\r\n"

	$do_debug = 0

	$host

	$port

	$tval

	$username

	$password

const	CRLF = "\r\n"
	Line break constant. More...

Protected Member Functions
	getResponse ($size=128)
	Get a response from the POP3 server. More...

	sendString ($string)
	Send raw data to the POP3 server. More...

	checkResponse ($string)
	Checks the POP3 server response. More...

	setError ($error)
	Add an error to the internal error store. More...

	catchWarning ($errno, $errstr, $errfile, $errline)
	POP3 connection error handler. More...

Protected Attributes
	$pop_conn

	$connected = false

	$errors = array()

Detailed Description

Definition at line 30 of file class.pop3.php.

Member Function Documentation

◆ authorise()

POP3::authorise	(	$host,
		$port = `false`,
		$timeout = `false`,
		$username = `''`,
		$password = `''`,
		$debug_level = `0`
	)

Authenticate with a POP3 server.

A connect, login, disconnect sequence appropriate for POP-before SMTP authorisation. @access public

Parameters

string	$host	The hostname to connect to
integer \| boolean	$port	The port number to connect to
integer \| boolean	$timeout	The timeout value
string	$username
string	$password
integer	$debug_level

Returns: boolean

Definition at line 165 of file class.pop3.php.

    {
        $this->host = $host;
        // If no port value provided, use default
        if (false === $port) {
            $this->port = $this->POP3_PORT;
        } else {
            $this->port = (integer)$port;
        }
        // If no timeout value provided, use default
        if (false === $timeout) {
            $this->tval = $this->POP3_TIMEOUT;
        } else {
            $this->tval = (integer)$timeout;
        }
        $this->do_debug = $debug_level;
        $this->username = $username;
        $this->password = $password;
        //  Reset the error log
        $this->errors = array();
        //  connect
        $result = $this->connect($this->host, $this->port, $this->tval);
        if ($result) {
            $login_result = $this->login($this->username, $this->password);
            if ($login_result) {
                $this->disconnect();
                return true;
            }
        }
        // We need to disconnect regardless of whether the login succeeded
        $this->disconnect();
        return false;
    }

References $host, $password, $POP3_PORT, $POP3_TIMEOUT, $port, $result, $username, connect(), disconnect(), and login().

Referenced by popBeforeSmtp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ catchWarning()

POP3::catchWarning	(	$errno,
		$errstr,
		$errfile,
		$errline
	)

protected

POP3 connection error handler.

Parameters

integer	$errno
string	$errstr
string	$errfile
integer	$errline	@access protected

Definition at line 397 of file class.pop3.php.

    {
        $this->setError(array(
            'error' => "Connecting to the POP3 server raised a PHP warning: ",
            'errno' => $errno,
            'errstr' => $errstr,
            'errfile' => $errfile,
            'errline' => $errline
        ));
    }

References setError().

Here is the call graph for this function:

◆ checkResponse()

POP3::checkResponse ( $string )

protected

Checks the POP3 server response.

Looks for for +OK or -ERR.

Parameters

string $string

Returns: boolean @access protected

Definition at line 348 of file class.pop3.php.

    {
        if (substr($string, 0, 3) !== '+OK') {
            $this->setError(array(
                'error' => "Server reported an error: $string",
                'errno' => 0,
                'errstr' => ''
            ));
            return false;
        } else {
            return true;
        }
    }

References setError().

Referenced by connect(), and login().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connect()

POP3::connect	(	$host,
		$port = `false`,
		$tval = `30`
	)

Connect to a POP3 server.

@access public

Parameters

string	$host
integer \| boolean	$port
integer	$tval

Returns: boolean

Definition at line 207 of file class.pop3.php.

    {
        //  Are we already connected?
        if ($this->connected) {
            return true;
        }
 
        //On Windows this will raise a PHP Warning error if the hostname doesn't exist.
        //Rather than suppress it with @fsockopen, capture it cleanly instead
        set_error_handler(array($this, 'catchWarning'));
 
        if (false === $port) {
            $port = $this->POP3_PORT;
        }
 
        //  connect to the POP3 server
        $this->pop_conn = fsockopen(
            $host, //  POP3 Host
            $port, //  Port #
            $errno, //  Error Number
            $errstr, //  Error Message
            $tval
        ); //  Timeout (seconds)
        //  Restore the error handler
        restore_error_handler();
 
        //  Did we connect?
        if (false === $this->pop_conn) {
            //  It would appear not...
            $this->setError(array(
                'error' => "Failed to connect to server $host on port $port",
                'errno' => $errno,
                'errstr' => $errstr
            ));
            return false;
        }
 
        //  Increase the stream time-out
        stream_set_timeout($this->pop_conn, $tval, 0);
 
        //  Get the POP3 server response
        $pop3_response = $this->getResponse();
        //  Check for the +OK
        if ($this->checkResponse($pop3_response)) {
            //  The connection is established and the POP3 server is talking
            $this->connected = true;
            return true;
        }
        return false;
    }

References $host, $POP3_PORT, $port, $tval, checkResponse(), getResponse(), and setError().

Referenced by authorise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disconnect()

POP3::disconnect ( )

Disconnect from the POP3 server.

@access public

Definition at line 296 of file class.pop3.php.

    {
        $this->sendString('QUIT');
        //The QUIT command may cause the daemon to exit, which will kill our connection
        //So ignore errors here
        try {
            @fclose($this->pop_conn);
        } catch (Exception $e) {
            //Do nothing
        };
    }

References sendString().

Referenced by authorise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getErrors()

POP3::getErrors ( )

Get an array of error messages, if any.

Returns: array

Definition at line 384 of file class.pop3.php.

    {
        return $this->errors;
    }

References $errors.

◆ getResponse()

POP3::getResponse ( $size = 128 )

protected

Get a response from the POP3 server.

$size is the maximum number of bytes to retrieve

Parameters

integer $size

Returns: string @access protected

Definition at line 315 of file class.pop3.php.

    {
        $response = fgets($this->pop_conn, $size);
        if ($this->do_debug >= 1) {
            echo "Server -> Client: $response";
        }
        return $response;
    }

References $size.

Referenced by connect(), and login().

Here is the caller graph for this function:

◆ login()

POP3::login	(	$username = `''`,
		$password = `''`
	)

Log in to the POP3 server.

Does not support APOP (RFC 2828, 4949). @access public

Parameters

string	$username
string	$password

Returns: boolean

Definition at line 266 of file class.pop3.php.

    {
        if (!$this->connected) {
            $this->setError('Not connected to POP3 server');
        }
        if (empty($username)) {
            $username = $this->username;
        }
        if (empty($password)) {
            $password = $this->password;
        }
 
        // Send the Username
        $this->sendString("USER $username" . self::CRLF);
        $pop3_response = $this->getResponse();
        if ($this->checkResponse($pop3_response)) {
            // Send the Password
            $this->sendString("PASS $password" . self::CRLF);
            $pop3_response = $this->getResponse();
            if ($this->checkResponse($pop3_response)) {
                return true;
            }
        }
        return false;
    }

References $password, $username, checkResponse(), getResponse(), sendString(), and setError().

Referenced by authorise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popBeforeSmtp()

static POP3::popBeforeSmtp	(	$host,
		$port = `false`,
		$timeout = `false`,
		$username = `''`,
		$password = `''`,
		$debug_level = `0`
	)

static

Simple static wrapper for all-in-one POP before SMTP.

Parameters

	$host
integer \| boolean	$port	The port number to connect to
integer \| boolean	$timeout	The timeout value
string	$username
string	$password
integer	$debug_level

Returns: boolean

Definition at line 140 of file class.pop3.php.

      {
        $pop = new POP3;
        return $pop->authorise($host, $port, $timeout, $username, $password, $debug_level);
    }

References $host, $password, $port, $username, and authorise().

Here is the call graph for this function:

◆ sendString()

POP3::sendString ( $string )

protected

Send raw data to the POP3 server.

Parameters

string $string

Returns: integer @access protected

Definition at line 330 of file class.pop3.php.

    {
        if ($this->pop_conn) {
            if ($this->do_debug >= 2) { //Show client messages when debug >= 2
                echo "Client -> Server: $string";
            }
            return fwrite($this->pop_conn, $string, strlen($string));
        }
        return 0;
    }

Referenced by disconnect(), and login().

Here is the caller graph for this function:

◆ setError()

POP3::setError ( $error )

protected

Add an error to the internal error store.

Also display debug output if it's enabled.

Parameters

$error @access protected

Definition at line 368 of file class.pop3.php.

    {
        $this->errors[] = $error;
        if ($this->do_debug >= 1) {
            echo '<pre>';
            foreach ($this->errors as $error) {
                print_r($error);
            }
            echo '</pre>';
        }
    }

Referenced by catchWarning(), checkResponse(), connect(), and login().

Here is the caller graph for this function:

Field Documentation

◆ $connected

POP3::$connected = false

protected

Definition at line 116 of file class.pop3.php.

◆ $CRLF

POP3::$CRLF = "\r\n"

Definition at line 59 of file class.pop3.php.

◆ $do_debug

POP3::$do_debug = 0

Definition at line 67 of file class.pop3.php.

◆ $errors

POP3::$errors = array()

protected

Definition at line 123 of file class.pop3.php.

Referenced by getErrors().

◆ $host

POP3::$host

Definition at line 74 of file class.pop3.php.

Referenced by authorise(), connect(), and popBeforeSmtp().

◆ $password

POP3::$password

Definition at line 102 of file class.pop3.php.

Referenced by authorise(), login(), and popBeforeSmtp().

◆ $POP3_PORT

POP3::$POP3_PORT = 110

Definition at line 44 of file class.pop3.php.

Referenced by authorise(), and connect().

◆ $POP3_TIMEOUT

POP3::$POP3_TIMEOUT = 30

Definition at line 51 of file class.pop3.php.

Referenced by authorise().

◆ $pop_conn

POP3::$pop_conn

protected

Definition at line 109 of file class.pop3.php.

◆ $port

POP3::$port

Definition at line 81 of file class.pop3.php.

Referenced by authorise(), connect(), and popBeforeSmtp().

◆ $tval

POP3::$tval

Definition at line 88 of file class.pop3.php.

Referenced by connect().

◆ $username

POP3::$username

Definition at line 95 of file class.pop3.php.

Referenced by authorise(), login(), and popBeforeSmtp().

◆ $Version

POP3::$Version = '5.2.22'

Definition at line 37 of file class.pop3.php.

◆ CRLF

const POP3::CRLF = "\r\n"

Line break constant.

Definition at line 128 of file class.pop3.php.

The documentation for this class was generated from the following file:

Services/Mail/phpmailer/class.pop3.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ authorise()

◆ catchWarning()

◆ checkResponse()

◆ connect()

◆ disconnect()

◆ getErrors()

◆ getResponse()

◆ login()

◆ popBeforeSmtp()

◆ sendString()

◆ setError()

Field Documentation

◆ $connected

◆ $CRLF

◆ $do_debug

◆ $errors

◆ $host

◆ $password

◆ $POP3_PORT

◆ $POP3_TIMEOUT

◆ $pop_conn

◆ $port

◆ $tval

◆ $username

◆ $Version

◆ CRLF