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])
boolean connect (string $host, [integer|boolean $port = false], [integer $tval = 30])
void disconnect ()
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 ])
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
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 ()
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
setError (line 366)

Add an error to the internal error store.

Also display debug output if it's enabled.

void setError ($error $error)
  • $error $error

Documentation generated on Thu, 17 Sep 2015 12:06:44 +0200 by phpDocumentor 1.4.4