Export (0) Print
Expand All

SmtpClient.Timeout Property

Note: This property is new in the .NET Framework version 2.0.

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 int Timeout { get; set; }
/** @property */
public int get_Timeout ()

/** @property */
public void set_Timeout (int value)

public function get Timeout () : int

public function set Timeout (value : int)

Property Value

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

Exception typeCondition

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.

public static void CreateTimeoutTestMessage(string server)
{
    string to = "jane@contoso.com";
    string from = "ben@contoso.com";
    string subject = "Using the new SMTP client.";
    string body = @"Using this new feature, you can send an e-mail 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 e-mail on the client's behalf.
    client.Credentials = CredentialCache.DefaultNetworkCredentials;
    client.Send(message);
}

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft