Zend_Mail_Protocol_Pop3 Class Reference

Public Member Functions
	__construct ($host='', $port=null, $ssl=false)
	__destruct ()
	connect ($host, $port=null, $ssl=false)
	sendRequest ($request)
	readResponse ($multiline=false)
	request ($request, $multiline=false)
	logout ()
	capa ()
	login ($user, $password, $tryApop=true)
	status (&$messages, &$octets)
	getList ($msgno=null)
	uniqueid ($msgno=null)
	top ($msgno, $lines=0, $fallback=false)
	retrive ($msgno)
	retrieve ($msgno)
	noop ()
	delete ($msgno)
	undelete ()

Data Fields
const	TIMEOUT_CONNECTION = 30
	$hasTop = null

Protected Attributes
	$_socket
	$_timestamp

Detailed Description

Definition at line 31 of file Pop3.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$host = '',
			$port = null,
			$ssl = false
	)

Public constructor

Parameters

string	$host	hostname or IP address of POP3 server, if given connect() is called
int | null	$port	port of POP3 server, null for default (110 or 995 for ssl)
bool | string	$ssl	use ssl? 'SSL', 'TLS' or false

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 65 of file Pop3.php.

    {
        if ($host) {
            $this->connect($host, $port, $ssl);
        }
    }

__destruct()

__destruct

(

)

Public destructor

Definition at line 76 of file Pop3.php.

    {
        $this->logout();
    }

Member Function Documentation

capa()

capa

(

)

Get capabilities from POP3 server

Returns

array list of capabilities

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 255 of file Pop3.php.

    {
        $result = $this->request('CAPA', true);
        return explode("\n", $result);
    }

connect()

connect	(		$host,
			$port = null,
			$ssl = false
	)

Open connection to POP3 server

Parameters

string	$host	hostname or IP address of POP3 server
int | null	$port	of POP3 server, default is 110 (995 for ssl)
string | bool	$ssl	use 'SSL', 'TLS' or false

Returns

string welcome message

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Definition at line 91 of file Pop3.php.

    {
        if ($ssl == 'SSL') {
            $host = 'ssl://' . $host;
        }

        if ($port === null) {
            $port = $ssl == 'SSL' ? 995 : 110;
        }

        $errno  =  0;
        $errstr = '';
        $this->_socket = @fsockopen($host, $port, $errno, $errstr, self::TIMEOUT_CONNECTION);
        if (!$this->_socket) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('cannot connect to host; error = ' . $errstr .
                                                   ' (errno = ' . $errno . ' )');
        }

        $welcome = $this->readResponse();

        strtok($welcome, '<');
        $this->_timestamp = strtok('>');
        if (!strpos($this->_timestamp, '@')) {
            $this->_timestamp = null;
        } else {
            $this->_timestamp = '<' . $this->_timestamp . '>';
        }

        if ($ssl === 'TLS') {
            $this->request('STLS');
            // TODO: Add STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT in the future when it is supported by PHP
            $result = stream_socket_enable_crypto($this->_socket, true, STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT);
            if (!$result) {
                #require_once 'Zend/Mail/Protocol/Exception.php';
                throw new Zend_Mail_Protocol_Exception('cannot enable TLS');
            }
        }

        return $welcome;
    }

delete()

delete

(

$msgno

)

Make a DELE count to remove a message

Returns

null

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 457 of file Pop3.php.

    {
        $this->request("DELE $msgno");
    }

getList()

getList

(

$msgno = null

)

Make LIST call for size of message(s)

Parameters

int | null

$msgno

number of message, null for all

Returns

int|array size of given message or list with array(num => size)

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 312 of file Pop3.php.

    {
        if ($msgno !== null) {
            $result = $this->request("LIST $msgno");

            list(, $result) = explode(' ', $result);
            return (int)$result;
        }

        $result = $this->request('LIST', true);
        $messages = array();
        $line = strtok($result, "\n");
        while ($line) {
            list($no, $size) = explode(' ', trim($line));
            $messages[(int)$no] = (int)$size;
            $line = strtok("\n");
        }

        return $messages;
    }

login()

login	(		$user,
			$password,
			$tryApop = true
	)

Login to POP3 server. Can use APOP

Parameters

string	$user	username
string	$password	password
bool	$try_apop	should APOP be tried?

Returns

void

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 271 of file Pop3.php.

    {
        if ($tryApop && $this->_timestamp) {
            try {
                $this->request("APOP $user " . md5($this->_timestamp . $password));
                return;
            } catch (Zend_Mail_Protocol_Exception $e) {
                // ignore
            }
        }

        $result = $this->request("USER $user");
        $result = $this->request("PASS $password");
    }

logout()

logout

(

)

End communication with POP3 server (also closes socket)

Returns

null

Definition at line 232 of file Pop3.php.

    {
        if (!$this->_socket) {
            return;
        }

        try {
            $this->request('QUIT');
        } catch (Zend_Mail_Protocol_Exception $e) {
            // ignore error - we're closing the socket anyway
        }

        fclose($this->_socket);
        $this->_socket = null;
    }

noop()

noop

(

)

Make a NOOP call, maybe needed for keeping the server happy

Returns

null

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 445 of file Pop3.php.

    {
        $this->request('NOOP');
    }

readResponse()

readResponse

(

$multiline = false

)

read a response

Parameters

boolean

$multiline

response has multiple lines and should be read until "<nl>.<nl>"

Returns

string response

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Definition at line 167 of file Pop3.php.

    {
        $result = @fgets($this->_socket);
        if (!is_string($result)) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('read failed - connection closed?');
        }

        $result = trim($result);
        if (strpos($result, ' ')) {
            list($status, $message) = explode(' ', $result, 2);
        } else {
            $status = $result;
            $message = '';
        }

        if ($status != '+OK') {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('last request failed');
        }

        if ($multiline) {
            $message = '';
            $line = fgets($this->_socket);
            while ($line && rtrim($line, "\r\n") != '.') {
                if ($line[0] == '.') {
                    $line = substr($line, 1);
                }
                $message .= $line;
                $line = fgets($this->_socket);
            };
        }

        return $message;
    }

request()

request	(		$request,
			$multiline = false
	)

Send request and get resposne

See also

sendRequest(), readResponse()

Parameters

string	$request	request
bool	$multiline	multiline response?

Returns

string result from readResponse()

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 220 of file Pop3.php.

    {
        $this->sendRequest($request);
        return $this->readResponse($multiline);
    }

retrieve()

retrieve

(

$msgno

)

Make a RETR call for retrieving a full message with headers and body

Parameters

int

$msgno

message number

Returns

string message

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 433 of file Pop3.php.

    {
        $result = $this->request("RETR $msgno", true);
        return $result;
    }

retrive()

retrive

(

$msgno

)

Make a RETR call for retrieving a full message with headers and body

Deprecated:

since 1.1.0; this method has a typo - please use retrieve()

Parameters

int

$msgno

message number

Returns

string message

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 420 of file Pop3.php.

    {
        return $this->retrieve($msgno);
    }

sendRequest()

sendRequest

(

$request

)

Send a request

Parameters

string

$request

your request without newline

Returns

null

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Definition at line 147 of file Pop3.php.

    {
        $result = @fputs($this->_socket, $request . "\r\n");
        if (!$result) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('send failed - connection closed?');
        }
    }

status()

status	(	&	$messages,
		&	$octets
	)

Make STAT call for message count and size sum

Parameters

int	$messages	out parameter with count of messages
int	$octets	out parameter with size in octects of messages

Returns

void

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 295 of file Pop3.php.

    {
        $messages = 0;
        $octets = 0;
        $result = $this->request('STAT');

        list($messages, $octets) = explode(' ', $result);
    }

top()

top	(		$msgno,
			$lines = 0,
			$fallback = false
	)

Make TOP call for getting headers and maybe some body lines This method also sets hasTop - before it it's not known if top is supported

The fallback makes normale RETR call, which retrieves the whole message. Additional lines are not removed.

Parameters

int	$msgno	number of message
int	$lines	number of wanted body lines (empty line is inserted after header lines)
bool	$fallback	fallback with full retrieve if top is not supported

Returns

string message headers with wanted body lines

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Definition at line 380 of file Pop3.php.

    {
        if ($this->hasTop === false) {
            if ($fallback) {
                return $this->retrieve($msgno);
            } else {
                #require_once 'Zend/Mail/Protocol/Exception.php';
                throw new Zend_Mail_Protocol_Exception('top not supported and no fallback wanted');
            }
        }
        $this->hasTop = true;

        $lines = (!$lines || $lines < 1) ? 0 : (int)$lines;

        try {
            $result = $this->request("TOP $msgno $lines", true);
        } catch (Zend_Mail_Protocol_Exception $e) {
            $this->hasTop = false;
            if ($fallback) {
                $result = $this->retrieve($msgno);
            } else {
                throw $e;
            }
        }

        return $result;
    }

undelete()

undelete

(

)

Make RSET call, which rollbacks delete requests

Returns

null

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 469 of file Pop3.php.

    {
        $this->request('RSET');
    }

uniqueid()

uniqueid

(

$msgno = null

)

Make UIDL call for getting a uniqueid

Parameters

int | null

$msgno

number of message, null for all

Returns

string|array uniqueid of message or list with array(num => uniqueid)

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 341 of file Pop3.php.

    {
        if ($msgno !== null) {
            $result = $this->request("UIDL $msgno");

            list(, $result) = explode(' ', $result);
            return $result;
        }

        $result = $this->request('UIDL', true);

        $result = explode("\n", $result);
        $messages = array();
        foreach ($result as $line) {
            if (!$line) {
                continue;
            }
            list($no, $id) = explode(' ', trim($line), 2);
            $messages[(int)$no] = $id;
        }

        return $messages;

    }

Field Documentation

$_socket

$_socket

protected

Definition at line 48 of file Pop3.php.

$_timestamp

$_timestamp

protected

Definition at line 54 of file Pop3.php.

$hasTop

$hasTop = null

Definition at line 42 of file Pop3.php.

TIMEOUT_CONNECTION

const TIMEOUT_CONNECTION = 30

Default timeout in seconds for initiating session

Definition at line 36 of file Pop3.php.

---

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

• vendor/magento/zendframework1/library/Zend/Mail/Protocol/Pop3.php