b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (0.9.x) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Class: POP3

Source Location: /blogs/b2evocore/_class_pop3.php

Class POP3

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 48]

[ Top ]
mixed   $BANNER = '' [line 42]

[ Top ]
mixed   $BUFFER = 512 [line 29]

[ Top ]
mixed   $COUNT = -1 [line 27]

[ Top ]
mixed   $DEBUG = false [line 38]

[ Top ]
mixed   $ERROR = '' [line 22]

[ Top ]
mixed   $FP = '' [line 33]

[ Top ]
mixed   $MAILSERVER = '' [line 36]

[ Top ]
mixed   $RFC1939 = true [line 45]

[ Top ]
mixed   $TIMEOUT = 60 [line 24]

[ Top ]
Methods
Constructor POP3  [line 56]

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

Constructor

Parameters:
   $server: 
   $timeout: 


[ Top ]
apop  [line 206]

  void apop( $login, $pass  )

Parameters:
   $login: 
   $pass: 


[ Top ]
connect  [line 98]

  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 631]

  void delete( [ $msgNum = '']  )

Parameters:
   $msgNum: 


[ Top ]
get  [line 397]

  void get( $msgNum  )

Parameters:
   $msgNum: 


[ Top ]
is_ok  [line 658]

  void is_ok( [ $cmd = '']  )

Parameters:
   $cmd: 


[ Top ]
last  [line 434]

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

Parameters:
   $type: 


[ Top ]
login  [line 256]

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

Parameters:
   $login: 
   $pass: 


[ Top ]
noop  [line 142]

  void noop( )



[ Top ]
parse_banner  [line 679]

  void parse_banner( $server_text  )

Parameters:
   $server_text: 


[ Top ]
pass  [line 175]

  void pass( [ $pass = '']  )

Parameters:
   $pass: 


[ Top ]
popstat  [line 546]

  void popstat( )



[ Top ]
pop_list  [line 322]

  void pop_list( [ $msgNum = '']  )

Parameters:
   $msgNum: 


[ Top ]
quit  [line 526]

  void quit( )



[ Top ]
reset  [line 465]

  void reset( )



[ Top ]
send_cmd  [line 489]

  void send_cmd( [ $cmd = '']  )

Parameters:
   $cmd: 


[ Top ]
strip_clf  [line 667]

  void strip_clf( [ $text = '']  )

Parameters:
   $text: 


[ Top ]
top  [line 280]

  void top( $msgNum, [ $numLines = '0']  )

Parameters:
   $msgNum: 
   $numLines: 


[ Top ]
uidl  [line 561]

  void uidl( [ $msgNum = '']  )

Parameters:
   $msgNum: 


[ Top ]
update_timer  [line 80]

  void update_timer( )

sets/refreshes script timeout



[ Top ]
user  [line 158]

  true user( [ $user = '']  )

Sends the USER command

Parameters:
   $user: 

API Tags:
Return:  or false


[ Top ]

Documentation generated on Tue, 20 May 2008 01:53:26 +0200 by phpDocumentor 1.4.2