Class IMP_Imap

Provides common functions for interaction with IMAP/POP3 servers via the Horde_Imap_Client package.

IMP_Imap implements Serializable

Direct known subclasses

Package: IMP
Category: Horde
Copyright: 2008-2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Imap.php

Methods summary
`public`	# `__construct( string $id )` Constructor. Constructor. Parameters `$id` Object identifier.
`public`	# `__get( mixed $key )`
`public`	# `__toString( )`
`public boolean`	# `isImap( )` Determine if this is a connection to an IMAP server. Determine if this is a connection to an IMAP server. Returns `boolean` True if connected to IMAP server.
`public boolean`	# `isPop3( )` Determine if this is a connection to an IMAP server. Determine if this is a connection to an IMAP server. Returns `boolean` True if connected to IMAP server.
`public Horde_Imap_Client_Base`	# `createBaseImapObject( string $username, string $password, string $skey )` Create the base Horde_Imap_Client object (from an entry in backends.php). Create the base Horde_Imap_Client object (from an entry in backends.php). Parameters `$username` The username to authenticate with. `$password` The password to authenticate with. `$skey` Create a new object using this server key. Returns `Horde_Imap_Client_Base` Client object. Throws `IMP_Imap_Exception`
`public Horde_Imap_Client_Base`	# `createImapObject( array $config, boolean $imap = true )` Create a Horde_Imap_Client object. Create a Horde_Imap_Client object. Parameters `$config` The IMAP configuration. `$imap` True if IMAP connection, false if POP3. Returns `Horde_Imap_Client_Base` Client object. Throws `IMP_Imap_Exception`
`public`	# `doPostLoginTasks( )` Perform post-login tasks. Perform post-login tasks.
`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 access right exist?
`public boolean`	# `accessCompose( integer $right, integer $data )` Checks compose access rights for a server. Checks compose access rights for a server. Parameters `$right` Access right. `$data` <p>Data required to check the rights: - ACCESS_COMPOSE_BODYSIZE The size of the body data.</p> <ul> <li>ACCESS_COMPOSE_RECIPIENTS</li> <li>ACCESS_COMPOSE_TIMELIMIT The number of e-mail recipients.</li> </ul> Returns `boolean` Is the access allowed?
`public mixed`	# `getNamespace( string $mailbox, boolean $personal = false )` Get namespace info for a full mailbox path. Get namespace info for a full mailbox path. Parameters `$mailbox` <p>The mailbox path. (self:NS_DEFAULT will return the default personal namespace.)</p> `$personal` <p>If true, will return empty namespace only if it is a personal namespace.</p> Returns `mixed` The namespace info for the mailbox path or null if the path doesn't exist.
`public string`	# `getCacheId( string $mailbox, array $addl = array() )` Return the cache ID for this mailbox. Return the cache ID for this mailbox. Parameters `$mailbox` The mailbox name (UTF-8). `$addl` Local IMP metadata to add to the cache ID. Returns `string` The cache ID.
`public array`	# `parseCacheId( string $id )` Parses the cache ID for this mailbox. Parses the cache ID for this mailbox. Parameters `$id` Cache ID generated by getCacheId(). Returns `array` Two element array: - date: (integer) Date information (day of year), if embedded in cache ID. - token: (string) Mailbox sync token.
`public array`	# `getSlices( string $mbox, Horde_Imap_Client_Ids $ids, integer $size = 5242880 )` Returns a list of messages, split into slices based on the total message size. Returns a list of messages, split into slices based on the total message size. Parameters `$mbox` IMAP mailbox. `$ids` ID list. `$size` Maximum size of a slice. Returns `array` An array of Horde_Imap_Client_Ids objects.
`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`	# `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`
`integer`	`ACCESS_CREATEMBOX`	# `6`
`integer`	`ACCESS_CREATEMBOX_MAX`	# `7`
`integer`	`ACCESS_COMPOSE_BODYSIZE`	# `13`
`integer`	`ACCESS_COMPOSE_RECIPIENTS`	# `8`
`integer`	`ACCESS_COMPOSE_TIMELIMIT`	# `9`
`integer`	`ACCESS_ACL`	# `10`
`integer`	`ACCESS_DRAFTS`	# `11`
`integer`	`ACCESS_REMOTE`	# `12`
`integer`	`ACCESS_IMPORT`	# `14`
`integer`	`ACCESS_SORT`	# `15`
`string`	`NS_DEFAULT`	# `"\0default"`

Magic properties summary
`public boolean`	`$changed` If true, this object has changed.
`public Horde_Imap_Client_Base`	`$client_ob` The IMAP client object.
`public IMP_Imap_Config`	`$config` Base backend config settings.
`public boolean`	`$init` Has the IMAP object been initialized?
`public integer`	`$max_compose_bodysize` The maximum size (in bytes) of the compose message body.
`public integer`	`$max_compose_recipients` The maximum number of recipients to send to per compose message.
`public integer`	`$max_compose_timelimit` The maximum number of recipients to send to in the configured timelimit.
`public integer`	`$max_create_mboxes` The maximum number of mailboxes a user can create.
`public string`	`$server_key` Server key used to login.
`public string`	`$thread_algo` The threading algorithm to use.
`public Horde_Imap_Client_Url`	`$url` A URL object.

Packages

Classes

Interfaces

Class IMP_Imap

Direct known subclasses

Parameters

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Implementation of

Implementation of