Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SmtpClient::Credentials Property

Gets or sets the credentials used to authenticate the sender.

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

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

Property Value

Type: System.Net::ICredentialsByHost
An ICredentialsByHost that represents the credentials to use for authentication; or nullptr if no credentials have been specified.

ExceptionCondition
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.

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

   static void CreateTestMessage1( String^ server, int port )
   {
      String^ to = L"jane@contoso.com";
      String^ from = L"ben@contoso.com";
      String^ subject = L"Using the new SMTP client.";
      String^ body = L"Using this new feature, you can send an e-mail message from an application very easily.";
      MailMessage^ message = gcnew MailMessage( from,to,subject,body );
      SmtpClient^ client = gcnew 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;

      //Display the properties on the service point.
      ServicePoint^ p = client->ServicePoint;
      Console::WriteLine( L"Connection lease timeout: {0}", p->ConnectionLeaseTimeout );
      client->Send( message );
	  client->~SmtpClient();
   }

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft