Class POP3

POP Before SMTP Authentication Class Version 5.0.0

Author: Richard Davey (rich@corephp.co.uk) 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.

Package: PHPMailer
Copyright: 2004 - 2009 Andy Prevost
License: Distributed under the Lesser General Public License (LGPL)
Author: Richard Davey
Located at vendors/phpmailer/class.pop3.php

Methods summary

`public POP3`	# `__construct( )` Constructor, sets the initial values Constructor, sets the initial values Returns `POP3`
`public`	# `Authorise( string $host, integer $port = false, integer $tval = false, string $username, string $password, mixed $debug_level = 0 )` Combination of public events - connect, login, disconnect Combination of public events - connect, login, disconnect Parameters `$host` `string` $host `$port` `integer` $port `$tval` `integer` $tval `$username` `string` $username `$password` `string` $password `$debug_level`
`public boolean`	# `Connect( string $host, integer $port = false, integer $tval = 30 )` Connect to the POP3 server Connect to the POP3 server Parameters `$host` `string` $host `$port` `integer` $port `$tval` `integer` $tval Returns `boolean`
`public boolean`	# `Login( string $username = '', string $password = '' )` Login to the POP3 server (does not support APOP yet) Login to the POP3 server (does not support APOP yet) Parameters `$username` `string` $username `$password` `string` $password Returns `boolean`
`public`	# `Disconnect( )` Disconnect from the POP3 server Disconnect from the POP3 server
`private string`	# `getResponse( integer $size = 128 )` Get the socket response back. $size is the maximum number of bytes to retrieve Get the socket response back. $size is the maximum number of bytes to retrieve Parameters `$size` `integer` $size Returns `string`
`private integer`	# `sendString( string $string )` Send a string down the open socket connection to the POP3 server Send a string down the open socket connection to the POP3 server Parameters `$string` `string` $string Returns `integer`
`private boolean`	# `checkResponse( string $string )` Checks the POP3 server response for +OK or -ERR Checks the POP3 server response for +OK or -ERR Parameters `$string` `string` $string Returns `boolean`
`private`	# `displayErrors( )` If debug is enabled, display the error message array If debug is enabled, display the error message array
`private`	# `catchWarning( integer $errno, string $errstr, string $errfile, integer $errline )` Takes over from PHP for the socket warning handler Takes over from PHP for the socket warning handler Parameters `$errno` `integer` $errno `$errstr` `string` $errstr `$errfile` `string` $errfile `$errline` `integer` $errline

Magic methods summary

Properties summary

`public integer`	`$POP3_PORT`	# Default POP3 port Default POP3 port
`public integer`	`$POP3_TIMEOUT`	# Default Timeout Default Timeout
`public string`	`$CRLF`	# POP3 Carriage Return + Line Feed POP3 Carriage Return + Line Feed
`public integer`	`$do_debug`	# Displaying Debug warnings? (0 = now, 1+ = yes) Displaying Debug warnings? (0 = now, 1+ = yes)
`public string`	`$host`	# POP3 Mail Server POP3 Mail Server
`public integer`	`$port`	# POP3 Port POP3 Port
`public integer`	`$tval`	# POP3 Timeout Value POP3 Timeout Value
`public string`	`$username`	# POP3 Username POP3 Username
`public string`	`$password`	# POP3 Password POP3 Password
`private mixed`	`$pop_conn`	#
`private mixed`	`$connected`	#
`private mixed`	`$error`	#

Packages

Classes

Exceptions

Class POP3

Methods summary

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Magic methods summary

Properties summary