SmtpClient.EnableSsl Property (System.Net.Mail)

Switch View

EnableSsl Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

SmtpClient..::.EnableSsl Property

Specify whether the SmtpClient uses Secure Sockets Layer (SSL) to encrypt the connection.

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

Syntax

Visual Basic (Declaration)

Public Property EnableSsl As Boolean

Visual Basic (Usage)

Dim instance As SmtpClient
Dim value As Boolean

value = instance.EnableSsl

instance.EnableSsl = value

public bool EnableSsl { get; set; }

Visual C++

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

JScript

public function get EnableSsl () : boolean
public function set EnableSsl (value : boolean)

Property Value

Type: System..::.Boolean
true if the SmtpClient uses SSL; otherwise, false. The default is false.

Remarks

You can use ClientCertificates to specify which client certificates should be used to establish the SSL connection. The ServerCertificateValidationCallback allows you to reject the certificate provided by the SMTP server. The SecurityProtocol property allows you to specify the version of the SSL protocol to use.

Examples

The following code example establishes an SSL connection with the SMTP server and uses the connection to send an email.

        public static void CreateTestMessage(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.EnableSsl = true;
            client.Send(message);
        }

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

SmtpClient Class

SmtpClient Members

System.Net.Mail Namespace