Indy 9 | Content | Index | Reference

TIdMessageCollection
Hierarchy, Properties, Methods, See Also, Unit: IdMessageCollection
Implements a collection for Indy messages.

    TIdMessageCollection = class(TCollection)

Unit
IdMessageCollection
Description
TIdMessageCollection is a TCollection descendant that implements a container for TIdMessageItem object instances. TIdMessageCollection is the type used for the TIdMailbox.MessageList property, and when retrieving messages and headers using an IMAP4 client.

TIdMessageCollection enhances the ancestor class by insuring that collection items added to the container are TIdMessageItem instances.

TIdMessageCollection extends the ancestor class by providing indexed access to TIdMessage instances in the container using the Messages property.

TIdMessageCollection.Messages
TIdMessageCollection, See Also
Allows access to the message property in a collection item.

    property Messages [index: Integer]: TIdMessage;

Description
Messages is an Integer indexed TIdMessage property that provides access to the TIdMessage contained in a collection item. Index values must be in the range 0 .. Count-1.

TIdMessageCollection.Add
TIdMessageCollection, See Also
Adds new message items to the collection.

    function Add: TIdMessageItem;

Return Value
TIdMessageItem - new collection item added to the collection.
Description
Add is an overridden TIdMessageItem function that creates new items in the collection. Add insures that collection items are cast to a TIdMessageItem instance after calling the inherited Add method.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.