PHPMailer\PHPMailer\POP3 Class Reference

PHPMailer POP-Before-SMTP Authentication Class. More...

Collaboration diagram for PHPMailer\PHPMailer\POP3:

Public Member Functions
	authorise ($host, $port=false, $timeout=false, $username='', $password='', $debug_level=0)
	Authenticate with a POP3 server. More...
	connect ($host, $port=false, $tval=30)
	Connect to a POP3 server. More...
	login ($username='', $password='')
	Log in to the POP3 server. More...
	disconnect ()
	Disconnect from the POP3 server. More...
	getErrors ()
	Get an array of error messages, if any. More...

Static Public Member Functions
static	popBeforeSmtp ( $host, $port=false, $timeout=false, $username='', $password='', $debug_level=0)
	Simple static wrapper for all-in-one POP before SMTP. More...

Data Fields
const	VERSION = '6.1.6'
const	DEFAULT_PORT = 110
const	DEFAULT_TIMEOUT = 30
	$do_debug = 0
	$host
	$port
	$tval
	$username
	$password
const	LE = "\r\n"
	Line break constant. More...

Protected Member Functions
	getResponse ($size=128)
	Get a response from the POP3 server. More...
	sendString ($string)
	Send raw data to the POP3 server. More...
	checkResponse ($string)
	Checks the POP3 server response. More...
	setError ($error)
	Add an error to the internal error store. More...
	catchWarning ($errno, $errstr, $errfile, $errline)
	POP3 connection error handler. More...

Protected Attributes
	$pop_conn
	$connected = false
	$errors = []

Detailed Description

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.

Author

Richard Davey (original author) rich@.nosp@m.core.nosp@m.php.c.nosp@m.o.uk

Marcus Bointon (Synchro/coolbru) phpma.nosp@m.iler.nosp@m.@sync.nosp@m.hrom.nosp@m.edia..nosp@m.co.u.nosp@m.k

Jim Jagielski (jimjag) jimja.nosp@m.g@gm.nosp@m.ail.c.nosp@m.om

Andy Prevost (codeworxtech) codew.nosp@m.orxt.nosp@m.ech@u.nosp@m.sers.nosp@m..sour.nosp@m.cefo.nosp@m.rge.n.nosp@m.et

Definition at line 41 of file POP3.php.

Member Function Documentation

authorise()

PHPMailer\PHPMailer\POP3::authorise	(		$host,
			$port = false,
			$timeout = false,
			$username = '',
			$password = '',
			$debug_level = 0
	)

Authenticate with a POP3 server.

A connect, login, disconnect sequence appropriate for POP-before SMTP authorisation.

Parameters

string	$host	The hostname to connect to
int | bool	$port	The port number to connect to
int | bool	$timeout	The timeout value
string	$username
string	$password
int	$debug_level

Returns

bool

Definition at line 172 of file POP3.php.

References PHPMailer\PHPMailer\POP3\$host, PHPMailer\PHPMailer\POP3\$password, PHPMailer\PHPMailer\POP3\$port, $result, PHPMailer\PHPMailer\POP3\$username, PHPMailer\PHPMailer\POP3\connect(), PHPMailer\PHPMailer\POP3\disconnect(), and PHPMailer\PHPMailer\POP3\login().

    {
        $this->host = $host;
        // If no port value provided, use default
        if (false === $port) {
            $this->port = static::DEFAULT_PORT;
        } else {
            $this->port = (int) $port;
        }
        // If no timeout value provided, use default
        if (false === $timeout) {
            $this->tval = static::DEFAULT_TIMEOUT;
        } else {
            $this->tval = (int) $timeout;
        }
        $this->do_debug = $debug_level;
        $this->username = $username;
        $this->password = $password;
        //  Reset the error log
        $this->errors = [];
        //  connect
        $result = $this->connect($this->host, $this->port, $this->tval);
        if ($result) {
            $login_result = $this->login($this->username, $this->password);
            if ($login_result) {
                $this->disconnect();

                return true;
            }
        }
        // We need to disconnect regardless of whether the login succeeded
        $this->disconnect();

        return false;
    }

Here is the call graph for this function:

catchWarning()

PHPMailer\PHPMailer\POP3::catchWarning (   $errno,   $errstr,   $errfile,   $errline  )

protected

POP3 connection error handler.

Parameters

int	$errno
string	$errstr
string	$errfile
int	$errline

Definition at line 414 of file POP3.php.

References PHPMailer\PHPMailer\POP3\setError().

    {
        $this->setError(
            'Connecting to the POP3 server raised a PHP warning:' .
            "errno: $errno errstr: $errstr; errfile: $errfile; errline: $errline"
        );
    }

Here is the call graph for this function:

checkResponse()

PHPMailer\PHPMailer\POP3::checkResponse (   $string )

protected

Checks the POP3 server response.

Looks for for +OK or -ERR.

Parameters

string

$string

Returns

bool

Definition at line 367 of file POP3.php.

References PHPMailer\PHPMailer\POP3\setError().

Referenced by PHPMailer\PHPMailer\POP3\connect(), and PHPMailer\PHPMailer\POP3\login().

    {
        if (strpos($string, '+OK') !== 0) {
            $this->setError("Server reported an error: $string");

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

connect()

PHPMailer\PHPMailer\POP3::connect	(		$host,
			$port = false,
			$tval = 30
	)

Connect to a POP3 server.

Parameters

string	$host
int | bool	$port
int	$tval

Returns

bool

Definition at line 217 of file POP3.php.

References PHPMailer\PHPMailer\POP3\$host, PHPMailer\PHPMailer\POP3\$port, PHPMailer\PHPMailer\POP3\$tval, PHPMailer\PHPMailer\POP3\checkResponse(), PHPMailer\PHPMailer\POP3\getResponse(), and PHPMailer\PHPMailer\POP3\setError().

Referenced by PHPMailer\PHPMailer\POP3\authorise().

    {
        //  Are we already connected?
        if ($this->connected) {
            return true;
        }

        //On Windows this will raise a PHP Warning error if the hostname doesn't exist.
        //Rather than suppress it with @fsockopen, capture it cleanly instead
        set_error_handler([$this, 'catchWarning']);

        if (false === $port) {
            $port = static::DEFAULT_PORT;
        }

        //  connect to the POP3 server
        $errno = 0;
        $errstr = '';
        $this->pop_conn = fsockopen(
            $host, //  POP3 Host
            $port, //  Port #
            $errno, //  Error Number
            $errstr, //  Error Message
            $tval
        ); //  Timeout (seconds)
        //  Restore the error handler
        restore_error_handler();

        //  Did we connect?
        if (false === $this->pop_conn) {
            //  It would appear not...
            $this->setError(
                "Failed to connect to server $host on port $port. errno: $errno; errstr: $errstr"
            );

            return false;
        }

        //  Increase the stream time-out
        stream_set_timeout($this->pop_conn, $tval, 0);

        //  Get the POP3 server response
        $pop3_response = $this->getResponse();
        //  Check for the +OK
        if ($this->checkResponse($pop3_response)) {
            //  The connection is established and the POP3 server is talking
            $this->connected = true;

            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

disconnect()

PHPMailer\PHPMailer\POP3::disconnect

(

)

Disconnect from the POP3 server.

Definition at line 310 of file POP3.php.

References PHPMailer\PHPMailer\POP3\sendString().

Referenced by PHPMailer\PHPMailer\POP3\authorise().

    {
        $this->sendString('QUIT');
        //The QUIT command may cause the daemon to exit, which will kill our connection
        //So ignore errors here
        try {
            @fclose($this->pop_conn);
        } catch (Exception $e) {
            //Do nothing
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getErrors()

PHPMailer\PHPMailer\POP3::getErrors

(

)

Get an array of error messages, if any.

Returns

array

Definition at line 401 of file POP3.php.

References PHPMailer\PHPMailer\POP3\$errors.

    {
        return $this->errors;
    }

getResponse()

PHPMailer\PHPMailer\POP3::getResponse (   $size = 128 )

protected

Get a response from the POP3 server.

Parameters

int

$size

The maximum number of bytes to retrieve

Returns

string

Definition at line 329 of file POP3.php.

References $response, and $size.

Referenced by PHPMailer\PHPMailer\POP3\connect(), and PHPMailer\PHPMailer\POP3\login().

    {
        $response = fgets($this->pop_conn, $size);
        if ($this->do_debug >= 1) {
            echo 'Server -> Client: ', $response;
        }

        return $response;
    }

Here is the caller graph for this function:

login()

PHPMailer\PHPMailer\POP3::login	(		$username = '',
			$password = ''
	)

Log in to the POP3 server.

Does not support APOP (RFC 2828, 4949).

Parameters

string	$username
string	$password

Returns

bool

Definition at line 280 of file POP3.php.

References PHPMailer\PHPMailer\POP3\$password, PHPMailer\PHPMailer\POP3\$username, PHPMailer\PHPMailer\POP3\checkResponse(), PHPMailer\PHPMailer\POP3\getResponse(), PHPMailer\PHPMailer\POP3\sendString(), and PHPMailer\PHPMailer\POP3\setError().

Referenced by PHPMailer\PHPMailer\POP3\authorise().

    {
        if (!$this->connected) {
            $this->setError('Not connected to POP3 server');
        }
        if (empty($username)) {
            $username = $this->username;
        }
        if (empty($password)) {
            $password = $this->password;
        }

        // Send the Username
        $this->sendString("USER $username" . static::LE);
        $pop3_response = $this->getResponse();
        if ($this->checkResponse($pop3_response)) {
            // Send the Password
            $this->sendString("PASS $password" . static::LE);
            $pop3_response = $this->getResponse();
            if ($this->checkResponse($pop3_response)) {
                return true;
            }
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

popBeforeSmtp()

static PHPMailer\PHPMailer\POP3::popBeforeSmtp (   $host,   $port = false,   $timeout = false,   $username = '',   $password = '',   $debug_level = 0  )

static

Simple static wrapper for all-in-one POP before SMTP.

Parameters

string	$host	The hostname to connect to
int | bool	$port	The port number to connect to
int | bool	$timeout	The timeout value
string	$username
string	$password
int	$debug_level

Returns

bool

Definition at line 145 of file POP3.php.

References PHPMailer\PHPMailer\POP3\$host, PHPMailer\PHPMailer\POP3\$password, PHPMailer\PHPMailer\POP3\$port, and PHPMailer\PHPMailer\POP3\$username.

      {
        $pop = new self();

        return $pop->authorise($host, $port, $timeout, $username, $password, $debug_level);
    }

sendString()

PHPMailer\PHPMailer\POP3::sendString (   $string )

protected

Send raw data to the POP3 server.

Parameters

string

$string

Returns

int

Definition at line 346 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\disconnect(), and PHPMailer\PHPMailer\POP3\login().

    {
        if ($this->pop_conn) {
            if ($this->do_debug >= 2) { //Show client messages when debug >= 2
                echo 'Client -> Server: ', $string;
            }

            return fwrite($this->pop_conn, $string, strlen($string));
        }

        return 0;
    }

Here is the caller graph for this function:

setError()

PHPMailer\PHPMailer\POP3::setError (   $error )

protected

Add an error to the internal error store.

Also display debug output if it's enabled.

Parameters

string

$error

Definition at line 384 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\catchWarning(), PHPMailer\PHPMailer\POP3\checkResponse(), PHPMailer\PHPMailer\POP3\connect(), and PHPMailer\PHPMailer\POP3\login().

    {
        $this->errors[] = $error;
        if ($this->do_debug >= 1) {
            echo '<pre>';
            foreach ($this->errors as $e) {
                print_r($e);
            }
            echo '</pre>';
        }
    }

Here is the caller graph for this function:

Field Documentation

$connected

PHPMailer\PHPMailer\POP3::$connected = false

protected

Definition at line 119 of file POP3.php.

$do_debug

PHPMailer\PHPMailer\POP3::$do_debug = 0

Definition at line 70 of file POP3.php.

$errors

PHPMailer\PHPMailer\POP3::$errors = []

protected

Definition at line 126 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\getErrors().

$host

PHPMailer\PHPMailer\POP3::$host

Definition at line 77 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\authorise(), PHPMailer\PHPMailer\POP3\connect(), and PHPMailer\PHPMailer\POP3\popBeforeSmtp().

$password

PHPMailer\PHPMailer\POP3::$password

Definition at line 105 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\authorise(), PHPMailer\PHPMailer\POP3\login(), and PHPMailer\PHPMailer\POP3\popBeforeSmtp().

$pop_conn

PHPMailer\PHPMailer\POP3::$pop_conn

protected

Definition at line 112 of file POP3.php.

$port

PHPMailer\PHPMailer\POP3::$port

Definition at line 84 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\authorise(), PHPMailer\PHPMailer\POP3\connect(), and PHPMailer\PHPMailer\POP3\popBeforeSmtp().

$tval

PHPMailer\PHPMailer\POP3::$tval

Definition at line 91 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\connect().

$username

PHPMailer\PHPMailer\POP3::$username

Definition at line 98 of file POP3.php.

Referenced by PHPMailer\PHPMailer\POP3\authorise(), PHPMailer\PHPMailer\POP3\login(), and PHPMailer\PHPMailer\POP3\popBeforeSmtp().

DEFAULT_PORT

const PHPMailer\PHPMailer\POP3::DEFAULT_PORT = 110

Definition at line 55 of file POP3.php.

DEFAULT_TIMEOUT

const PHPMailer\PHPMailer\POP3::DEFAULT_TIMEOUT = 30

Definition at line 62 of file POP3.php.

LE

const PHPMailer\PHPMailer\POP3::LE = "\r\n"

Line break constant.

Definition at line 131 of file POP3.php.

VERSION

const PHPMailer\PHPMailer\POP3::VERSION = '6.1.6'

Definition at line 48 of file POP3.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpmailer/phpmailer/src/POP3.php