apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
Net_POP3


Classes:
Net_POP3
   Net_POP3

Class: Net_POP3

Source Location: /Net_POP3-1.3.8/Net/POP3.php

Class Overview


















Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 58]






[ Top ]







Class Variables



	
	

	
$supportedAuthMethods = array( 'CRAM-MD5', 'APOP' , 'PLAIN' , 'LOGIN', 'USER')

	
[line 125]

  The auth methods this class support

  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$supportedSASLAuthMethods = array('DIGEST-MD5', 'CRAM-MD5')

	
[line 134]

  The auth methods this class support

  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Method Detail



	
	
Net_POP3 (Constructor)   [line 150]

	

    

    

		Net_POP3 Net_POP3(
)
    

    


	
		Constructor. Sets up the object variables, and instantiates  the socket object.




        
[ Top ]

  

  
  
	
	
connect   [line 202]

	

    

    

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

    


	
		Connects to the given host on the given port.
Also looks for the timestamp in the greeting  needed for APOP authentication


    

  • Return: Success/Failure
    • 








        
Parameters:

    

    

          

        string  
        $host  
        — 
        Hostname/IP address to connect to
      

          

        string  
        $port  
        — 
        Port to use to connect to on host
      

        

    


        
[ Top ]

  

  
  
	
	
deleteMsg   [line 796]

	

    

    

		bool deleteMsg(
integer
$msg_id)
    

    


	
		Marks a message for deletion. Only will be deleted if the  disconnect() method is called.


    

  • Return: Success/Failure
    • 








        
Parameters:

    

    

          

        integer  
        $msg_id  
        — 
        Message to delete
      

        

    


        
[ Top ]

  

  
  
	
	
disconnect   [line 237]

	

    

    

		bool disconnect(
)
    

    


	
		Disconnect function. Sends the QUIT command  and closes the socket.


    

  • Return: Success/Failure
    • 








        
[ Top ]

  

  
  
	
	
getBody   [line 726]

	

    

    

		mixed getBody(
integer
$msg_id)
    

    


	
		Returns the body of the message with given message number.


    

  • Return: Either message body or false on error
    • 








        
Parameters:

    

    

          

        integer  
        $msg_id  
        — 
        Message number
      

        

    


        
[ Top ]

  

  
  
	
	
getListing   [line 812]

	

    

    

		mixed getListing(
[integer
$msg_id = null])
    

    


	
		Combination of LIST/UIDL commands, returns an array  of data


    

  • Return: Array of data or false on error
    • 








        
Parameters:

    

    

          

        integer  
        $msg_id  
        — 
        Optional message number
      

        

    


        
[ Top ]

  

  
  
	
	
getMsg   [line 742]

	

    

    

		mixed getMsg(
integer
$msg_id)
    

    


	
		Returns the entire message with given message number.


    

  • Return: Either entire message or false on error
    • 








        
Parameters:

    

    

          

        integer  
        $msg_id  
        — 
        Message number
      

        

    


        
[ Top ]

  

  
  
	
	
getParsedHeaders   [line 694]

	

    

    

		mixed getParsedHeaders(
integer
$msg_id)
    

    


	
		Returns the  headers of the specified message in an
associative array. Array keys are the header names, array  values are the header values. In the case of multiple headers  having the same names, eg Received:, the array value will be  an indexed array of all the header values.


    

  • Return: Either array of headers or false on error
    • 








        
Parameters:

    

    

          

        integer  
        $msg_id  
        — 
        Message number
      

        

    


        
[ Top ]

  

  
  
	
	
getRawHeaders   [line 675]

	

    

    

		mixed getRawHeaders(
integer
$msg_id)
    

    


	
		Returns the raw headers of the specified message.


    

  • Return: Either raw headers or false on error
    • 








        
Parameters:

    

    

          

        integer  
        $msg_id  
        — 
        Message number
      

        

    


        
[ Top ]

  

  
  
	
	
getSize   [line 756]

	

    

    

		mixed getSize(
)
    

    


	
		Returns the size of the maildrop


    

  • Return: Either size of maildrop or false on error
    • 








        
[ Top ]

  

  
  
	
	
login   [line 254]

	

    

    

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

    


	
		Performs the login procedure. If there is a timestamp  stored, APOP will be tried first, then basic USER/PASS.


    

  • Return: true on Success/ PEAR_ERROR on error
    • 








        
Parameters:

    

    

          

        string  
        $user  
        — 
        Username to use
      

          

        string  
        $pass  
        — 
        Password to use
      

          

        mixed  
        $apop  
        — 
        Whether to try APOP first, if used as string you can select the auth methd to use ( $pop3->login('validlogin', 'validpass', "CRAM-MD5");           Valid methods are: 'DIGEST-MD5','CRAM-MD5','LOGIN','PLAIN','APOP','USER'
      

        

    


        
[ Top ]

  

  
  
	
	
numMsg   [line 775]

	

    

    

		mixed numMsg(
)
    

    


	
		Returns number of messages in this maildrop


    

  • Return: Either number of messages or false on error
    • 








        
[ Top ]

  

  
  
	
	
setDebug   [line 1136]

	

    

    

		void setDebug(
[bool
$debug = true])
    

    


	
		Sets the bebug state


    

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $debug  
        — 
        
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:41:21 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.