Export (0) Print
Expand All

MailAddressCollection Class

Store e-mail addresses that are associated with an e-mail message.

Namespace:  System.Net.Mail
Assembly:  System (in System.dll)

public ref class MailAddressCollection : public Collection<MailAddress^>

The MailAddressCollection type exposes the following members.

  NameDescription
Public methodMailAddressCollectionInitializes an empty instance of the MailAddressCollection class.
Top

  NameDescription
Public propertyCountGets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.)
Public propertyItemGets or sets the element at the specified index. (Inherited from Collection<T>.)
Protected propertyItemsGets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.)
Top

  NameDescription
Public methodAdd(T)Adds an object to the end of the Collection<T>. (Inherited from Collection<T>.)
Public methodAdd(String)Add a list of e-mail addresses to the collection.
Public methodClearRemoves all elements from the Collection<T>. (Inherited from Collection<T>.)
Protected methodClearItemsRemoves all elements from the Collection<T>. (Inherited from Collection<T>.)
Public methodContainsDetermines whether an element is in the Collection<T>. (Inherited from Collection<T>.)
Public methodCopyToCopies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfSearches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.)
Public methodInsertInserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.)
Protected methodInsertItemInserts an e-mail address into the MailAddressCollection, at the specified location. (Overrides Collection<T>::InsertItem(Int32, T).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.)
Public methodRemoveAtRemoves the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected methodRemoveItemRemoves the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected methodSetItemReplaces the element at the specified index. (Overrides Collection<T>::SetItem(Int32, T).)
Public methodToStringReturns a string representation of the e-mail addresses in this MailAddressCollection object. (Overrides Object::ToString().)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection::CopyToCopies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection<T>::IsReadOnlyGets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection::IsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection::SyncRootGets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIEnumerable::GetEnumeratorReturns an enumerator that iterates through a collection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList::AddAdds an item to the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList::ContainsDetermines whether the IList contains a specific value. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList::IndexOfDetermines the index of a specific item in the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList::InsertInserts an item into the IList at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList::IsFixedSizeGets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList::IsReadOnlyGets a value indicating whether the IList is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList::ItemGets or sets the element at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList::RemoveRemoves the first occurrence of a specific object from the IList. (Inherited from Collection<T>.)
Top

The MailMessage::To, MailMessage::CC, and MailMessage::Bcc properties return instances of this class that are used to hold the respective e-mail addresses.

For details on the mail address formats supported by the MailAddressCollection class, see the MailAddress class.

The following example adds an e-mail address to the MailAddressCollection that is returned by the Bcc property.

   static void CreateBccTestMessage( String^ server )
   {
      MailAddress^ from = gcnew MailAddress( L"ben@contoso.com",L"Ben Miller" );
      MailAddress^ to = gcnew MailAddress( L"jane@contoso.com",L"Jane Clayton" );
      MailMessage^ message = gcnew MailMessage( from,to );
      message->Subject = L"Using the SmtpClient class.";
      message->Body = L"Using this feature, you can send an e-mail message from an application very easily.";
      MailAddress^ bcc = gcnew MailAddress( L"manager1@contoso.com" );
      message->Bcc->Add( bcc );
      SmtpClient^ client = gcnew SmtpClient( server );
      client->Credentials = CredentialCache::DefaultNetworkCredentials;
      Console::WriteLine( L"Sending an e-mail message to {0} and {1}.", to->DisplayName, message->Bcc );
      try
      { 
          client->Send( message );
      }
      catch ( Exception^ ex )
      {
          Console::WriteLine(L"Exception caught in CreateBccTestMessage(): {0}", 
                        ex->ToString() );
      }
      client->~SmtpClient();
   }

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft