Class Horde_Imap_Client_Ids

An object that provides a way to identify a list of IMAP indices.

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

Horde_Imap_Client_Ids implements Countable, Iterator, Serializable

Direct known subclasses

Horde_Imap_Client_Ids_Pop3

Package: Imap\Client
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Imap/Client/Ids.php

Methods summary
`public`	# `__construct( mixed $ids = null, boolean $sequence = false )` Constructor. Constructor. Parameters `$ids` See self::add(). `$sequence` Are $ids message sequence numbers?
`public`	# `__get( mixed $name )`
`public`	# `__toString( )`
`public`	# `add( mixed $ids )` Add IDs to the current object. Add IDs to the current object. Parameters `$ids` <p>Either self::ALL, self::SEARCH_RES, Horde_Imap_Client_Ids object, array, or string.</p>
`public boolean`	# `isEmpty( )` Is this object empty (i.e. does not contain IDs)? Is this object empty (i.e. does not contain IDs)? Returns `boolean` True if object is empty.
`public`	# `reverse( )`
`public`	# `count( )` Implementation of `Countable::count()`
`public`	# `current( )` Implementation of `Iterator::current()`
`public`	# `key( )` Implementation of `Iterator::key()`
`public`	# `next( )` Implementation of `Iterator::next()`
`public`	# `rewind( )` Implementation of `Iterator::rewind()`
`public`	# `valid( )` Implementation of `Iterator::valid()`
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Implementation of `Serializable::unserialize()`

Constants summary
`string`	`ALL`	# `"\01"`
`string`	`SEARCH_RES`	# `"\02"`

Magic properties summary
`public boolean`	`$all` Does this represent an ALL message set?
`public array`	`$ids` The list of IDs.
`public boolean`	`$search_res` Does this represent a search result?
`public boolean`	`$sequence` Are these sequence IDs? If false, these are UIDs.
`public boolean`	`$tostring` Return the non-sorted string representation.
`public boolean`	`$tostring_sort` Return the sorted string representation.

Packages

Classes

Class Horde_Imap_Client_Ids

Direct known subclasses

Parameters

Parameters

Returns

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of