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

Show:

inherited

Classes
- \POP3

Table of Contents

\POP3
jump to top

Package:

Properties

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

POP3 Carriage Return + Line Feed

Default value"\r\n"Details

Type: string

int
                 $POP3_PORT= '110'

Default POP3 port

Default value110Details

Type: int

int
                 $POP3_TIMEOUT= '30'

Default Timeout

Default value30Details

Type: int


                 $connected= ''

Details

Type: n/a

int
                 $do_debug= '2'

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

Default value2Details

Type: int


                 $error= ''

Details

Type: n/a

string
                 $host= ''

POP3 Mail Server

Details

Type: string

string
                 $password= ''

POP3 Password

Details

Type: string


                 $pop_conn= ''

Details

Type: n/a

int
                 $port= ''

POP3 Port

Details

Type: int

int
                 $tval= ''

POP3 Timeout Value

Details

Type: int

string
                 $username= ''

POP3 Username

Details

Type: string

Methods

Authorise(
          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

Connect(
          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

Disconnect(
          
          )
        
        :
          void

Disconnect from the POP3 server

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

Parameters

Name	Type	Description
$username	string
$password	string

Returns

Type	Description
boolean

Constructor, sets the initial values

Returns

Type	Description
\POP3

catchWarning(
          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

checkResponse(
          string $string
          )
        
        :
          boolean

Checks the POP3 server response for +OK or -ERR

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
boolean

displayErrors(
          
          )
        
        :
          void

If debug is enabled, display the error message array

getResponse(
          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

sendString(
          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

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

\POP3jump to top

Properties

Methods

\POP3
jump to top