SmtpClient.Timeout プロパティ

.NET Framework クラス ライブラリ リファレンス

SmtpClient.Timeout プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

同期的な Send 呼び出しがタイムアウトになるまでの時間を指定する値を取得または設定します。

名前空間: System.Net.Mail
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Property Timeout As
 Integer

Visual Basic (使用法)

Dim instance As SmtpClient
Dim value As Integer

value = instance.Timeout

instance.Timeout = value

C#

public int Timeout { get;
 set; }

C++

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

J#

/** @property */
public int get_Timeout ()

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

JScript

public function get Timeout
 () : int

public function set Timeout
 (value : int)

プロパティ値
タイムアウト値 (ミリ秒) を指定する Int32。既定値は 100,000 ミリ秒 (100 秒) です。

例外

例外の種類	条件
ArgumentOutOfRangeException	設定操作として指定した値が 0 未満です。
InvalidOperationException	電子メールが送信中の場合、このプロパティの値は変更できません。

解説

既定では、Send メソッドを呼び出すと、その操作が完了するまでブロックされます。Timeout プロパティが正の値に設定されていて Send 操作が指定の時間内に完了できなかった場合は、SmtpClient クラスによって SmtpException 例外がスローされます。

メッセージを送信し、同時にアプリケーション スレッドで実行を継続するには、SendAsync メソッドを使用します。

使用例

タイムアウト値の取得と設定を行うコード例を次に示します。

C#

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SmtpClient クラス
SmtpClient メンバ
System.Net.Mail 名前空間