Begins an asynchronous request to start TLS/SSL negotiation with the server.

Parameters

callback

The AsyncCallback delegate. You can leave it a null reference (Nothing in Visual Basic) if you do not use callbacks.

state

An object that contains state information for this request. You can leave it a null reference (Nothing in Visual Basic).

Return Value

An IAsyncResult that references the asynchronous TLS/SSL negotiation.

Remarks

This method is an asynchronous version of StartTls.

Exceptions

Example

Asynchronous TLS/SSL negotiation with the IMAP4 server in WinForms application. This sample also handles TlsStarted event. Wait method is used to wait for the asynchronous method completion, since .NET's standard WaitOne cannot process events.

[C#]
// To use the code below, import MailBee namespaces at the top of your code.
using MailBee;
using MailBee.ImapMail;

// Put the code below inside your class.

// TlsStarted event handler.
private void OnTlsStarted(object sender, TlsStartedEventArgs e)
{
    MessageBox.Show("TLS/SSL negotiation complete. Secure connection is ready.");
}

// The actual code.
private void Form1_Load(object sender, System.EventArgs e)
{
    Imap imp = new Imap();

    // Let MailBee process events.
    imp.RaiseEventsViaMessageLoop = false;

    imp.TlsStarted += new TlsStartedEventHandler(OnTlsStarted);

    imp.Connect("mail.company.com");

    // Initiate an asynchronous TLS/SSL negotiation.
    imp.BeginStartTls(null, null);

    // Simulate some lengthy work here...
    for (int i = 0; i < 100; i++)
    {
        // Make a portion of the work.
        System.Threading.Thread.Sleep(10);

        // Process events which were raised during execution of the work above.
        imp.Wait(0);
    }

    // If the connection was not established during execution of the lengthy 
    // work, wait until it's established.
    imp.Wait();

    // End the connection request.
    imp.EndStartTls();

    // The connection is now under TLS/SSL layer!

    // Disconnect from the server.
    imp.Disconnect();
}

[Visual Basic]
' To use the code below, import MailBee namespaces at the top of your code.
Imports MailBee
Imports MailBee.ImapMail

' TlsStarted event handler.
Public Shared Sub OnTlsStarted(ByVal sender As Object, ByVal e As TlsStartedEventArgs)
    MsgBox("TLS/SSL negotiation complete. Secure connection is ready.")
End Sub

' The actual code.
Public Shared Sub Form1_Load(ByVal sender As Object, ByVal e As System.EventArgs)
    Dim imp As New Imap

    ' Let MailBee process events.
    imp.RaiseEventsViaMessageLoop = False

    AddHandler imp.TlsStarted, AddressOf OnTlsStarted

    imp.Connect("mail.company.com")

    ' Initiate an asynchronous TLS/SSL negotiation.
    imp.BeginStartTls(Nothing, Nothing)

    ' Simulate some lengthy work here...
    For i As Integer = 1 To 100
        ' Make a portion of the work.
        System.Threading.Thread.Sleep(10)

        ' Process events which were raised during execution of the work above.
        imp.Wait(0)
    Next

    ' If the connection was not established during execution of the lengthy 
    ' work, wait until it's established.
    imp.Wait()

    ' End the connection request.
    imp.EndStartTls()

    ' The connection is now under TLS/SSL layer!

    ' Disconnect from the server.
    imp.Disconnect()
End Sub

See Also

Imap Class | MailBee.ImapMail Namespace | StartTls

---