Docs For Class POP3

Description

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.

author: Richard Davey

Located in /libs/PHPMailer/class.pop3.php (line 62)

Variable Summary

string $CRLF

int $do_debug

string $host

string $password

int $POP3_PORT

int $POP3_TIMEOUT

int $port

int $tval

string $username

Method Summary

POP3 __construct ()

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

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

void Disconnect ()

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

Variables

string $CRLF = "\r\n" (line 79)

POP3 Carriage Return + Line Feed

access: public

int $do_debug = 2 (line 85)

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

access: public

string $host (line 91)

POP3 Mail Server

access: public

string $password (line 115)

POP3 Password

access: public

int $POP3_PORT = 110 (line 67)

Default POP3 port

access: public

int $POP3_TIMEOUT = 30 (line 73)

Default Timeout

access: public

int $port (line 97)

POP3 Port

access: public

int $tval (line 103)

POP3 Timeout Value

access: public

string $username (line 109)

POP3 Username

access: public

Methods

Constructor __construct (line 130)

Constructor, sets the initial values

access: public

POP3 __construct ()

Authorise (line 145)

Combination of public events - connect, login, disconnect

access: public

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

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

Connect (line 197)

Connect to the POP3 server

access: public

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

string $host
integer $port
integer $tval

Disconnect (line 315)

Disconnect from the POP3 server

access: public

void Disconnect ()

Login (line 272)

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

access: public

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

string $username
string $password