SmtpClient::Timeout Property

 

Gets or sets a value that specifies the amount of time after which a synchronous Send call times out.

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

public:
property int Timeout {
	int get();
	void set(int value);
}

Property Value

Type: System::Int32

An Int32 that specifies the time-out value in milliseconds. The default value is 100,000 (100 seconds).

Exception Condition
ArgumentOutOfRangeException

The value specified for a set operation was less than zero.

InvalidOperationException

You cannot change the value of this property when an email is being sent.

By default, calls to the Send method block until the operation completes. If you set the Timeout property to a positive value, and a Send operation cannot complete in the allotted time, the SmtpClient class throws an SmtpException exception.

To send a message and continue executing in the application thread, use the SendAsync method.

The following code example demonstrates getting and setting the time-out value.

static void CreateTimeoutTestMessage( String^ server )
{
   String^ to = L"jane@contoso.com";
   String^ from = L"ben@contoso.com";
   String^ subject = L"Using the new SMTP client.";
   String^ body = L"Using this new feature, you can send an e-mail message from an application very easily.";
   MailMessage^ message = gcnew MailMessage( from,to,subject,body );
   SmtpClient^ client = gcnew SmtpClient( server );
   Console::WriteLine( L"Changing time out from {0} to 100.", client->Timeout );
   client->Timeout = 100;

   // Credentials are necessary if the server requires the client 
   // to authenticate before it will send e-mail on the client's behalf.
   client->Credentials = CredentialCache::DefaultNetworkCredentials;
   client->Send( message );
}


.NET Framework
Available since 2.0
Return to top
Show: