pop3 Class Reference
[POP3-Mail-Class]

List of all members.

Public Member Functions
	pop3 ()
	Class Constructor.
	_pop3 ()
	Class Destructor.
	pop3_close ()
	Close connection to pop3 server.
	pop3_connect ($host, $user_id="", $pwd="", $timeout=20)
	Connect to pop3 server.
	pop3_delete_mail ($id)
	Sends delete command to server.
	pop3_flush_errors ()
	Will flush the complete pop3 error buffer.
	pop3_flush_stream ()
	Will flush the complete pop3 stream.
	pop3_get_errorlist ()
	Returns error string array. After the call the function delete the error list.
	pop3_get_mail ($id)
	Return mail string.
	pop3_get_mail_key ($id)
	Return mail unique key.
	pop3_get_mail_keys ()
	Returns array with unique keys and mail ID`s.
	pop3_get_mail_info ($id)
	Return mail info string with mail ID and mail size.
	pop3_get_mailbox_info ()
	Returns mailbox info array with mail ID`s and mail size.
	pop3_get_mail_size ($id)
	Return size of an single mail.
	pop3_get_mail_stat ()
	Returns mailbox statistik. It includes number of mails in and size of all mails in the mailbox.
	pop3_get_stream ()
	Return pop3 stream string array.
	pop3_keepalive ()
	Keeps the connection open.
	pop3_get_data ($endsign="LINE")
	Return raw data from server and check if it is an error or not.
	pop3_send_cmd ($cmd)
	Send command to server.
	pop3_send_pass ()
	Sends password to server.
	pop3_send_quit ()
	Sends quit command to server.
	pop3_send_user ()
	Sends user to server.
	pop3_verify ($data)
	Answer string check. The function search for "+OK" or "-ERR".
Public Attributes
	$pop3_error_hdl = 0
	$pop3_host
	$pop3_password
	$pop3_user_id
	$pop3_socket_hdl = 0
	$pop3_socket_stream = array()
	$pop3_timeout

---

Constructor & Destructor Documentation

function pop3::pop3 (   )

Class Constructor.

---

Member Function Documentation

function pop3::_pop3 (   )

Class Destructor.

function pop3::pop3_close (   )

Close connection to pop3 server. Returns: State = true or false

function pop3::pop3_connect (  $  host, $  user_id = "", $  pwd = "", $  timeout = 20 )

Connect to pop3 server. Parameters: $host  = host adress or IP $user_id  = Login user name $pwd  = Login password $timeout  = Connection timeout Returns: State = true or false

function pop3::pop3_delete_mail (  $  id  )

Sends delete command to server. Parameters: $id  = Mail ID Returns: State = true or false

function pop3::pop3_flush_errors (   )

Will flush the complete pop3 error buffer. Returns: State = true or false

function pop3::pop3_flush_stream (   )

Will flush the complete pop3 stream. Returns: State = true or false

function pop3::pop3_get_data (  $  endsign = "LINE"  )

Return raw data from server and check if it is an error or not. Parameters: $endsign  = Look into fsocket_get_socketdata() function doc. Returns: Raw data from server

function pop3::pop3_get_errorlist (   )

Returns error string array. After the call the function delete the error list. Returns: Error string array

function pop3::pop3_get_mail (  $  id  )

Return mail string. Parameters: $id  = Mail ID Returns: Mail string

function pop3::pop3_get_mail_info (  $  id  )

Return mail info string with mail ID and mail size. Parameters: $id  = Mail ID Returns: Mail info string

function pop3::pop3_get_mail_key (  $  id  )

Return mail unique key. Parameters: $id  = Mail ID Returns: Mail unique key string

function pop3::pop3_get_mail_keys (   )

Returns array with unique keys and mail ID`s. Returns: Mail unique key array

function pop3::pop3_get_mail_size (  $  id  )

Return size of an single mail. Parameters: $id  = Mail ID Returns: Mail size

function pop3::pop3_get_mail_stat (   )

Returns mailbox statistik. It includes number of mails in and size of all mails in the mailbox. Returns: Mailstat info string

function pop3::pop3_get_mailbox_info (   )

Returns mailbox info array with mail ID`s and mail size. Returns: Mailbox info array

function pop3::pop3_get_stream (   )

Return pop3 stream string array. Returns: Socket stream string array

function pop3::pop3_keepalive (   )

Keeps the connection open. Returns: State = true or false

function pop3::pop3_send_cmd (  $  cmd  )

Send command to server. Parameters: $cmd  = Command to send Returns: State = true or false

function pop3::pop3_send_pass (   )

Sends password to server. Returns: State = true or false

function pop3::pop3_send_quit (   )

Sends quit command to server. Returns: State = true or false

function pop3::pop3_send_user (   )

Sends user to server. Returns: State = true or false

function pop3::pop3_verify (  $  data  )

Answer string check. The function search for "+OK" or "-ERR". Parameters: $data  = Data for checking return State = true or false

---

Member Data Documentation

pop3::$pop3_error_hdl = 0

Error message handler

pop3::$pop3_host

Host name or IP

pop3::$pop3_password

Connection password

pop3::$pop3_socket_hdl = 0

Socket handle

pop3::$pop3_socket_stream = array()

Socket stream data array

pop3::$pop3_timeout

Connection timeout

pop3::$pop3_user_id

Connection user name

---

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

• pop3.php

---