Class IMP_Mailbox_List_Track

This class contains code related to generating and handling a mailbox message list. This class will keep track of the current index within a mailbox.

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

IMP_Mailbox_List implements ArrayAccess, Countable, Iterator, Serializable

IMP_Mailbox_List_Track

Package: IMP
Category: Horde
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Mailbox/List/Track.php

Methods summary
`public integer`	# `getMessageIndex( )` Returns the current message array index. If the array index has run off the end of the message array, will return the last index. Returns the current message array index. If the array index has run off the end of the message array, will return the last index. Returns `integer` The message array index.
`public boolean`	# `isValidIndex( )` Checks to see if the current index is valid. Checks to see if the current index is valid. Returns `boolean` True if index is valid, false if not.
`public array`	# `getIMAPIndex( integer $offset = 0 )` Returns IMAP mbox/UID information on a message. Returns IMAP mbox/UID information on a message. Parameters `$offset` The offset from the current message. Returns `array` Array with the following entries: 'mailbox' - (IMP_Mailbox) The mailbox. 'uid' - (integer) The message UID.
`public array`	# `buildMailboxPage( integer $page = 0, integer $start = 0, mixed $opts = array() )` Using the preferences and the current mailbox, determines the messages to view on the current page. Using the preferences and the current mailbox, determines the messages to view on the current page. Parameters `$page` The page number currently being displayed. `$start` The starting message number. `$opts` Returns `array` An array with the following fields: anymsg: (boolean) Are there any messages at all in mailbox? E.g. If 'msgcount' is 0, there may still be hidden deleted messages. begin: (integer) The beginning message sequence number of the page. end: (integer) The ending message sequence number of the page. index: (integer) The index of the starting message. msgcount: (integer) The number of viewable messages in the current mailbox. page: (integer) The current page number. pagecount: (integer) The number of pages in this mailbox. Overrides `IMP_Mailbox_List::buildMailboxPage()`
`public`	# `setIndex( mixed $data )` Updates the message array index. Updates the message array index. Parameters `$data` <p>If an integer, the number of messages to increase array index by. If an indices object, sets array index to the index value. If null, rebuilds the internal index.</p>
`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()`

Methods inherited from IMP_Mailbox_List
`__construct(), count(), current(), getArrayIndex(), getIndicesOb(), getMailboxArray(), getThreadOb(), isBuilt(), key(), mailboxStart(), newMessages(), next(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), rebuild(), rewind(), serialize(), unseenMessages(), unserialize(), valid()`

Constants inherited from IMP_Mailbox_List
`VERSION`

Properties summary
`public boolean`	`$checkcache` Check the IMAP cache ID? Check the IMAP cache ID?	# `true`

Properties inherited from IMP_Mailbox_List
`$changed`

Packages

Classes

Class IMP_Mailbox_List_Track

Returns

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Parameters

Returns

Overrides