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

Class: POP3

Source Location: /shared/phpmailer/class.pop3.php

Class Overview


POP Before SMTP Authentication Class Version 5.0.0


Author(s):

  • Richard Davey

Variables

Methods



Class Details

[line 62]
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.




Tags:

author:  Richard Davey


[ Top ]


Class Variables

$connected =

[line 122]



Tags:

access:  private

Type:   mixed


[ Top ]

$CRLF =  "\r\n"

[line 79]

POP3 Carriage Return + Line Feed



Tags:

access:  public

Type:   string


[ Top ]

$do_debug =  2

[line 85]

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



Tags:

access:  public

Type:   int


[ Top ]

$error =

[line 123]



Tags:

access:  private

Type:   mixed


[ Top ]

$host =

[line 91]

POP3 Mail Server



Tags:

access:  public

Type:   string


[ Top ]

$password =

[line 115]

POP3 Password



Tags:

access:  public

Type:   string


[ Top ]

$POP3_PORT =  110

[line 67]

Default POP3 port



Tags:

access:  public

Type:   int


[ Top ]

$POP3_TIMEOUT =  30

[line 73]

Default Timeout



Tags:

access:  public

Type:   int


[ Top ]

$pop_conn =

[line 121]



Tags:

access:  private

Type:   mixed


[ Top ]

$port =

[line 97]

POP3 Port



Tags:

access:  public

Type:   int


[ Top ]

$tval =

[line 103]

POP3 Timeout Value



Tags:

access:  public

Type:   int


[ Top ]

$username =

[line 109]

POP3 Username



Tags:

access:  public

Type:   string


[ Top ]



Class Methods


constructor __construct [line 130]

POP3 __construct( )

Constructor, sets the initial values



Tags:

access:  public


[ Top ]

method 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



Tags:

access:  public


Parameters:

string   $host  
integer   $port  
integer   $tval  
string   $username  
string   $password  
   $debug_level  

[ Top ]

method catchWarning [line 397]

void catchWarning( integer $errno, string $errstr, string $errfile, integer $errline)

Takes over from PHP for the socket warning handler



Tags:

access:  private


Parameters:

integer   $errno  
string   $errstr  
string   $errfile  
integer   $errline  

[ Top ]

method checkResponse [line 356]

boolean checkResponse( string $string)

Checks the POP3 server response for +OK or -ERR



Tags:

access:  private


Parameters:

string   $string  

[ Top ]

method Connect [line 197]

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

Connect to the POP3 server



Tags:

access:  public


Parameters:

string   $host  
integer   $port  
integer   $tval  

[ Top ]

method Disconnect [line 315]

void Disconnect( )

Disconnect from the POP3 server



Tags:

access:  public


[ Top ]

method displayErrors [line 379]

void displayErrors( )

If debug is enabled, display the error message array



Tags:

access:  private


[ Top ]

method getResponse [line 332]

string getResponse( [integer $size = 128])

Get the socket response back.

$size is the maximum number of bytes to retrieve




Tags:

access:  private


Parameters:

integer   $size  

[ Top ]

method Login [line 272]

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

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



Tags:

access:  public


Parameters:

string   $username  
string   $password  

[ Top ]

method sendString [line 344]

integer sendString( string $string)

Send a string down the open socket connection to the POP3 server



Tags:

access:  private


Parameters:

string   $string  

[ Top ]


Documentation generated on Mon, 06 Dec 2010 12:03:01 +0100 by phpDocumentor 1.4.3