| MessageIndexCollection Class |
Inheritance HierarchySystem.CollectionsCollectionBase
MailBee.ImapMailMessageIndexCollection
MailBee.ImapMailMessageNumberCollection
MailBee.ImapMailUidCollection
Namespace: MailBee.ImapMail
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.4 build 677 for .NET 4.5
SyntaxThe MessageIndexCollection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MessageIndexCollection | Initializes a new instance of the MessageIndexCollection class |
Methods| Name | Description | |
|---|---|---|
 | AddIndex |
When overridden in a derived class, should add the message index (ordinal message number or UID) specified as string, to the collection.
|
| AddRange |
When overridden in a derived class, should add the specified range of message numbers or UIDs to the collection.
|
| AddSet |
Adds the specified sequence of message numbers or UIDs to the collection.
|
| Clear | Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator | Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsPartOfRange |
This member is not intended to be used directly from your code.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnClear | Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
| OnClearComplete | Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
| OnInsert | Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnInsertComplete | Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemove | Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemoveComplete | Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
| OnSet | Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnSetComplete | Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnValidate | Performs additional custom processes when validating a value. (Inherited from CollectionBase.) |
| RemoveAt | Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.) |
| ToString |
Returns the message sequence as a string in IMAP4 format.
(Overrides ObjectToString.) |
Properties| Name | Description | |
|---|---|---|
 | Capacity | Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.) |
| Count | Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.) |
 | InnerList | Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
| List | Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
RemarksThis 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