Docs For Class POP3

Class Overview

An RFC 1939 compliant wrapper class for the POP3 protocol.

Located in /blogs/inc/_misc/ext/_pop3.class.php [line 38]

Property Summary

mixed	$ALLOWAPOP
mixed	$BANNER
mixed	$BUFFER
mixed	$COUNT
mixed	$DEBUG
mixed	$ERROR
mixed	$FP
mixed	$MAILSERVER
mixed	$RFC1939
mixed	$TIMEOUT

[ Top ]

Method Summary

POP3	POP3()	Constructor
void	apop()
true	connect()	Opens a socket to the specified server. Unless overridden, port defaults to 110.
void	delete()
void	get()
void	is_ok()
void	last()
void	login()
void	noop()
void	parse_banner()
void	pass()
void	popstat()
void	pop_list()
void	quit()
void	reset()
void	send_cmd()
void	strip_clf()
void	top()
void	uidl()
void	update_timer()	sets/refreshes script timeout
true	user()	Sends the USER command

[ Top ]

Properties

mixed $ALLOWAPOP = false [line 65]

[ Top ]

mixed $BANNER = '' [line 59]

[ Top ]

mixed $BUFFER = 512 [line 46]

[ Top ]

mixed $COUNT = -1 [line 44]

[ Top ]

mixed $DEBUG = false [line 55]

[ Top ]

mixed $ERROR = '' [line 39]

[ Top ]

mixed $FP = '' [line 50]

[ Top ]

mixed $MAILSERVER = '' [line 53]

[ Top ]

mixed $RFC1939 = true [line 62]

[ Top ]

mixed $TIMEOUT = 60 [line 41]

[ Top ]

Methods

Constructor POP3 [line 73]

POP3 POP3(
[
$server = ''], [
$timeout = ''] 
)

Constructor

Parameters:

	$server:
	$timeout:

[ Top ]

apop [line 234]

void apop(

$login, 
$pass 
)

Parameters:

	$login:
	$pass:

[ Top ]

connect [line 115]

true connect(
string
$server, [integer
$port = 110] 
)

Opens a socket to the specified server. Unless overridden, port defaults to 110.

Parameters:

string	$server:	server, overriden by MAILSERVER, if not empty
integer	$port:	port, default 110

API Tags:

Return:

on success, false on fail

[ Top ]

delete [line 659]

void delete(
[
$msgNum = ''] 
)

Parameters:

$msgNum:

[ Top ]

get [line 425]

void get(

$msgNum 
)

Parameters:

$msgNum:

[ Top ]

is_ok [line 686]

void is_ok(
[
$cmd = ''] 
)

Parameters:

$cmd:

[ Top ]

last [line 462]

void last(
[
$type = 'count'] 
)

Parameters:

$type:

[ Top ]

login [line 284]

void login(
[
$login = ''], [
$pass = ''] 
)

Parameters:

	$login:
	$pass:

[ Top ]

noop [line 170]

void noop(
)

[ Top ]

parse_banner [line 707]

void parse_banner(

$server_text 
)

Parameters:

$server_text:

[ Top ]

pass [line 203]

void pass(
[
$pass = ''] 
)

Parameters:

$pass:

[ Top ]

popstat [line 574]

void popstat(
)

[ Top ]

pop_list [line 350]

void pop_list(
[
$msgNum = ''] 
)

Parameters:

$msgNum:

[ Top ]

quit [line 554]

void quit(
)

[ Top ]

reset [line 493]

void reset(
)

[ Top ]

send_cmd [line 517]

void send_cmd(
[
$cmd = ''] 
)

Parameters:

$cmd:

[ Top ]

strip_clf [line 695]

void strip_clf(
[
$text = ''] 
)

Parameters:

$text:

[ Top ]

top [line 308]

void top(

$msgNum, [
$numLines = '0'] 
)

Parameters:

	$msgNum:
	$numLines:

[ Top ]

uidl [line 589]

void uidl(
[
$msgNum = ''] 
)

Parameters:

$msgNum:

[ Top ]

update_timer [line 97]

void update_timer(
)

sets/refreshes script timeout

[ Top ]

user [line 186]

true user(
[
$user = ''] 
)

Sends the USER command

Parameters:

$user:

API Tags:

Return:

or false

[ Top ]

Multilingual multiuser multiblog engine

Class: POP3

Class POP3

Packages

Classes

Files