Auth
[ class tree: Auth ] [ index: Auth ] [ all elements ]

Class: Auth_Container_IMAP

Source Location: /Auth-1.3.0RC7/Container/IMAP.php

Class Overview

Auth_Container
   |
   --Auth_Container_IMAP

Storage driver for fetching login data from a IMAP server


Author(s):

Version:

  • $Revision: 1.12 $

Variables

Methods


Inherited Variables

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::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 75]
Storage driver for fetching login data from a IMAP server

This storage driver authenticates uses against IMAP server.



[ Top ]


Class Variables

$options = array()

[line 84]

Options for the class

Type:   array


[ Top ]



Method Detail

Auth_Container_IMAP (Constructor)   [line 98]

object Returns Auth_Container_IMAP( $params $params)

Constructor of the container class
  • Return: an error object if something went wrong
  • Todo: Use PEAR Net_IMAP if IMAP extension not loaded

Parameters:

$params   $params   —  associative array with host, port, baseDSN, checkServer and userattr key

[ Top ]

fetchData   [line 181]

boolean fetchData( string $username, string $password)

Try to open a IMAP stream using $username / $password

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

Parameters:

string   $username   —  Username
string   $password   —  Password

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:37:16 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.