UidCollection Class
Represents a list of UIDs of mail messages.
Inheritance Hierarchy

Namespace: MailBee.ImapMail
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5
Syntax
Copy
public class UidCollection : MessageIndexCollection

The UidCollection type exposes the following members.

Constructors
  NameDescription
Public methodUidCollection
Initializes a new instance of the UidCollection class
Top
Methods
  NameDescription
Public methodAdd
Adds the specified UID to the collection.
Public methodAddIndex
Adds the UID specified as string, to the collection.
(Overrides MessageIndexCollectionAddIndex(String).)
Public methodAddRange
Adds the specified range of UIDs to the collection.
(Overrides MessageIndexCollectionAddRange(String, String).)
Public methodAddSet
Adds the specified sequence of message numbers or UIDs to the collection.
(Inherited from MessageIndexCollection.)
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.)
Public methodIndexOf
Returns the zero-based index of the first occurrence of the specified UID in the collection.
Protected methodIsPartOfRange
This member is not intended to be used directly from your code.
(Overrides MessageIndexCollectionIsPartOfRange(Int32).)
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 methodStatic memberParse
Creates a new UidCollection from the specified UID sequence.
Public methodRemoveAt
Removes the element at the specified index of the CollectionBase instance. This method is not overridable.
(Inherited from CollectionBase.)
Public methodToArray
Gets all the items in the collection as an array.
Public methodToString
Returns the message sequence as a string in IMAP4 format.
(Inherited from MessageIndexCollection.)
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.)
Public propertyItem
Gets the UID at the specified zero-based index in the collection.
Protected propertyList
Gets an IList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Top
Remarks

This class implements MessageIndexCollection as a collection of Int64 values.

Note Note
In MailBee, UID is represented as a Int64 value. Actually, UID is a 32-bit unsigned value. Due to this, it's possible to get UID value which won't fit in the range of values allowed for Int32 type (which is 32-bit signed). Although .NET framework supports UInt32 type (32-bit unsigned), not all .NET languages support this type (i.e. it's not CLS-compliant). Also, with UInt32 it's not possible to represent negative values which are used by MailBee to represent invalid data (such as when certain value cannot be parsed).
See Also