Class: Auth_Container_POP3

Source Location: /Auth-1.6.1/Container/POP3.php

Class Overview

Auth_Container
   |
   --Auth_Container_POP3

Storage driver for Authentication on a POP3 server.

Author(s):

Adam Ashley <aashley at php.net>
Martin Jansen <mj at php.net>
Mika Tuupola <tuupola at appelsiini.net>

Version:

Release: 1.6.1 File: $Revision: 1.12 $

Copyright:

2001-2006 The PHP Group

Variables

Methods

Inherited Variables

Class: Auth_Container

Auth_Container::$activeUser
Auth_Container::$_auth_obj

Inherited Methods

Class: Auth_Container

Auth_Container::Auth_Container(): Constructor
Auth_Container::addUser(): Add a new user to the storage container
Auth_Container::changePassword(): Change password for user in the storage container
Auth_Container::fetchData(): Fetch data from storage container
Auth_Container::getCryptType(): Returns the crypt current crypt type of the container
Auth_Container::getUser(): Returns a user assoc array
Auth_Container::listUsers(): List all users that are available from the storage container
Auth_Container::log(): Log a message to the Auth log
Auth_Container::removeUser(): Remove user from the storage container
Auth_Container::supportsChallengeResponse(): Returns true if the container supports Challenge Response
Auth_Container::verifyPassword(): Crypt and verfiy the entered password

Class Details

[line 55]
Storage driver for Authentication on a POP3 server.

Author: Adam Ashley <aashley@php.net>
Author: Martin Jansen <mj@php.net>
Author: Mika Tuupola <tuupola@appelsiini.net>
Version: Release: 1.6.1 File: $Revision: 1.12 $
Copyright: 2001-2006 The PHP Group
Link: http://pear.php.net/package/Auth
Since: Class available since Release 1.2.0
License: PHP License 3.01

[ Top ]

Class Variables

$method = true

[line 82]

POP3 Authentication method

Prefered POP3 authentication method. Acceptable values: Boolean TRUE - Use Net_POP3's autodetection String 'DIGEST-MD5','CRAM-MD5','LOGIN','PLAIN','APOP','USER'

Attempt this authentication style first then fallback to autodetection.

Type:

mixed

[ Top ]

$port = '110'

[line 70]

POP3 Server port

Type:

string

[ Top ]

$server = 'localhost'

[line 64]

POP3 Server

Type:

string

[ Top ]

Method Detail

Auth_Container_POP3 (Constructor) [line 93]

object Returns Auth_Container_POP3(
[$server
$server = null])

Constructor of the container class

Return: an error object if something went wrong

Parameters:

$server $server — string server or server:port combination

[ Top ]

fetchData [line 128]

boolean fetchData(
string
$username, string
$password)

Try to login to the POP3 server

Overrides Auth_Container::fetchData() (Fetch data from storage container)

Parameters:

string	`$username`	—	Username
string	`$password`	—	Password

[ Top ]