phpDocumentor epesi-base
[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]

Class: Net_POP3

Source Location: /modules/Apps/MailClient/PEAR/Net/POP3.php

Class Net_POP3

Property Summary
array   $supportedAuthMethods   The auth methods this class support
array   $supportedSASLAuthMethods   The auth methods this class support
array   $_capability   The capability response
boolean   $_debug   To allow class debuging
mixed   $_host  
mixed   $_maildrop  
mixed   $_port  
mixed   $_socket  
mixed   $_state  
mixed   $_timeout  
mixed   $_timestamp  

[ Top ]
Method Summary
Net_POP3   Net_POP3()  
void   connect()  
void   deleteMsg()  
void   disconnect()  
void   getBody()  
void   getListing()  
void   getMsg()  
void   getParsedHeaders()  
void   getRawHeaders()  
void   getSize()  
void   login()  
void   numMsg()  
void   setDebug()   Sets the bebug state
void   _authCRAM_MD5()  
void   _authDigest_MD5()  
void   _authLOGIN()  
void   _authPLAIN()  
void   _authUSER()  
void   _cmdApop()  
void   _cmdAuthenticate()  
void   _cmdDele()  
void   _cmdList()  
void   _cmdNoop()  
void   _cmdPass()  
void   _cmdQuit()  
void   _cmdRetr()  
void   _cmdRset()  
void   _cmdStat()  
void   _cmdTop()  
void   _cmdUidl()  
void   _cmdUser()  
void   _getMultiline()  
void   _sendCmd()  

[ Top ]
Properties
array   $supportedAuthMethods = array( 'CRAM-MD5', 'APOP' , 'PLAIN' , 'LOGIN', 'USER') [line 124]

The auth methods this class support


[ Top ]
array   $supportedSASLAuthMethods = array('DIGEST-MD5', 'CRAM-MD5') [line 133]

The auth methods this class support


[ Top ]
array   $_capability [line 140]

The capability response


[ Top ]
boolean   $_debug = false [line 115]

To allow class debuging


[ Top ]
mixed   $_host [line 102]

[ Top ]
mixed   $_maildrop [line 66]

[ Top ]
mixed   $_port [line 109]

[ Top ]
mixed   $_socket [line 87]

[ Top ]
mixed   $_state [line 95]

[ Top ]
mixed   $_timeout [line 80]

[ Top ]
mixed   $_timestamp [line 73]

[ Top ]
Methods
Constructor Net_POP3  [line 149]

  Net_POP3 Net_POP3( )



[ Top ]
connect  [line 203]

  void connect( [ $host = 'localhost'], [ $port = 110]  )

Parameters:
   $host: 
   $port: 


[ Top ]
deleteMsg  [line 813]

  void deleteMsg( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
disconnect  [line 236]

  void disconnect( )



[ Top ]
getBody  [line 743]

  void getBody( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
getListing  [line 829]

  void getListing( [ $msg_id = null]  )

Parameters:
   $msg_id: 


[ Top ]
getMsg  [line 759]

  void getMsg( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
getParsedHeaders  [line 711]

  void getParsedHeaders( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
getRawHeaders  [line 692]

  void getRawHeaders( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
getSize  [line 773]

  void getSize( )



[ Top ]
login  [line 251]

  void login( $user, $pass, [ $apop = true]  )

Parameters:
   $user: 
   $pass: 
   $apop: 


[ Top ]
numMsg  [line 792]

  void numMsg( )



[ Top ]
setDebug  [line 1141]

  void setDebug( [bool $debug = true]  )

Sets the bebug state

Parameters:
bool   $debug: 

API Tags:
Access:  public


[ Top ]
_authCRAM_MD5  [line 548]

  void _authCRAM_MD5( $uid, $pwd  )

Parameters:
   $uid: 
   $pwd: 


[ Top ]
_authDigest_MD5  [line 594]

  void _authDigest_MD5( $uid, $pwd  )

Parameters:
   $uid: 
   $pwd: 


[ Top ]
_authLOGIN  [line 501]

  void _authLOGIN( $user, $pass  )

Parameters:
   $user: 
   $pass: 


[ Top ]
_authPLAIN  [line 472]

  void _authPLAIN( $user, $pass  )

Parameters:
   $user: 
   $pass: 


[ Top ]
_authUSER  [line 444]

  void _authUSER( $user, $pass  )

Parameters:
   $user: 
   $pass: 


[ Top ]
_cmdApop  [line 658]

  void _cmdApop( $user, $pass  )

Parameters:
   $user: 
   $pass: 


[ Top ]
_cmdAuthenticate  [line 390]

  void _cmdAuthenticate( $uid, $pwd, [ $userMethod = null]  )

Parameters:
   $uid: 
   $pwd: 
   $userMethod: 


[ Top ]
_cmdDele  [line 971]

  void _cmdDele( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
_cmdList  [line 914]

  void _cmdList( [ $msg_id = null]  )

Parameters:
   $msg_id: 


[ Top ]
_cmdNoop  [line 986]

  void _cmdNoop( )



[ Top ]
_cmdPass  [line 877]

  void _cmdPass( $pass  )

Parameters:
   $pass: 


[ Top ]
_cmdQuit  [line 1018]

  void _cmdQuit( )



[ Top ]
_cmdRetr  [line 952]

  void _cmdRetr( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
_cmdRset  [line 1002]

  void _cmdRset( )



[ Top ]
_cmdStat  [line 892]

  void _cmdStat( )



[ Top ]
_cmdTop  [line 1035]

  void _cmdTop( $msg_id, $num_lines  )

Parameters:
   $msg_id: 
   $num_lines: 


[ Top ]
_cmdUidl  [line 1053]

  void _cmdUidl( [ $msg_id = null]  )

Parameters:
   $msg_id: 


[ Top ]
_cmdUser  [line 862]

  void _cmdUser( $user  )

Parameters:
   $user: 


[ Top ]
_getMultiline  [line 1118]

  void _getMultiline( )



[ Top ]
_sendCmd  [line 1095]

  void _sendCmd( $cmd  )

Parameters:
   $cmd: 


[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:45:05 -0500 by phpDocumentor 1.4.2