This topic has not yet been rated - Rate this topic

SmtpException Class

Represents the exception that is thrown when the SmtpClient is not able to complete a Send or SendAsync operation.

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

Namespace:  System.Net.Mail
Assembly:  System (in System.dll)
[SerializableAttribute]
public class SmtpException : Exception, 
	ISerializable

The SmtpException type exposes the following members.

  Name Description
Public method SmtpException() Initializes a new instance of the SmtpException class.
Public method SmtpException(SmtpStatusCode) Initializes a new instance of the SmtpException class with the specified status code.
Public method SmtpException(String) Initializes a new instance of the SmtpException class with the specified error message.
Protected method SmtpException(SerializationInfo, StreamingContext) Infrastructure. Initializes a new instance of the SmtpException class from the specified instances of the SerializationInfo and StreamingContext classes.
Public method SmtpException(SmtpStatusCode, String) Initializes a new instance of the SmtpException class with the specified status code and error message.
Public method SmtpException(String, Exception) Initializes a new instance of the SmtpException class with the specified error message and inner exception.
Top
  Name Description
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public property HelpLink Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Protected property HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Message Gets a message that describes the current exception. (Inherited from Exception.)
Public property Source Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property StatusCode Gets the status code returned by an SMTP server when an e-mail message is transmitted.
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectData Populates a SerializationInfo instance with the data needed to serialize the SmtpException. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
Public method GetType Gets the runtime type of the current instance. (Inherited from Exception.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Creates and returns a string representation of the current exception. (Inherited from Exception.)
Top
  Name Description
Protected event SerializeObjectState Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top
  Name Description
Explicit interface implemetation Private method ISerializable.GetObjectData Populates a SerializationInfo instance with the data needed to serialize the SmtpException.
Top

The StatusCode property contains the status code returned by the SMTP server.

The following code example displays an error message when the SmtpException exception is thrown.


		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, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Example should not show retries for MailboxUnavailable status
It is generally accepted that a 550 return error (MailboxUnavailable) should be treated as a failure error and shouldn't generally be retried. The MailboxBusy is a good one to retry on. $0$0 $0