[ class tree: PHPMailer ] [ index: PHPMailer ] [ all elements ]

Class: POP3

Source Location: /zp-extensions/PHPMailer/class.pop3.php

Class POP3

Class Overview
Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

POP Before SMTP Authentication Class Version 5.0.0

Author: Richard Davey (rich@corephp.co.uk) Modifications: Andy Prevost License: LGPL, see PHPMailer License

Specifically for PHPMailer to allow POP before SMTP authentication. Does not yet work with APOP - if you have an APOP account, contact Richard Davey and we can test changes to this script.

This class is based on the structure of the SMTP class originally authored by Chris Ryan

This class is rfc 1939 compliant and implements all the commands required for POP3 connection, authentication and disconnection.

Located in /zp-extensions/PHPMailer/class.pop3.php [line 62] 



		
				Author(s):
		
    
		  			 			 
  • Richard Davey
    • 
			 		  		

		
		
Information Tags:



	

				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	







	
	

		
Property Summary

		

			Class Overview
									| Property Summary | Properties Detail
												| Method Summary | Methods Detail
							    				

		

			

			

					

					

					

					

					

					

					

					

					

																																																																			
string  
					$CRLF  
					POP3 Carriage Return + Line Feed

				
													
int  
					$do_debug  
					Displaying Debug warnings? (0 = now, 1+ = yes)

				
													
string  
					$host  
					POP3 Mail Server

				
													
string  
					$password  
					POP3 Password

				
													
int  
					$POP3_PORT  
					Default POP3 port

				
													
int  
					$POP3_TIMEOUT  
					Default Timeout

				
													
int  
					$port  
					POP3 Port

				
													
int  
					$tval  
					POP3 Timeout Value

				
													
string  
					$username  
					POP3 Username

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

			Class Overview
																		| Property Summary | Properties Detail
							    					| Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

																																																								
POP3  
										__construct()  
					Constructor, sets the initial values

				
																
void  
										Authorise()  
					Combination of public events - connect, login, disconnect

				
																
boolean  
										Connect()  
					Connect to the POP3 server

				
																
void  
										Disconnect()  
					Disconnect from the POP3 server

				
																
boolean  
										Login()  
					Login to the POP3 server (does not support APOP yet)

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

			Class Overview
													| Property Summary | Properties Detail
															| Method Summary | Methods Detail
												

		

			



	

		
			string  
			$CRLF
			 =  "\r\n"			[line 79]
		
	


	
POP3 Carriage Return + Line Feed


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			int  
			$do_debug
			 =  2			[line 85]
		
	


	
Displaying Debug warnings? (0 = now, 1+ = yes)


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			string  
			$host
						[line 91]
		
	


	
POP3 Mail Server


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			string  
			$password
						[line 115]
		
	


	
POP3 Password


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			int  
			$POP3_PORT
			 =  110			[line 67]
		
	


	
Default POP3 port


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			int  
			$POP3_TIMEOUT
			 =  30			[line 73]
		
	


	
Default Timeout


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			int  
			$port
						[line 97]
		
	


	
POP3 Port


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			int  
			$tval
						[line 103]
		
	


	
POP3 Timeout Value


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]







	

		
			string  
			$username
						[line 109]
		
	


	
POP3 Username


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]



		

	


	
	

		
Methods

		

			Class Overview
																		| Property Summary | Properties Detail
																	| Method Summary | Methods Detail
					

		

			







	Constructor __construct  [line 130]





	

    

    
 
		POP3 __construct(
)
    

    



	
Constructor, sets the initial values



	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	Authorise  [line 145]





	

    

    
 
		void Authorise(
string
$host, [integer
$port = false], [integer
$tval = false], string
$username, string
$password, [
$debug_level = 0] 
)
    

    



	
Combination of public events - connect, login, disconnect



			Parameters:

			

					

				string  
				
				$host: 
				
							

					

				integer  
				
				$port: 
				
							

					

				integer  
				
				$tval: 
				
							

					

				string  
				
				$username: 
				
							

					

				string  
				
				$password: 
				
							

					

				  
				
				$debug_level: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	Connect  [line 197]





	

    

    
 
		boolean Connect(
string
$host, [integer
$port = false], [integer
$tval = 30] 
)
    

    



	
Connect to the POP3 server



			Parameters:

			

					

				string  
				
				$host: 
				
							

					

				integer  
				
				$port: 
				
							

					

				integer  
				
				$tval: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	Disconnect  [line 315]





	

    

    
 
		void Disconnect(
)
    

    



	
Disconnect from the POP3 server



	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	Login  [line 272]





	

    

    
 
		boolean Login(
[string
$username = ''], [string
$password = ''] 
)
    

    



	
Login to the POP3 server (does not support APOP yet)



			Parameters:

			

					

				string  
				
				$username: 
				
							

					

				string  
				
				$password: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]



		

	




    
PHPMailer

      Packages:

  

              core

              admin

              classes

              functions

              GoogleMapAPI

              JSMin

              OpenID

              PHPMailer

              plugins

              Services_JSON

      	

      

                        Files:
        

  

				class.phpmailer.php

			class.pop3.php

			class.smtp.php

	  


            

                  Classes:

        

		    		PHPMailer    	 

	    		phpmailerException    	 

	    		POP3    	 

	    		SMTP    	 

	  


                		        
        
        
       
      

     
    
    		
  




  

		    

		    Documentation generated on Tue, 20 Dec 2011 16:07:01 +0100 by phpDocumentor 1.4.3