SmtpClient.Credentials プロパティ

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

SmtpClient.Credentials プロパティ

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

差出人の認証に使用する資格情報を取得または設定します。

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

Visual Basic (宣言)

Public Property Credentials As
 ICredentialsByHost

Visual Basic (使用法)

Dim instance As SmtpClient
Dim value As ICredentialsByHost

value = instance.Credentials

instance.Credentials = value

C#

public ICredentialsByHost Credentials { get;
 set; }

C++

public:
property ICredentialsByHost^ Credentials {
    ICredentialsByHost^ get ();
    void set (ICredentialsByHost^ value);
}

J#

/** @property */
public ICredentialsByHost get_Credentials ()

/** @property */
public void set_Credentials (ICredentialsByHost
 value)

JScript

public function get Credentials
 () : ICredentialsByHost

public function set Credentials
 (value : ICredentialsByHost)

プロパティ値
認証に使用する資格情報を表す ICredentialsByHost。資格情報が指定されなかった場合は null 参照 (Visual Basic では Nothing)。

例外

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

解説

一部の SMTP サーバーでは、サーバーがクライアントに代わって電子メールを送信する前に、クライアントが認証されている必要があります。既定のネットワーク資格情報を使用するには、このプロパティを設定する代わりに UseDefaultCredentials を true に設定できます。

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

注意
基本認証で資格情報を提供すると、クリア テキストでサーバーに送信されます。この場合、他のユーザーが資格情報を読み取って利用できてしまうため、セキュリティ上の問題が発生する可能性があります。

使用例

電子メールの送信に使用する資格情報を設定するコード例を次に示します。

C#

public static void CreateTestMessage1(string
 server, int port)
{
    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, port);
    // 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 名前空間