Class POP3

PHPMailer POP-Before-SMTP Authentication Class. Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication. Does not support APOP.

Package: PHPMailer
Copyright: 2012 - 2014 Marcus Bointon
Copyright: 2010 - 2012 Jim Jagielski
Copyright: 2004 - 2009 Andy Prevost
License: GNU Lesser General Public License
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 vendor/phpmailer/phpmailer/class.pop3.php

Methods summary

`public static boolean`	# `popBeforeSmtp( mixed $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` `mixed` - $host `$port` `integer\|boolean` - $port The port number to connect to `$timeout` `integer\|boolean` - $timeout The timeout value `$username` `string` - $username `$password` `string` - $password `$debug_level` `integer` - $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` `string` - $host The hostname to connect to `$port` `integer\|boolean` - $port The port number to connect to `$timeout` `integer\|boolean` - $timeout The timeout value `$username` `string` - $username `$password` `string` - $password `$debug_level` `integer` - $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` `string` - $host `$port` `integer\|boolean` - $port `$tval` `integer` - $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` `string` - $username `$password` `string` - $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. $size is the maximum number of bytes to retrieve Get a response from the POP3 server. $size is the maximum number of bytes to retrieve Parameters `$size` `integer` - $size Returns `string`
`protected integer`	# `sendString( string $string )` Send raw data to the POP3 server. Send raw data to the POP3 server. Parameters `$string` `string` - $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` `string` - $string Returns `boolean`
`protected`	# `setError( mixed $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` `mixed` - $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` `integer` - $errno `$errstr` `string` - $errstr `$errfile` `string` - $errfile `$errline` `integer` - $errline

Magic methods summary

Constants summary

`string`	`CRLF`	`"\r\n"`	# Line break constant Line break constant

Properties summary

`public string`	`$Version`	# The POP3 PHPMailer Version number. The POP3 PHPMailer Version number.
`public integer`	`$POP3_PORT`	# Default POP3 port number. Default POP3 port number.
`public integer`	`$POP3_TIMEOUT`	# Default timeout in seconds. Default timeout in seconds.
`public string`	`$CRLF`	# POP3 Carriage Return + Line Feed. POP3 Carriage Return + Line Feed. Deprecated Use the constant instead
`public integer`	`$do_debug`	# Debug display level. Options: 0 = no, 1+ = yes Debug display level. Options: 0 = no, 1+ = yes
`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?
`protected array`	`$errors`	# Error container. Error container.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class POP3

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Magic methods summary

Constants summary

Properties summary

Deprecated