Class IMP_Mailbox_List_Virtual

This class extends the mailbox message list handling code for virtual mailboxes.

IMP_Mailbox_List implements ArrayAccess, Countable, Iterator, Serializable

IMP_Mailbox_List_Virtual

Package: IMP
Category: Horde
Copyright: 2013-2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Mailbox/List/Virtual.php

Methods summary
`public mixed`	# `unseenMessages( integer $results, array $opts = array() )` Parameters `$results` <p>A Horde_Imap_Client::SEARCH_RESULTS_* constant that indicates the desired return type.</p> `$opts` <p>Additional options: - sort: (array) List of sort criteria to use. - uids: (boolean) Return UIDs instead of sequence numbers (for $results queries that return message lists). DEFAULT: false</p> Returns `mixed` Whatever is requested in $results. Overrides `IMP_Mailbox_List::unseenMessages()`
`public integer`	# `mailboxStart( integer $total )` Parameters `$total` The total number of messages in the mailbox. Returns `integer` The sequence number in the sorted mailbox. Overrides `IMP_Mailbox_List::mailboxStart()`
`public mixed`	# `getArrayIndex( integer $uid, string $mbox = null )` Parameters `$uid` The message UID. `$mbox` <p>The message mailbox (defaults to the current mailbox).</p> Returns `mixed` The array index of the location of the message UID in the current mailbox. Returns null if not found. Overrides `IMP_Mailbox_List::getArrayIndex()`
`public IMP_Indices`	# `getIndicesOb( )` Returns `IMP_Indices` An indices object. Overrides `IMP_Mailbox_List::getIndicesOb()`
`public boolean`	# `removeMsgs( mixed $indices )` Parameters `$indices` <p>An IMP_Indices object or true to remove all messages in the mailbox.</p> Returns `boolean` True if the message was removed from the mailbox. Overrides `IMP_Mailbox_List::removeMsgs()`
`public integer`	# `getBuid( string $mbox, integer $uid )` Parameters `$mbox` The mailbox. `$uid` UID. Returns `integer` Browser-UID. Overrides `IMP_Mailbox_List::getBuid()`
`public array`	# `resolveBuid( integer $buid )` Parameters `$buid` Browser-UID. Returns `array` Two-element array: - m: (IMP_Mailbox) Mailbox of message. - u: (string) UID of message. Overrides `IMP_Mailbox_List::resolveBuid()`

Methods inherited from IMP_Mailbox_List
`__construct(), buildMailboxPage(), count(), current(), getFullThread(), getIndex(), getMailboxArray(), getThreadOb(), isBuilt(), isValidIndex(), key(), next(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), rebuild(), rewind(), serialize(), setIndex(), unserialize(), valid()`

Constants summary
`string`	`IDX_SEP`	# `"\0"`

Constants inherited from IMP_Mailbox_List
`SERIALIZE_LIMIT`

Properties inherited from IMP_Mailbox_List
`$changed`

Packages

Classes

Interfaces

Class IMP_Mailbox_List_Virtual

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides