SmtpClient.Timeout Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value that specifies the amount of time after which a synchronous Send call times out.
public:
property int Timeout { int get(); void set(int value); };public int Timeout { get; set; }member this.Timeout : int with get, setPublic Property Timeout As IntegerProperty Value
An Int32 that specifies the time-out value in milliseconds. The default value is 100,000 (100 seconds).
Exceptions
The value specified for a set operation was less than zero.
You cannot change the value of this property when an email is being sent.
Examples
The following code example demonstrates getting and setting the time-out value.
static void CreateTimeoutTestMessage( String^ server )
{
String^ to = L"[email protected]";
String^ from = L"[email protected]";
String^ subject = L"Using the new SMTP client.";
String^ body = L"Using this new feature, you can send an email 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 email on the client's behalf.
client->Credentials = CredentialCache::DefaultNetworkCredentials;
client->Send( message );
}
public static void CreateTimeoutTestMessage(string server)
{
string to = "[email protected]";
string from = "[email protected]";
string subject = "Using the new SMTP client.";
string body = @"Using this new feature, you can send an email message from an application very easily.";
MailMessage message = new MailMessage(from, to, subject, body);
SmtpClient client = new SmtpClient(server);
Console.WriteLine("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 email on the client's behalf.
client.Credentials = CredentialCache.DefaultNetworkCredentials;
client.Send(message);
}
Remarks
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.
