Class IMP_Auth

THis class provides authentication for IMP.

The following is the list of IMP session variables: - compose_cache: (array) List of compose objects that have not yet been garbage collected. - file_upload: (integer) If file uploads are allowed, the max size. - filteravail: (boolean) Can we apply filters manually? - imap_acl: (boolean) See 'acl' entry in config/backends.php. - imap_admin: (array) See 'admin' entry in config/backends.php. - imap_namespace: (array) See 'namespace' entry in config/backends.php - imap_ob/*: (Horde_Imap_Client_Base) The IMAP client objects. Stored by server key. - imap_quota: (array) See 'quota' entry in config/backends.php. - imap_thread: (string) The trheading algorithm supported by the server. - maildomain: (string) See 'maildomain' entry in config/backends.php. - notepadavail: (boolean) Is listing of notepads available? - pgp: (array) Cached PGP passhprase values. - rteavail: (boolean) Is the HTML editor available? - search: (IMP_Search) The IMP_Search object. - server_key: (string) Server used to login. - smime: (array) Settings related to the S/MIME viewer. - smtp: (array) SMTP options ('host' and 'port') - showunsub: (boolean) Show unsusubscribed mailboxes on the folders screen. - tasklistavail: (boolean) Is listing of tasklists available? - view: (string) Either 'dimp', 'imp', 'mimp', or 'mobile'.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Package: IMP
Category: Horde
License: GPL
Author: Chuck Hagenbuch chuck@horde.org
Author: Jon Parise jon@horde.org
Author: Michael Slusarz slusarz@horde.org
Located at Auth.php

Methods summary
`public static mixed`	# `authenticate( array $credentials = array() )` Authenticate to the mail server. Authenticate to the mail server. Parameters `$credentials` <p>An array of login credentials. If empty, attempts to login to the cached session. - password: (string) The user password. - server: (string) The server key to use (from backends.php). - userId: (string) The username.</p> Returns `mixed` If authentication was successful, and no session exists, an array of data to add to the session. Otherwise returns false. Throws Horde_Auth_Exception
`public static mixed`	# `transparent( Horde_Auth_Application $auth_ob )` Perform transparent authentication. Perform transparent authentication. Parameters `$auth_ob` The authentication object. Returns `mixed` If authentication was successful, and no session exists, an array of data to add to the session. Otherwise returns false.
`public static string`	# `getAutoLoginServer( )` Returns the autologin server key. Returns the autologin server key. Returns `string` The server key, or null if none available.
`public static boolean`	# `isPreferredServer( string $server, string $key = null )` Determines if the given mail server is the "preferred" mail server for this web server. This decision is based on the global 'SERVER_NAME' and 'HTTP_HOST' server variables and the contents of the 'preferred' field in the server's definition. The 'preferred' field may take a single value or an array of multiple values. Determines if the given mail server is the "preferred" mail server for this web server. This decision is based on the global 'SERVER_NAME' and 'HTTP_HOST' server variables and the contents of the 'preferred' field in the server's definition. The 'preferred' field may take a single value or an array of multiple values. Parameters `$server` A complete server entry from the $servers hash. `$key` The server key entry. Returns `boolean` True if this entry is "preferred".
`public static object`	# `getInitialPage( )` Returns the initial page. Returns the initial page. Returns `object` Object with the following properties: - fullpath (string) - mbox (IMP_Mailbox) - page (string) - url (Horde_Url)
`public static`	# `authenticateCallback( )` Perform post-login tasks. Session creation requires the full IMP environment, which is not available until this callback. Perform post-login tasks. Session creation requires the full IMP environment, which is not available until this callback. Throws Horde_Auth_Exception

Packages

Classes

Class IMP_Auth

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Returns

Throws