Class IMP_Imap

The IMP_Imap:: class provides common functions for interaction with IMAP/POP3 servers via the Horde_Imap_Client:: library.

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

IMP_Imap implements Serializable

Package: IMP
Category: Horde
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Imap.php

Methods summary
`public`	# `__get( mixed $key )`
`public Horde_Imap_Client_Base`	# `createImapObject( string $username, string $password, string $key )` Create a new Horde_Imap_Client object. Create a new Horde_Imap_Client object. Parameters `$username` The username to authenticate with. `$password` The password to authenticate with. `$key` Create a new object using this server key. Returns `Horde_Imap_Client_Base` Client object. Throws `IMP_Imap_Exception`
`public array`	# `loadCacheConfig( mixed $config )` Prepare the config parameters necessary to use IMAP caching. Prepare the config parameters necessary to use IMAP caching. Parameters `$config` <p>Either a list of cache config parameters, or a string containing the name of the driver with which to load the cache config from.</p> Returns `array` The configuration array.
`public`	# `updateFetchIgnore( )` Update the list of mailboxes to ignore when caching FETCH data in the IMAP client object. Update the list of mailboxes to ignore when caching FETCH data in the IMAP client object.
`public boolean`	# `access( integer $right )` Checks access rights for a server. Checks access rights for a server. Parameters `$right` Access right. Returns `boolean` Does the mailbox have the access right?
`public array`	# `getNamespaceList( )` Get the namespace list. Get the namespace list. Returns `array` See Horde_Imap_Client_Base#getNamespaces().
`public mixed`	# `getNamespace( string $mailbox = null, boolean $personal = false )` Get namespace info for a full folder path. Get namespace info for a full folder path. Parameters `$mailbox` The folder path. `$personal` <p>If true, will return empty namespace only if it is a personal namespace.</p> Returns `mixed` The namespace info for the folder path or null if the path doesn't exist.
`public mixed`	# `defaultNamespace( )` Get the default personal namespace. Get the default personal namespace. Returns `mixed` The default personal namespace info.
`public Horde_Imap_Client_Utils`	# `getUtils( )` Return the Horde_Imap_Client_Utils object. Return the Horde_Imap_Client_Utils object. Returns `Horde_Imap_Client_Utils` The utility object.
`public mixed`	# `__call( string $method, array $params )` All other calls to this class are routed to the underlying Horde_Imap_Client_Base object. All other calls to this class are routed to the underlying Horde_Imap_Client_Base object. Parameters `$method` Method name. `$params` Method Parameters. Returns `mixed` The return from the requested method. Throws BadMethodCallException `IMP_Imap_Exception`
`public static mixed`	# `loadServerConfig( string $server = null )` Loads the IMP server configuration from backends.php. Loads the IMP server configuration from backends.php. Parameters `$server` Returns this labeled entry only. Returns `mixed` If $server is set return this entry; else, return the entire servers array. Returns false on error.
`public static`	# `getEncryptKey( )`
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Implementation of `Serializable::unserialize()`

Constants summary
`integer`	`ACCESS_FOLDERS`	# `1`
`integer`	`ACCESS_SEARCH`	# `2`
`integer`	`ACCESS_FLAGS`	# `3`
`integer`	`ACCESS_UNSEEN`	# `4`
`integer`	`ACCESS_TRASH`	# `5`

Properties summary
`public Horde_Imap_Client`	`$ob` The Horde_Imap_Client object. The Horde_Imap_Client object.	# `null`

Magic properties summary
`public boolean`	`$changed` If true, this object has changed.
`public boolean`	`$imap` If true, this is an IMAP connection.
`public boolean`	`$pop3` If true, this is a POP3 connection.

Packages

Classes

Class IMP_Imap

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Implementation of

Implementation of