SmtpClient.Credentials Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the credentials used to authenticate the sender.

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

Public Property Credentials As ICredentialsByHost

Property Value

Type: System.Net.ICredentialsByHost

An ICredentialsByHost that represents the credentials to use for authentication; or null if no credentials have been specified.

Exception Condition
InvalidOperationException

You cannot change the value of this property when an email is being sent.

Some SMTP servers require that the client be authenticated before the server will send e-mail on its behalf. To use your default network credentials, you can set the UseDefaultCredentials to true instead of setting this property. 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.

Credentials information can also be specified using the application and machine configuration files. For more information, see <mailSettings> Element (Network Settings). If information is specified using the Credentials property, this information overrides the configuration file settings.

System_CAPS_cautionCaution

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 setting the credentials used to send an e-mail.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: