Export (0) Print
Expand All

SmtpFailedRecipientsException Class

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

The exception that is thrown when e-mail is sent using an SmtpClient and cannot be delivered to all recipients.

System.Object
  System.Exception
    System.Net.Mail.SmtpException
      System.Net.Mail.SmtpFailedRecipientException
        System.Net.Mail.SmtpFailedRecipientsException

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

[SerializableAttribute]
public class SmtpFailedRecipientsException : SmtpFailedRecipientException, 
	ISerializable

The SmtpFailedRecipientsException type exposes the following members.

  NameDescription
Public methodSmtpFailedRecipientsException()Initializes an empty instance of the SmtpFailedRecipientsException class.
Public methodSmtpFailedRecipientsException(String)Initializes a new instance of the SmtpFailedRecipientsException class with the specified String.
Protected methodSmtpFailedRecipientsException(SerializationInfo, StreamingContext)Initializes a new instance of the SmtpFailedRecipientsException class from the specified instances of the SerializationInfo and StreamingContext classes.
Public methodSmtpFailedRecipientsException(String, Exception)Initializes a new instance of the SmtpFailedRecipientsException class with the specified String and inner Exception.
Public methodSmtpFailedRecipientsException(String, SmtpFailedRecipientException[])Initializes a new instance of the SmtpFailedRecipientsException class with the specified String and array of type SmtpFailedRecipientException.
Top

  NameDescription
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyFailedRecipientIndicates the e-mail address with delivery difficulties. (Inherited from SmtpFailedRecipientException.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyInnerExceptionsGets one or more SmtpFailedRecipientExceptions that indicate the e-mail recipients with SMTP delivery errors.
Public propertyMessageGets a message that describes the current exception. (Inherited from Exception.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertyStatusCodeGets the status code returned by an SMTP server when an e-mail message is transmitted. (Inherited from SmtpException.)
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top

  NameDescription
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 methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetObjectDataInfrastructure. Populates a SerializationInfo instance with the data that is needed to serialize the SmtpFailedRecipientsException. (Overrides SmtpFailedRecipientException.GetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType()Gets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top

  NameDescription
Protected eventSerializeObjectStateOccurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top

  NameDescription
Explicit interface implemetationPrivate methodISerializable.GetObjectDataInfrastructure. Initializes a new instance of the SmtpFailedRecipientsException class from the specified SerializationInfo and StreamingContext instances.
Top

The InnerExceptions property contains the exceptions received while attempting to send e-mail. The e-mail might have been successfully delivered to some of the recipients.

The following code example resends an e-mail message that was not delivered because a mailbox was busy or unavailable.

		public static void RetryIfBusy(string server)
		{
			MailAddress from = new MailAddress("ben@contoso.com");
			MailAddress to = new MailAddress("jane@contoso.com");
			MailMessage message = new MailMessage(from, to);
			// message.Subject = "Using the SmtpClient class.";
			message.Subject = "Using the SmtpClient class.";
			message.Body = @"Using this feature, you can send an e-mail message from an application very easily.";
			// Add a carbon copy recipient.
			MailAddress copy = new MailAddress("Notifications@contoso.com");
			message.CC.Add(copy);
			SmtpClient client = new SmtpClient(server);
			// Include credentials if the server requires them.
			client.Credentials = (ICredentialsByHost)CredentialCache.DefaultNetworkCredentials;
			Console.WriteLine("Sending an e-mail message to {0} using the SMTP host {1}.",
				 to.Address, client.Host);
			try
			{
				client.Send(message);
			}
			catch (SmtpFailedRecipientsException ex)
			{
				for (int i = 0; i < ex.InnerExceptions.Length; i++)
				{
					SmtpStatusCode status = ex.InnerExceptions[i].StatusCode;
					if (status == SmtpStatusCode.MailboxBusy ||
						status == SmtpStatusCode.MailboxUnavailable)
					{
						Console.WriteLine("Delivery failed - retrying in 5 seconds.");
						System.Threading.Thread.Sleep(5000);
						client.Send(message);
					}
					else
					{
						Console.WriteLine("Failed to deliver message to {0}", 
						    ex.InnerExceptions[i].FailedRecipient);
					}
				}
			}
            catch (Exception ex)
            {
                Console.WriteLine("Exception caught in RetryIfBusy(): {0}", 
                        ex.ToString() );
            }
        }

.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