Class POP3

PHPMailer POP-Before-SMTP Authentication Class. Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication. 1) This class does not support APOP authentication. 2) Opening and closing lots of POP3 connections can be quite slow. If you need to send a batch of emails then just perform the authentication once at the start, and then loop through your mail sending script. Providing this process doesn't take longer than the verification period lasts on your POP3 server, you should be fine. 3) This is really ancient technology; you should only need to use it to talk to very old systems. 4) This POP3 class is deliberately lightweight and incomplete, implementing just enough to do authentication. If you want a more complete class there are other POP3 classes for PHP available.

Namespace: PHPMailer\PHPMailer
Author: Richard Davey (original author) rich@corephp.co.uk
Author: Marcus Bointon (Synchro/coolbru) phpmailer@synchromedia.co.uk
Author: Jim Jagielski (jimjag) jimjag@gmail.com
Author: Andy Prevost (codeworxtech) codeworxtech@users.sourceforge.net
Located at zp-extensions/PHPMailer/POP3.php

Methods summary
`public static boolean`	# `popBeforeSmtp( string $host, integer\|boolean $port = false, integer\|boolean $timeout = false, string $username = '', string $password = '', integer $debug_level = 0 )` Simple static wrapper for all-in-one POP before SMTP. Simple static wrapper for all-in-one POP before SMTP. Parameters `$host` The hostname to connect to `$port` The port number to connect to `$timeout` The timeout value `$username` `$password` `$debug_level` Returns boolean
`public boolean`	# `authorise( string $host, integer\|boolean $port = false, integer\|boolean $timeout = false, string $username = '', string $password = '', integer $debug_level = 0 )` Authenticate with a POP3 server. A connect, login, disconnect sequence appropriate for POP-before SMTP authorisation. Authenticate with a POP3 server. A connect, login, disconnect sequence appropriate for POP-before SMTP authorisation. Parameters `$host` The hostname to connect to `$port` The port number to connect to `$timeout` The timeout value `$username` `$password` `$debug_level` Returns boolean
`public boolean`	# `connect( string $host, integer\|boolean $port = false, integer $tval = 30 )` Connect to a POP3 server. Connect to a POP3 server. Parameters `$host` `$port` `$tval` Returns boolean
`public boolean`	# `login( string $username = '', string $password = '' )` Log in to the POP3 server. Does not support APOP (RFC 2828, 4949). Log in to the POP3 server. Does not support APOP (RFC 2828, 4949). Parameters `$username` `$password` Returns boolean
`public`	# `disconnect( )` Disconnect from the POP3 server. Disconnect from the POP3 server.
`protected string`	# `getResponse( integer $size = 128 )` Get a response from the POP3 server. Get a response from the POP3 server. Parameters `$size` The maximum number of bytes to retrieve Returns string
`protected integer`	# `sendString( string $string )` Send raw data to the POP3 server. Send raw data to the POP3 server. Parameters `$string` Returns integer
`protected boolean`	# `checkResponse( string $string )` Checks the POP3 server response. Looks for for +OK or -ERR. Checks the POP3 server response. Looks for for +OK or -ERR. Parameters `$string` Returns boolean
`protected`	# `setError( string $error )` Add an error to the internal error store. Also display debug output if it's enabled. Add an error to the internal error store. Also display debug output if it's enabled. Parameters `$error`
`public array`	# `getErrors( )` Get an array of error messages, if any. Get an array of error messages, if any. Returns array
`protected`	# `catchWarning( integer $errno, string $errstr, string $errfile, integer $errline )` POP3 connection error handler. POP3 connection error handler. Parameters `$errno` `$errstr` `$errfile` `$errline`

Constants summary
`string`	`VERSION` The POP3 PHPMailer Version number. The POP3 PHPMailer Version number.	# `'6.4.1'`
`integer`	`DEFAULT_PORT` Default POP3 port number. Default POP3 port number.	# `110`
`integer`	`DEFAULT_TIMEOUT` Default timeout in seconds. Default timeout in seconds.	# `30`
`string`	`LE` Line break constant. Line break constant.	# `"\r\n"`
`integer`	`DEBUG_OFF` Debug level for no output. Debug level for no output.	# `0`
`integer`	`DEBUG_SERVER` Debug level to show server -> client messages also shows clients connection errors or errors from server Debug level to show server -> client messages also shows clients connection errors or errors from server	# `1`
`integer`	`DEBUG_CLIENT` Debug level to show client -> server and server -> client messages. Debug level to show client -> server and server -> client messages.	# `2`

Properties summary
`public integer`	`$do_debug` POP3 class debug output mode. Debug output level. Options: POP3 class debug output mode. Debug output level. Options: See POP3::DEBUG_OFF: No output POP3::DEBUG_SERVER: Server messages, connection/server errors POP3::DEBUG_CLIENT: Client and Server messages, connection/server errors	# `self::DEBUG_OFF`
`public string`	`$host` POP3 mail server hostname. POP3 mail server hostname.	#
`public integer`	`$port` POP3 port number. POP3 port number.	#
`public integer`	`$tval` POP3 Timeout Value in seconds. POP3 Timeout Value in seconds.	#
`public string`	`$username` POP3 username. POP3 username.	#
`public string`	`$password` POP3 password. POP3 password.	#
`protected resource`	`$pop_conn` Resource handle for the POP3 connection socket. Resource handle for the POP3 connection socket.	#
`protected boolean`	`$connected` Are we connected? Are we connected?	# `false`
`protected array`	`$errors` Error container. Error container.	# `[]`

Classes

Interfaces

Exceptions

Functions

Class POP3

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

See