PHPXRef 0.7.1 : Phabricator : Detail view of class.pop3.php

PHPMailer - PHP POP Before SMTP Authentication Class NOTE: Designed for use with PHP version 5 and up

Author:	Andy Prevost
Author:	Marcus Bointon
Copyright:	2004 - 2009 Andy Prevost
License:	http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
Version:	$Id: class.pop3.php 444 2009-05-05 11:22:26Z coolbru $
File Size:	407 lines (11 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

POP3:: (10 methods):
  __construct()
  Authorise()
  Connect()
  Login()
  Disconnect()
  getResponse()
  sendString()
  checkResponse()
  displayErrors()
  catchWarning()

Class: POP3 - X-Ref

POP Before SMTP Authentication Class
Version 5.0.0

Author: Richard Davey ([email protected])
Modifications: Andy Prevost
License: LGPL, see PHPMailer License

Specifically for PHPMailer to allow POP before SMTP authentication.
Does not yet work with APOP - if you have an APOP account, contact Richard Davey
and we can test changes to this script.

This class is based on the structure of the SMTP class originally authored by Chris Ryan

This class is rfc 1939 compliant and implements all the commands
required for POP3 connection, authentication and disconnection.

__construct() X-Ref

Constructor, sets the initial values

return: POP3

Authorise($host, $port = false, $tval = false, $username, $password, $debug_level = 0) X-Ref

Combination of public events - connect, login, disconnect

param: string $host
param: integer $port
param: integer $tval
param: string $username
param: string $password

Connect($host, $port = false, $tval = 30) X-Ref

Connect to the POP3 server

param: string $host
param: integer $port
param: integer $tval
return: boolean

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

param: string $username
param: string $password
return: boolean

Disconnect() X-Ref

Disconnect from the POP3 server

getResponse($size = 128) X-Ref

Get the socket response back.
$size is the maximum number of bytes to retrieve

param: integer $size
return: string

sendString($string) X-Ref

Send a string down the open socket connection to the POP3 server

param: string $string
return: integer

checkResponse($string) X-Ref

Checks the POP3 server response for +OK or -ERR

param: string $string
return: boolean

displayErrors() X-Ref

If debug is enabled, display the error message array

catchWarning($errno, $errstr, $errfile, $errline) X-Ref

Takes over from PHP for the socket warning handler

param: integer $errno
param: string $errstr
param: string $errfile
param: integer $errline

PHP Cross Reference of Phabricator

/externals/phpmailer/ -> class.pop3.php (summary)

Defines 1 class