SmtpFailedRecipientsException Class

Definition

Namespace:

System.Net.Mail

Assembly:

System.Net.Mail.dll

Source:

SmtpFailedRecipientsException.cs

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

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

public ref class SmtpFailedRecipientsException : System::Net::Mail::SmtpFailedRecipientException

public class SmtpFailedRecipientsException : System.Net.Mail.SmtpFailedRecipientException

type SmtpFailedRecipientsException = class
    inherit SmtpFailedRecipientException

Public Class SmtpFailedRecipientsException
Inherits SmtpFailedRecipientException

Inheritance

Object

Exception

SmtpException

SmtpFailedRecipientException

SmtpFailedRecipientsException

Examples

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

static void RetryIfBusy( String^ server )
{
   MailAddress^ from = gcnew MailAddress( L"ben@contoso.com" );
   MailAddress^ to = gcnew MailAddress( L"jane@contoso.com" );
   MailMessage^ message = gcnew MailMessage( from,to );
   
   // message.Subject = "Using the SmtpClient class.";
   message->Subject = L"Using the SmtpClient class.";
   message->Body = L"Using this feature, you can send an email message from an application very easily.";
   
   // Add a carbon copy recipient.
   MailAddress^ copy = gcnew MailAddress( L"Notifications@contoso.com" );
   message->CC->Add( copy );
   SmtpClient^ client = gcnew SmtpClient( server );
   
   // Include credentials if the server requires them.
   client->Credentials = dynamic_cast<ICredentialsByHost^>(CredentialCache::DefaultNetworkCredentials);
   Console::WriteLine( L"Sending an email 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( L"Delivery failed - retrying in 5 seconds." );
            System::Threading::Thread::Sleep( 5000 );
            client->Send( message );
         }
         else
         {
            Console::WriteLine( L"Failed to deliver message to {0}", ex->InnerExceptions[ i ] );
         }

      }
   }
   catch ( Exception^ ex )
   {
       Console::WriteLine(L"Exception caught in RetryIfBusy(): {0}", 
                     ex->ToString() );
   }
   finally
   {
      client->~SmtpClient();
   }
}

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 email 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 email 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());
    }
}

Remarks

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

Constructors

SmtpFailedRecipientsException()	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes an empty instance of the SmtpFailedRecipientsException class.
SmtpFailedRecipientsException(SerializationInfo, StreamingContext)	This API supports the product infrastructure and is not intended to be used directly from your code. Obsolete. Initializes a new instance of the SmtpFailedRecipientsException class from the specified instances of the SerializationInfo and StreamingContext classes.
SmtpFailedRecipientsException(String)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the SmtpFailedRecipientsException class with the specified String.
SmtpFailedRecipientsException(String, Exception)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the SmtpFailedRecipientsException class with the specified String and inner Exception.
SmtpFailedRecipientsException(String, SmtpFailedRecipientException[])	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the SmtpFailedRecipientsException class with the specified String and array of type SmtpFailedRecipientException.

Properties

Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
FailedRecipient	Indicates the email address with delivery difficulties. (Inherited from SmtpFailedRecipientException)
HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception)
HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception)
InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception)
InnerExceptions	This API supports the product infrastructure and is not intended to be used directly from your code. Gets one or more SmtpFailedRecipientExceptions that indicate the email recipients with SMTP delivery errors.
Message	Gets a message that describes the current exception. (Inherited from Exception)
Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception)
StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception)
StatusCode	Gets the status code returned by an SMTP server when an email message is transmitted. (Inherited from SmtpException)
TargetSite	Gets the method that throws the current exception. (Inherited from Exception)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. Populates a SerializationInfo instance with the data that is needed to serialize the SmtpFailedRecipientsException.
GetType()	Gets the runtime type of the current instance. (Inherited from Exception)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Creates and returns a string representation of the current exception. (Inherited from Exception)

Events

SerializeObjectState

Obsolete. Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception)