MessageIndexCollection Class
Represents an abstract list of indices (such as ordinal message numbers or UIDs) of mail messages.
Inheritance Hierarchy

Namespace: MailBee.ImapMail
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 11.2.0 build 590 for .NET 4.5
Syntax
public abstract class MessageIndexCollection : CollectionBase

The MessageIndexCollection type exposes the following members.

Constructors
  NameDescription
Protected methodMessageIndexCollection
Initializes a new instance of the MessageIndexCollection class
Top
Methods
  NameDescription
Public methodAddIndex
When overridden in a derived class, should add the message index (ordinal message number or UID) specified as string, to the collection.
Public methodAddRange
When overridden in a derived class, should add the specified range of message numbers or UIDs to the collection.
Public methodAddSet
Adds the specified sequence of message numbers or UIDs to the collection.
Public methodClear
Removes all objects from the CollectionBase instance. This method cannot be overridden.
(Inherited from CollectionBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the CollectionBase instance.
(Inherited from CollectionBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodIsPartOfRange
This member is not intended to be used directly from your code.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnClear
Performs additional custom processes when clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnClearComplete
Performs additional custom processes after clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsert
Performs additional custom processes before inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsertComplete
Performs additional custom processes after inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemove
Performs additional custom processes when removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemoveComplete
Performs additional custom processes after removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSet
Performs additional custom processes before setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSetComplete
Performs additional custom processes after setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnValidate
Performs additional custom processes when validating a value.
(Inherited from CollectionBase.)
Public methodRemoveAt
Removes the element at the specified index of the CollectionBase instance. This method is not overridable.
(Inherited from CollectionBase.)
Public methodToString
Returns the message sequence as a string in IMAP4 format.
(Overrides ObjectToString.)
Top
Properties
  NameDescription
Public propertyCapacity
Gets or sets the number of elements that the CollectionBase can contain.
(Inherited from CollectionBase.)
Public propertyCount
Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden.
(Inherited from CollectionBase.)
Protected propertyInnerList
Gets an ArrayList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected propertyList
Gets an IList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Top
Remarks

This class is an abstract parent of MessageNumberCollection and UidCollection classes.

Some methods of the Imap object (such as Search(Boolean, String, String)) can return both a collection of ordinal message numbers (MessageNumberCollection) and a collection of UIDs (UidCollection). The type of the returned collection is contolled via indexIsUid parameter value of these methods. Also, the developer should typecast the returned value to the appropriate type (MessageNumberCollection or UidCollection). See the sample code in Search(Boolean, String, String) topic for more information.

MessageNumberCollection and UidCollection classes can also be used to build and parse sequences of UIDs or message numbers in IMAP4 format (e.g. "5,8,14:22,24:26,35").

See Also