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 30)


	
			
Class Constant Summary
CRLF = "\r\n"
Variable Summary
boolean $connected
string $CRLF
integer $do_debug
array $errors
string $host
string $password
integer $POP3_PORT
integer $POP3_TIMEOUT
resource $pop_conn
integer $port
integer $tval
string $username
string $Version
Method Summary
static boolean popBeforeSmtp ($host $host, [integer|boolean $port = false], [integer|boolean $timeout = false], [string $username = ''], [string $password = ''], [integer $debug_level = 0])
boolean authorise (string $host, [integer|boolean $port = false], [integer|boolean $timeout = false], [string $username = ''], [string $password = ''], [integer $debug_level = 0])
void catchWarning (integer $errno, string $errstr, string $errfile, integer $errline)
boolean checkResponse (string $string)
boolean connect (string $host, [integer|boolean $port = false], [integer $tval = 30])
void disconnect ()
array getErrors ()
string getResponse ([integer $size = 128])
boolean login ([string $username = ''], [string $password = ''])
integer sendString (string $string)
void setError ($error $error)
Variables
boolean $connected = false (line 116)

Are we connected?

  • access: protected
string $CRLF = "\r\n" (line 59)

POP3 Carriage Return + Line Feed.

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

Debug display level.

Options: 0 = no, 1+ = yes

  • access: public
array $errors = array() (line 123)

Error container.

  • access: protected
string $host (line 74)

POP3 mail server hostname.

  • access: public
string $password (line 102)

POP3 password.

  • access: public
integer $POP3_PORT = 110 (line 44)

Default POP3 port number.

  • access: public
integer $POP3_TIMEOUT = 30 (line 51)

Default timeout in seconds.

  • access: public
resource $pop_conn (line 109)

Resource handle for the POP3 connection socket.

  • access: protected
integer $port (line 81)

POP3 port number.

  • access: public
integer $tval (line 88)

POP3 Timeout Value in seconds.

  • access: public
string $username (line 95)

POP3 username

  • access: public
string $Version = '5.2.26' (line 37)

The POP3 PHPMailer Version number.

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

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

  • access: public
static boolean popBeforeSmtp ($host $host, [integer|boolean $port = false], [integer|boolean $timeout = false], [string $username = ''], [string $password = ''], [integer $debug_level = 0])
  • integer|boolean $port: The port number to connect to
  • integer|boolean $timeout: The timeout value
  • string $username
  • string $password
  • integer $debug_level
  • $host $host
authorise (line 165)

Authenticate with a POP3 server.

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

  • access: public
boolean authorise (string $host, [integer|boolean $port = false], [integer|boolean $timeout = false], [string $username = ''], [string $password = ''], [integer $debug_level = 0])
  • string $host: The hostname to connect to
  • integer|boolean $port: The port number to connect to
  • integer|boolean $timeout: The timeout value
  • string $username
  • string $password
  • integer $debug_level
catchWarning (line 397)

POP3 connection error handler.

  • access: protected
void catchWarning (integer $errno, string $errstr, string $errfile, integer $errline)
  • integer $errno
  • string $errstr
  • string $errfile
  • integer $errline
checkResponse (line 348)

Checks the POP3 server response.

Looks for for +OK or -ERR.

  • access: protected
boolean checkResponse (string $string)
  • string $string
connect (line 207)

Connect to a POP3 server.

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

Disconnect from the POP3 server.

  • access: public
void disconnect ()
getErrors (line 384)

Get an array of error messages, if any.

  • access: public
array getErrors ()
getResponse (line 315)

Get a response from the POP3 server.

$size is the maximum number of bytes to retrieve

  • access: protected
string getResponse ([integer $size = 128])
  • integer $size
login (line 266)

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
sendString (line 330)

Send raw data to the POP3 server.

  • access: protected
integer sendString (string $string)
  • string $string
setError (line 368)

Add an error to the internal error store.

Also display debug output if it's enabled.

  • access: protected
void setError ($error $error)
  • $error $error
Class Constants
CRLF = "\r\n" (line 128)

Line break constant

Documentation generated on Tue, 14 Nov 2017 20:20:42 +0100 by phpDocumentor 1.4.4