PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of POP3.php

PHPMailer POP-Before-SMTP Authentication Class. PHP Version 5.5.

Author:	Marcus Bointon (Synchro/coolbru) <[email protected]>
Author:	Jim Jagielski (jimjag) <[email protected]>
Author:	Andy Prevost (codeworxtech) <[email protected]>
Author:	Brent R. Matzelle (original founder)
Copyright:	2012 - 2020 Marcus Bointon
Copyright:	2010 - 2012 Jim Jagielski
Copyright:	2004 - 2009 Andy Prevost
License:	http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
File Size:	462 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

POP3:: (11 methods):
  popBeforeSmtp()
  authorise()
  connect()
  login()
  disconnect()
  getResponse()
  sendString()
  checkResponse()
  setError()
  getErrors()
  catchWarning()

Class: POP3 - X-Ref

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.

popBeforeSmtp($host,$port = false,$timeout = false,$username = '',$password = '',$debug_level = 0) X-Ref

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

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

authorise($host, $port = false, $timeout = false, $username = '', $password = '', $debug_level = 0) X-Ref

Authenticate with a POP3 server.
A connect, login, disconnect sequence
appropriate for POP-before SMTP authorisation.

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

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

Connect to a POP3 server.

param: string $host
param: int|bool $port
param: int $tval
return: bool

Log in to the POP3 server.
Does not support APOP (RFC 2828, 4949).

param: string $username
param: string $password
return: bool

disconnect() X-Ref

Disconnect from the POP3 server.

getResponse($size = 128) X-Ref

Get a response from the POP3 server.

param: int $size The maximum number of bytes to retrieve
return: string

sendString($string) X-Ref

Send raw data to the POP3 server.

param: string $string
return: int

checkResponse($string) X-Ref

Checks the POP3 server response.
Looks for for +OK or -ERR.

param: string $string
return: bool

setError($error) X-Ref

Add an error to the internal error store.
Also display debug output if it's enabled.

param: string $error

getErrors() X-Ref

Get an array of error messages, if any.

return: array

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

POP3 connection error handler.

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

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/vendor/phpmailer/phpmailer/src/ -> POP3.php (summary)

Defines 1 class