This documentation is archived and is not being maintained.

SmtpClient.UseDefaultCredentials Property

Gets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests.

Namespace: System.Net.Mail
Assembly: System (in system.dll)

public bool UseDefaultCredentials { get; set; }
/** @property */
public boolean get_UseDefaultCredentials ()

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

public function get UseDefaultCredentials () : boolean

public function set UseDefaultCredentials (value : boolean)

Not applicable.

Property Value

true if the default credentials are used; otherwise false. The default value is false.

Exception typeCondition

InvalidOperationException

You cannot change the value of this property when an e-mail is being sent.

Some SMTP servers require that the client be authenticated before the server sends e-mail on its behalf. Set this property to true when this SmtpClient object should, if requested by the server, authenticate using the default credentials of the currently logged on user. For client applications, this is the desired behavior in most scenarios.

Credentials information can also be specified using the application and machine configuration files. For more information, see mailSettings Element (Network Settings).

If the UseDefaultCredentials property is set to false, then the value set in the Credentials property will be used for the credentials when connecting to the server. If the UseDefaultCredentials property is set to false and the Credentials property has not been set, then mail is sent to the server anonymously.

Caution noteCaution:

If you provide credentials for basic authentication, they are sent to the server in clear text. This can present a security issue because your credentials can be seen, and then used by others.

The following code example demonstrates using this property.

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 Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: