SmtpClient.UseDefaultCredentials プロパティ

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

SmtpClient.UseDefaultCredentials プロパティ

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

DefaultCredentials が要求と共に送信されるかどうかを制御する Boolean 値を取得または設定します。

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

Visual Basic (宣言)

Public Property UseDefaultCredentials As
 Boolean

Visual Basic (使用法)

Dim instance As SmtpClient
Dim value As Boolean

value = instance.UseDefaultCredentials

instance.UseDefaultCredentials = value

C#

public bool UseDefaultCredentials { get;
 set; }

C++

public:
property bool UseDefaultCredentials {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_UseDefaultCredentials ()

/** @property */
public void set_UseDefaultCredentials (boolean
 value)

JScript

public function get UseDefaultCredentials
 () : boolean

public function set UseDefaultCredentials
 (value : boolean)

プロパティ値
既定の資格情報が使用される場合は true。それ以外の場合は false。既定値は false です。

例外

例外の種類	条件
InvalidOperationException	電子メールが送信中の場合、このプロパティの値は変更できません。

解説

一部の SMTP サーバーでは、サーバーがクライアントに代わって電子メールを送信する前に、クライアントが認証されている必要があります。この SmtpClient オブジェクトを、現在ログオンしているユーザーの既定の資格情報を使用して認証する必要がある (サーバーから要求されている場合) ときは、このプロパティを true に設定します。クライアント アプリケーションでは、ほとんどの場合、この動作が必要です。

資格情報は、アプリケーションまたはコンピュータの構成ファイルを使用して指定することもできます。詳細については、「mailSettings 要素 (ネットワーク設定)」を参照してください。

使用例

このプロパティを使用したコード例を次に示します。

C#

public static void CreateTestMessage2(string
 server)
{
    string to = "jane@contoso.com";
    string from = "ben@contoso.com";
    MailMessage message = new MailMessage(from, to);
    message.Subject = "Using the new SMTP client.";
    message.Body = @"Using this new feature,
 you can send an e-mail message from an application very easily.";
    SmtpClient client = new SmtpClient(server);
    // Credentials are necessary if the server requires the client 
    // to authenticate before it will send e-mail on the client's behalf.
    client.UseDefaultCredentials = true;
    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 名前空間