SmtpServerCollection Class

Represents a sorted collection of SmtpServer objects.

Inheritance Hierarchy

SystemObject
  System.CollectionsCollectionBase
    MailBeeSortableByPriorityCollection
      MailBee.SmtpMailSmtpServerCollection

Namespace: MailBee.SmtpMail
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5

Syntax

Copy

[SerializableAttribute]
public class SmtpServerCollection : SortableByPriorityCollection

<SerializableAttribute>
Public Class SmtpServerCollection
	Inherits SortableByPriorityCollection

The SmtpServerCollection type exposes the following members.

Constructors

	Name	Description
	SmtpServerCollection	Initializes a new instance of the SmtpServerCollection class

Top

Methods

	Name	Description
	Add(String)	Adds a top (0) priority SMTP relay server under the specified host name (or IP address string) to the collection and sorts the collection according to the elements priorities.
	Add(SmtpServer)	Adds an SmtpServer to the collection and sorts the collection according to the elements priorities.
	Add(String, Int32, Int32)	Initializes a new instance of the SmtpServer class with the given host name (or IP address string), port number and priority value, adds this instance into the collection, and sorts the collection according to the elements priorities.
	Add(String, String, String)	Adds a top (0) priority SMTP relay server under the specified host name (or IP address string) to the collection, enables ESMTP authentication for this server, and sorts the collection according to the elements priorities.
	Add(String, String, String, AuthenticationMethods)	Adds a top (0) priority SMTP relay server under the specified host name (or IP address string) to the collection, enables ESMTP authentication for this server using the specified methods, and sorts the collection according to the elements priorities.
	Add(String, Int32, Int32, Int32, Boolean, AuthenticationMethods, String, String, Boolean, String, ExtendedSmtpOptions)	Initializes a new instance of the SmtpServer class with the given parameter values, adds this instance to the collection, and sorts the collection according to the elements priorities.
	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.)
	Remove	Removes the specified SmtpServer object from the collection.
	RemoveAt	Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
	SortByPriority	Sorts the items in the collection by their priority value. (Inherited from SortableByPriorityCollection.)
	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 element at the specified index.
	List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)

Top

Remarks

When SmtpServers collection is populated with at least one SMTP relay server of the same or higher priority than the top priority DNS server in DnsServers collection (or DnsServers collection is empty), Smtp component will attempt to send the mail message to the first SMTP relay server in SmtpServers collection. If it fails, MailBee will attempt to connect and send to lower priority SMTP relay servers. If this fails too and DnsServers collection is not empty, the mail message will be sent in direct send mode.

If the top priority SMTP relay server has lower priority than the top priority DNS server in DnsServers collection, Smtp component will attempt to send the mail message in direct send mode, and then try to send to SMTP relay servers if certain recipients failed during direct send.

When Connect method is called (rather than Send), the Smtp component will attempt to connect to the SMTP relay servers in the same way as described above. However, if all SMTP relay servers failed, no attempt to perform direct send is made (because Connect method does not send any mail messages, it only connects to an SMTP relay server). In other words, when the connection is established via explicit call to Connect method, direct send mode and DnsServers collection are never used.

Reference

MailBee.SmtpMail Namespace