Class Zend_Mail_Transport_Pop3

Description

Located in /Mail/Transport/Pop3.php (line 31)


	
			
Variable Summary
 mixed $hasTop
Method Summary
 Zend_Mail_Transport_Pop3 __construct ([string $host = ''], [int $port = null], [bool $ssl = false])
 void __destruct ()
 array capa ()
 string connect (string $host, [int $port = null], [string $ssl = false])
 void delete ( $msgno)
 int|array getList ([int $msgno = null])
 void login (string $user, string $password, [ $tryApop = true], bool $try_apop)
 void logout ()
 void noop ()
 string readResponse ([boolean $multiline = false])
 string request (string $request, [bool $multiline = false])
 string retrive (int $msgno)
 void sendRequest (string $request)
 void status ( &$messages,  &$octets, int $messages, int $octets)
 string top (int $msgno, [int $lines = 0], [bool $fallback = false])
 void undelete ()
 string|array uniqueid ([int $msgno = null])
Variables
mixed $hasTop = null (line 36)

saves if server supports top

  • access: public
Methods
Constructor __construct (line 56)

Public constructor

  • access: public
Zend_Mail_Transport_Pop3 __construct ([string $host = ''], [int $port = null], [bool $ssl = false])
  • string $host: hostname of IP address of POP3 server, if given connect() is called
  • int $port: port of POP3 server, default is 110 (995 for ssl)
  • bool $ssl: use ssl?
Destructor __destruct (line 67)

Public destructor

  • access: public
void __destruct ()
capa (line 213)

Get capabilities from POP3 server

  • return: list of capabilities
  • access: public
array capa ()
connect (line 82)

Open connection to POP3 server

  • return: welcome message
  • access: public
  • throws: Zend_Mail_Transport_Exception
string connect (string $host, [int $port = null], [string $ssl = false])
  • string $host: hostname of IP address of POP3 server
  • int $port: of POP3 server, default is 110 (995 for ssl)
  • string $ssl: use 'SSL' or 'TLS'
delete (line 387)

Make a DELE count to remove a message

  • access: public
void delete ( $msgno)
  • $msgno
getList (line 267)

Make LIST call for size of message(s)

  • return: size of given message or list with array(num => size)
  • access: public
int|array getList ([int $msgno = null])
  • int $msgno: number of message
login (line 228)

Login to POP3 server. Can use APOP

  • access: public
void login (string $user, string $password, [ $tryApop = true], bool $try_apop)
  • string $user: username
  • string $password: password
  • bool $try_apop: should APOP be tried?
  • $tryApop
logout (line 191)

End communication with POP3 server (also closes socket)

  • access: public
void logout ()
noop (line 378)

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

  • access: public
void noop ()
readResponse (line 141)

read a response

  • return: response
  • access: public
  • throws: Zend_Mail_Transport_Exception
string readResponse ([boolean $multiline = false])
  • boolean $multiline: response has multiple lines and should be read until "<nl>.<nl>"
request (line 181)

Send request and get resposne

string request (string $request, [bool $multiline = false])
  • string $request: request
  • bool $multiline: multiline response?
retrive (line 368)

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

  • return: message
  • access: public
string retrive (int $msgno)
  • int $msgno: message number
sendRequest (line 124)

Send a request

  • access: public
void sendRequest (string $request)
  • string $request: your request without newline
status (line 251)

Make STAT call for message count and size sum

  • access: public
void status ( &$messages,  &$octets, int $messages, int $octets)
  • int $messages: out parameter with count of messages
  • int $octets: out parameter with size in octects of messages
  • &$messages
  • &$octets
top (line 330)

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.

  • return: message headers with wanted body lines
  • access: public
string top (int $msgno, int $lines, [bool $fallback = false])
  • 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
undelete (line 396)

Make RSET call, which rollbacks delete requests

  • access: public
void undelete ()
uniqueid (line 295)

Make UIDL call for getting a uniqueid

  • return: uniqueid of message or list with array(num => uniqueid)
  • access: public
string|array uniqueid ([int $msgno = null])
  • int $msgno: number of message

Documentation generated on Thu, 18 Jan 2007 10:01:10 -0800 by phpDocumentor 1.3.1