Docs For Class POP3

Description

PHP POP-Before-SMTP Authentication Class

Version 5.2.6

author: Richard Davey (orig) <rich@corephp.co.uk>
author: Andy Prevost
author: Jim Jagielski

Located in /libraries/phpmailer/pop3.php (line 60)

Variable Summary

string $CRLF

int $do_debug

string $host

string $password

int $POP3_PORT

int $POP3_TIMEOUT

int $port

int $tval

string $username

string $Version

Method Summary

POP3 __construct ()

bool Authorise (string $host, [bool|int $port = false], [bool|int $tval = false], string $username, string $password, [int $debug_level = 0])

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

void Disconnect ()

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

Variables

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

POP3 Carriage Return + Line Feed

access: public

int $do_debug = 2 (line 83)

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

access: public

string $host (line 89)

POP3 Mail Server

access: public

string $password (line 113)

POP3 Password

access: public

int $POP3_PORT = 110 (line 65)

Default POP3 port

access: public

int $POP3_TIMEOUT = 30 (line 71)

Default Timeout

access: public

int $port (line 95)

POP3 Port

access: public

int $tval (line 101)

POP3 Timeout Value

access: public

string $username (line 107)

POP3 Username

access: public

string $Version = '5.2.6' (line 119)

Sets the POP3 PHPMailer Version number

access: public

Methods

Constructor __construct (line 143)

Constructor, sets the initial values

access: public

POP3 __construct ()

Authorise (line 160)

Combination of public events - connect, login, disconnect

access: public

bool Authorise (string $host, [bool|int $port = false], [bool|int $tval = false], string $username, string $password, [int $debug_level = 0])

string $host
bool|int $port
bool|int $tval
string $username
string $password
int $debug_level

Connect (line 212)

Connect to the POP3 server

access: public

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

string $host
bool|int $port
integer $tval

Disconnect (line 327)

Disconnect from the POP3 server

access: public

void Disconnect ()

Login (line 287)

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

access: public

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

string $username
string $password