Authentication IMAP

Authenticate the user on an IMAP server. The server can be secured by SSL.

The class definition

Class Domframework\Authimap

Namespace Domframework

Description

/**
 User authentication against IMAP server

Properties

public $appName;

/**
 The application name

public $imapPort=143;

/**
 IMAP TCP port (143 by default)

public $imapSSL=false;

/**
 IMAP SSL connection

public $imapSSLCheckCertificates=true;

/**
 IMAP SSL CheckCertificate

public $imapServer="localhost";

/**
 IMAP server

Methods

public function __construct ()

/**
 Check the availablity of the IMAP support in PHP

public function authentication ( $email, $password)

/**
 Try to authenticate the email/password of the user
 @param string $email Email to authenticate
 @param string $password Password to authenticate

public function changepassword ( $oldpassword, $newpassword)

/**
 Method to change the password
 @param string $oldpassword The old password (to check if the user have the
 rights to change the password)
 @param string $newpassword The new password to be recorded

public function connect ()

/**
 Establish the connection to IMAP server. Don't do anything as the
 needed parameters are username and password

public function getdetails ()

/**
 Return all the parameters recorded for the authenticate user

public function listusers ()

/**
 List all the users available in the database
 Return firstname, lastname, mail, with mail is an array

public function logout ()

/**
 Method to disconnect the authenticated user

public function overwritepassword ( $email, $newpassword)

/**
 Method to overwrite the password (without oldpassword check)
 Must be reserved to the administrators. For the users, use changepassword
 method
 @param string $email the user identifier to select
 @param string $newpassword The new password to be recorded

public function pageHTML ( $baseURL, $message="", $url="", $alreadyAuth=false)

/**
 Display the authentication page
 The message is displayed to the user in case of error
 The url is the caller url to go back if authentication is correct
 @param string $baseURL The URL base to use for the links
 @param string|null $message Message to display to the user
 @param string|null $url URL to go back after successful authentication
 @param mixed $alreadyAuth If the user is already authenticated, the value
 will be displayed if the user is coming on the page.