EmailAddressCollection Class
Provides properties and methods for managing and examining the collection of the EmailAddress objects.
Inheritance Hierarchy

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

The EmailAddressCollection type exposes the following members.

Constructors
  NameDescription
Public methodEmailAddressCollection
Initializes a new instance of the EmailAddressCollection class
Public methodCode exampleEmailAddressCollection(String)
Initializes a new EmailAddressCollection instance from a string containing e-mail addresses.
Top
Methods
  NameDescription
Public methodCode exampleAdd(String)
Adds the specified e-mail address to the collection.
Public methodCode exampleAdd(EmailAddress)
Adds the specified EmailAddress object to the collection.
Public methodCode exampleAdd(EmailAddressCollection)
Adds the list of the e-mail addresses specified as EmailAddressCollection to the current collection.
Public methodCode exampleAdd(String, String)
Adds the e-mail address (specified as actual e-mail address and display name parts) to the collection.
Public methodCode exampleAdd(String, String, String)
Adds the e-mail address (specified as actual e-mail address, display name and remarks parts) to the collection.
Public methodCode exampleAddFromString
Adds the specified full e-mail addresses (including display name if any) to the collection.
Public methodCode exampleClear
Clears the entire collection of the e-mail addresses.
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 methodFromIdnAddress
Gets a new EmailAddress object which is a copy of the current object with the domain part of each e-mail address converted from IDN format.
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 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 memberCode exampleParse
Creates a new EmailAddressCollection instance from the specified string containing the list of e-mail addresses.
Public methodCode exampleRemove
Removes the specified e-mail address from the collection.
Public methodCode exampleRemoveAt
Removes the EmailAddress object having the the specified zero-based index from the collection.
Public methodToIdnAddress
Gets a new EmailAddressCollection object which is a copy of the current object with the domain part of each e-mail address converted into IDN format.
Public methodCode exampleToString
Returns the string containing all the e-mail addresses in the collection.
(Overrides ObjectToString.)
Top
Operators
  NameDescription
Public operatorStatic member(EmailAddressCollection to String)
Defines an implicit conversion of an e-mail address collection into a string.
Top
Properties
  NameDescription
Public propertyCode exampleAsString
Gets or sets all the e-mail addresses in the collection as a string.
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 propertyCode exampleItem
Gets the EmailAddress object 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
EmailAddressCollection of EmailAddress objects stores multiple e-mail addresses (such as the list of To, CC or BCC recipients).

In the most cases, the developer does not need to directly create an EmailAddress to specify e-mail addresses because the most methods and properties which deal with e-mail addresses also accept string inputs as e-mail address values.

EmailAddressCollection class offers AsString property for this. For instance, to specify MailMessage.To as a string, set msg.To.AsString value (assuming msg is MailMessage instance).

If you need to deal with international e-mail addresses (IDN domains), use FromIdnAddress and ToIdnAddress methods to convert e-mail addresses between human-readable and SMTP-safe formats.

Examples
This sample loads the message from .EML file and displays the e-mail address of each message recipient.
// 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)

// Load the message from file.
MailMessage msg = new MailMessage();
msg.LoadMessage(@"C:\Docs\TestMail.eml");

// For every recipient...
foreach (EmailAddress adr in msg.To)
{
    // Show full information about the recipient's e-mail address.
    Console.WriteLine("Recipient name: " + adr.DisplayName);
    Console.WriteLine("Recipient address: " + adr.Email);
    Console.WriteLine("Recipient info: " + adr.Remarks);
    Console.WriteLine("Account name: " + adr.GetAccountName());
    Console.WriteLine("Domain name: " + adr.GetDomain());
}
See Also