Public Member Functions
	__construct ($host= '', $port=null, $ssl=false)
	Public constructor.

	__destruct ()
	Public destructor.

	connect ($host, $port=null, $ssl=false)
	Open connection to POP3 server.

	sendRequest ($request)
	Send a request.

	readResponse ($multiline=false)
	read a response

	request ($request, $multiline=false)
	Send request and get resposne.

	logout ()
	End communication with POP3 server (also closes socket)

	capa ()
	Get capabilities from POP3 server.

	login ($user, $password, $tryApop=true)
	Login to POP3 server.

	status (&$messages, &$octets)
	Make STAT call for message count and size sum.

	getList ($msgno=null)
	Make LIST call for size of message(s)

	uniqueid ($msgno=null)
	Make UIDL call for getting a uniqueid.

	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.

	retrive ($msgno)
	Make a RETR call for retrieving a full message with headers and body.

	retrieve ($msgno)
	Make a RETR call for retrieving a full message with headers and body.

	noop ()
	Make a NOOP call, maybe needed for keeping the server happy.

	delete ($msgno)
	Make a DELE count to remove a message.

	undelete ()
	Make RSET call, which rollbacks delete requests.

Public Attributes
const	TIMEOUT_CONNECTION = 30
	Default timeout in seconds for initiating session.

	$hasTop = null

Protected Attributes
	$_socket

	$_timestamp

Constructor & Destructor Documentation

__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

__destruct ( )

Public destructor.

Member Function Documentation

capa ( )

Get capabilities from POP3 server.

Returns: array list of capabilities

Exceptions

Zend_Mail_Protocol_Exception

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

delete ( $msgno )

Make a DELE count to remove a message.

Returns: null

Exceptions

Zend_Mail_Protocol_Exception

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

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

logout ( )

End communication with POP3 server (also closes socket)

Returns: null

noop ( )

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

Returns: null

Exceptions

Zend_Mail_Protocol_Exception

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

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

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

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

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

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

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