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


	
			
Method Summary
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 = ''])
boolean popBeforeSmtp ($host $host, [integer|boolean $port = false], [integer|boolean $timeout = false], [string $username = ''], [string $password = ''], [integer $debug_level = 0 ])
integer sendString (string $string)
void setError ($error $error)
Methods
authorise (line 164)

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

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

Checks the POP3 server response.

Looks for for +OK or -ERR.

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

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

Disconnect from the POP3 server.

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

Get an array of error messages, if any.

array getErrors ()
getResponse (line 314)

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

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
popBeforeSmtp (line 139)

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

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

Send raw data to the POP3 server.

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

Add an error to the internal error store.

Also display debug output if it's enabled.

  • access: protected
void setError ($error $error)
  • $error $error

Documentation generated on Sun, 28 Jul 2024 13:19:41 +0200 by phpDocumentor 1.4.4