core/model/modx/mail/phpmailer/class.pop3.php

Show: inherited
Table of Contents

\POP3

Package:

Properties

Propertypublicstring  $CRLF= '"\r\n"'

POP3 Carriage Return + Line Feed

Default value"\r\n"Details
Type
string
Propertypublicint  $POP3_PORT= '110'

Default POP3 port

Default value110Details
Type
int
Propertypublicint  $POP3_TIMEOUT= '30'

Default Timeout

Default value30Details
Type
int
Propertypublic  $connected= ''
Details
Type
n/a
Propertypublicint  $do_debug= '2'

Displaying Debug warnings? (0 = now, 1+ = yes)

Default value2Details
Type
int
Propertypublic  $error= ''
Details
Type
n/a
Propertypublicstring  $host= ''

POP3 Mail Server

Details
Type
string
Propertypublicstring  $password= ''

POP3 Password

Details
Type
string
Propertypublic  $pop_conn= ''
Details
Type
n/a
Propertypublicint  $port= ''

POP3 Port

Details
Type
int
Propertypublicint  $tval= ''

POP3 Timeout Value

Details
Type
int
Propertypublicstring  $username= ''

POP3 Username

Details
Type
string

Methods

methodpublicAuthorise( string $host, integer $port = false, integer $tval = false, string $username, string $password,  $debug_level = 0 ) : void

Combination of public events - connect, login, disconnect

Parameters
Name Type Description
$host string
$port integer
$tval integer
$username string
$password string
$debug_level
methodpublicConnect( string $host, integer $port = false, integer $tval = 30 ) : boolean

Connect to the POP3 server

Parameters
Name Type Description
$host string
$port integer
$tval integer
Returns
Type Description
boolean
methodpublicDisconnect( ) : void

Disconnect from the POP3 server

methodpublicLogin( string $username = '', string $password = '' ) : boolean

Login to the POP3 server (does not support APOP yet)

Parameters
Name Type Description
$username string
$password string
Returns
Type Description
boolean
methodpublicPOP3( ) : \POP3

Constructor, sets the initial values

Returns
Type Description
\POP3
methodpubliccatchWarning( integer $errno, string $errstr, string $errfile, integer $errline ) : void

Takes over from PHP for the socket warning handler

Parameters
Name Type Description
$errno integer
$errstr string
$errfile string
$errline integer
methodpubliccheckResponse( string $string ) : boolean

Checks the POP3 server response for +OK or -ERR

Parameters
Name Type Description
$string string
Returns
Type Description
boolean
methodpublicdisplayErrors( ) : void

If debug is enabled, display the error message array

methodpublicgetResponse( integer $size = 128 ) : string

Get the socket response back.

$size is the maximum number of bytes to retrieve

Parameters
Name Type Description
$size integer
Returns
Type Description
string
methodpublicsendString( string $string ) : integer

Send a string down the open socket connection to the POP3 server

Parameters
Name Type Description
$string string
Returns
Type Description
integer
Documentation was generated by DocBlox 0.18.1.