Class POP3

Description

PHPMailer POP-Before-SMTP Authentication Class.

Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication. Does not support APOP.

Located in /class.pop3.php (line 32)


	
			
Class Constant Summary
CRLF = "\r\n"
Variable Summary
mixed $CRLF
mixed $do_debug
mixed $host
mixed $password
mixed $POP3_PORT
mixed $port
mixed $tval
mixed $username
mixed $Version
Method Summary
static bool popBeforeSmtp ($host $host, [bool $port = false], [bool $tval = false], [string $username = ''], [string $password = ''], [int $debug_level = 0])
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
mixed $CRLF = "\r\n" (line 61)

POP3 Carriage Return + Line Feed.

  • deprecated: Use the constant instead
  • access: public
mixed $do_debug = 0 (line 69)

Debug display level.

Options: 0 = no, 1+ = yes

  • access: public
mixed $host (line 76)

POP3 mail server hostname.

  • access: public
mixed $password (line 104)

POP3 password.

  • access: public
mixed $POP3_PORT = 110 (line 46)

Default POP3 port number.

  • access: public
mixed $POP3_TIMEOUT = 30 (line 53)

Default timeout in seconds.

  • access: public
mixed $port (line 83)

POP3 port number.

  • access: public
mixed $tval (line 90)

POP3 Timeout Value in seconds.

  • access: public
mixed $username (line 97)

POP3 username

  • access: public
mixed $Version = '5.2.7' (line 39)

The POP3 PHPMailer Version number.

  • access: public
Methods
static method popBeforeSmtp (line 153)

Simple static wrapper for all-in-one POP before SMTP

  • access: public
static bool popBeforeSmtp ($host $host, [bool $port = false], [bool $tval = false], [string $username = ''], [string $password = ''], [int $debug_level = 0])
  • bool $port
  • bool $tval
  • string $username
  • string $password
  • int $debug_level
  • $host $host
Constructor __construct (line 136)

Constructor.

  • access: public
POP3 __construct ()
authorise (line 178)

Authenticate with a POP3 server.

A connect, login, disconnect sequence appropriate for POP-before SMTP authorisation.

  • 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 220)

Connect to a POP3 server.

  • access: public
boolean connect (string $host, [bool|int $port = false], [integer $tval = 30])
  • string $host
  • bool|int $port
  • integer $tval
disconnect (line 323)

Disconnect from the POP3 server.

  • access: public
void disconnect ()
login (line 289)

Log in to the POP3 server.

Does not support APOP (RFC 2828, 4949).

  • access: public
boolean login ([string $username = ''], [string $password = ''])
  • string $username
  • string $password
Class Constants
CRLF = "\r\n" (line 130)

Line break constant

Documentation generated on Sat, 09 Nov 2013 23:19:24 +0100 by phpDocumentor 1.4.4