MailMessageCollection Class

Provides properties and methods for managing and examining the collection of MailMessage objects.

Inheritance Hierarchy

SystemObject
System.CollectionsCollectionBase
MailBee.MimeMailMessageCollection

Namespace: MailBee.Mime
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.4 build 677 for .NET 4.5

Syntax

Copy

public class MailMessageCollection : CollectionBase

Public Class MailMessageCollection
	Inherits CollectionBase

The MailMessageCollection type exposes the following members.

Constructors

	Name	Description
	MailMessageCollection	Initializes a new instance of the MailMessageCollection class

Top

Methods

	Name	Description
	Add(MailMessage)	Adds the specified MailMessage object to the collection.
	Add(MailMessageCollection)	Adds the contents of the specified MailMessageCollection the current 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.)
	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.)
	Reverse	Reverses the order of the list of the messages that are stored in the collection.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.)
	Item	Gets or sets the MailMessage object at the specified zero-based index in the collection.
	List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)

Top

Remarks

This collection is not read-only. You can add messages to this collection using Add(MailMessage) method and reverse the collection using Reverse method. Reverse method is useful if you have received a list of messages from the mail server (for instance, using DownloadMessageHeaders(Int32, Int32, Int32) method) and new messages appear last in this list. To make newer messages be listed first, call Reverse on the returned collection.

Examples

This sample loads the message from .EML file and adds this message to a new collection.

Copy

// To use the code below, import MailBee namespaces at the top of your code.
using MailBee;
using MailBee.Mime;

// The actual code (put it into a method of your class).
MailMessage msg = new MailMessage();
msg.LoadMessage(@"C:\Docs\TestMail.eml");
MailMessageCollection msgColl = new MailMessageCollection();
msgColl.Add(msg);

' To use the code below, import MailBee namespaces at the top of your code.
Imports MailBee
Imports MailBee.Mime

' The actual code (put it into a method of your class).
Dim msg As New MailMessage
msg.LoadMessage("C:\Docs\TestMail.eml")
Dim msgColl = New MailMessageCollection
msgColl.Add(msg)

Reference

MailBee.Mime Namespace

MailBee.MimeMailMessage