phpDocumentor PHPMailer
[ class tree: PHPMailer ] [ index: PHPMailer ] [ all elements ]

Class: POP3

Source Location: /core/PHPMailer/class.pop3.php

Class POP3

Class Overview

PHPMailer POP-Before-SMTP Authentication Class.

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

Located in /core/PHPMailer/class.pop3.php [line 30]



		
				Author(s):
		
		
		
Information Tags:

Properties

Methods

[ Top ]
Constant Summary
CRLF   Line break constant

[ Top ]
Property Summary
mixed   $CRLF   POP3 Carriage Return + Line Feed.
mixed   $do_debug   Debug display level.
mixed   $host   POP3 mail server hostname.
mixed   $password   POP3 password.
mixed   $POP3_PORT   Default POP3 port number.
mixed   $POP3_TIMEOUT   Default timeout in seconds.
mixed   $port   POP3 port number.
mixed   $tval   POP3 Timeout Value in seconds.
mixed   $username   POP3 username
mixed   $Version   The POP3 PHPMailer Version number.

[ Top ]
Method Summary
static boolean   popBeforeSmtp()   Simple static wrapper for all-in-one POP before SMTP
boolean   authorise()   Authenticate with a POP3 server.
boolean   connect()   Connect to a POP3 server.
void   disconnect()   Disconnect from the POP3 server.
boolean   login()   Log in to the POP3 server.

[ Top ]
Properties
mixed   $CRLF = "\r\n" [line 59]

POP3 Carriage Return + Line Feed.

API Tags:
Deprecated:  Use the constant instead
Access:  public


[ Top ]
mixed   $do_debug = 0 [line 67]

Debug display level.

Options: 0 = no, 1+ = yes

API Tags:
Access:  public


[ Top ]
mixed   $host [line 74]

POP3 mail server hostname.

API Tags:
Access:  public


[ Top ]
mixed   $password [line 102]

POP3 password.

API Tags:
Access:  public


[ Top ]
mixed   $POP3_PORT = 110 [line 44]

Default POP3 port number.

API Tags:
Access:  public


[ Top ]
mixed   $POP3_TIMEOUT = 30 [line 51]

Default timeout in seconds.

API Tags:
Access:  public


[ Top ]
mixed   $port [line 81]

POP3 port number.

API Tags:
Access:  public


[ Top ]
mixed   $tval [line 88]

POP3 Timeout Value in seconds.

API Tags:
Access:  public


[ Top ]
mixed   $username [line 95]

POP3 username

API Tags:
Access:  public


[ Top ]
mixed   $Version = '5.2.9' [line 37]

The POP3 PHPMailer Version number.

API Tags:
Access:  public


[ Top ]
Methods
static method popBeforeSmtp  [line 140]

  static boolean popBeforeSmtp( $host $host, [boolean $port = false], [boolean $tval = false], [string $username = ''], [string $password = ''], [integer $debug_level = 0]  )

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

Parameters:
boolean   $port: 
boolean   $tval: 
string   $username: 
string   $password: 
integer   $debug_level: 
$host   $host: 

API Tags:
Access:  public


[ Top ]
authorise  [line 165]

  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.

Parameters:
string   $host:  The hostname to connect to
integer|boolean   $port:  The port number to connect to
integer|boolean   $timeout:  The timeout value
string   $username: 
string   $password: 
integer   $debug_level: 

API Tags:
Access:  public


[ Top ]
connect  [line 207]

  boolean connect( string $host, [integer|boolean $port = false], [integer $tval = 30]  )

Connect to a POP3 server.

Parameters:
string   $host: 
integer|boolean   $port: 
integer   $tval: 

API Tags:
Access:  public


[ Top ]
disconnect  [line 296]

  void disconnect( )

Disconnect from the POP3 server.


API Tags:
Access:  public


[ Top ]
login  [line 266]

  boolean login( [string $username = ''], [string $password = '']  )

Log in to the POP3 server.

Does not support APOP (RFC 2828, 4949).

Parameters:
string   $username: 
string   $password: 

API Tags:
Access:  public


[ Top ]
Constants
CRLF = "\r\n" [line 128]

Line break constant


[ Top ]

Documentation generated on Tue, 06 Oct 2015 06:11:16 +0000 by phpDocumentor 1.4.4