Log In  |  Register
     
  • Loading...
UltimateMail
CertificateRequired Event
See Also  Example Send comments on this topic to ATP, Inc.
Atp.Net.Mail Namespace > ImapClient Class : CertificateRequired Event




Occurs when a client certificate is required by the IMAP server, or the one provided was not accepted.

Syntax

Visual Basic (Declaration) 
<DescriptionAttribute("Occurs when a client certificate is required by the IMAP server, or the one provided was not accepted.")>
Public Event CertificateRequired() As CertificateRequiredEventHandler
Visual Basic (Usage)Copy Code
Dim instance As ImapClient
Dim handler As CertificateRequiredEventHandler
 
AddHandler instance.CertificateRequired, handler
C# 
[DescriptionAttribute("Occurs when a client certificate is required by the IMAP server, or the one provided was not accepted.")]
public event CertificateRequiredEventHandler CertificateRequired()
Managed Extensions for C++ 
[DescriptionAttribute("Occurs when a client certificate is required by the IMAP server, or the one provided was not accepted.")]
public: __event CertificateRequiredEventHandler* CertificateRequired
C++/CLI 
[DescriptionAttribute("Occurs when a client certificate is required by the IMAP server, or the one provided was not accepted.")]
public:
event CertificateRequiredEventHandler^ CertificateRequired

Example

C#Copy Code
using System;
using System.Security.Cryptography.X509Certificates;
using Atp.Net;
using Atp.Net.Mail;

namespace Samples.Imap.Events
{
   class CertificateRequired
   {
       static void Main()
       {
           CertificateRequired cls = new CertificateRequired();
           cls.HandleCertificateRequiredEvent();
       }

       public void HandleCertificateRequiredEvent()
       {
           // Create a new instance.
           ImapClient client = new ImapClient();

           client.CertificateRequired += client_CertificateRequired;

           // Connect to the IMAP server.
           client.Connect("myserver", 143, SecurityMode.Explicit);

           // Authenticate.
           client.Authenticate("userName", "password");

           // Do something here...
           // ...

           // Disconnect.
           client.Disconnect();
       }

       void client_CertificateRequired(object sender, Atp.Security.CertificateRequiredEventArgs e)
       {
           // Load certificates from the local machine.
           X509Store my = new X509Store(StoreName.My, StoreLocation.CurrentUser);
           my.Open(OpenFlags.ReadOnly);

           // Retrieve a list of available certificates.
           X509Certificate2Collection certs = my.Certificates;

           // If no certificate found, return.
           if (certs.Count == 0)
           {
               e.Certificate = null;
               return;
           }

           // Show all certificates.
           Console.WriteLine("Select certificate:");
           for (int i = 0; i <= certs.Count; i++)
           {
               if (i == 0)
               {
                   Console.WriteLine(string.Format("{0}. [Nothing, skip this step]", i));
                   continue;
               }

               Console.WriteLine(string.Format("{0}. {1}", i, certs[i - 1].SubjectName.Name));
           }

           // And ask user to choose an appropriate certificate.
           while (true)
           {
               Console.Write(string.Format("Select certificate [0 - {0}]: ", certs.Count));

               int certIndex;

               try
               {
                   certIndex = int.Parse(Console.ReadLine());
               }
               catch
               {
                   Console.WriteLine("ERROR: Wrong certificate index input!");
                   continue;
               }

               if (certIndex > 0 && certIndex <= certs.Count)
               {
                   e.Certificate = certs[certIndex];
                   return;
               }

               if (certIndex == 0)
                   break;

               Console.WriteLine(string.Format("ERROR: You must enter number between 0 and {0}.", certs.Count));
           }
       }
   }
}
Visual BasicCopy Code
Imports System
Imports System.Security.Cryptography.X509Certificates
Imports Atp.Net
Imports Atp.Net.Mail

Namespace Samples.GeneralEvents
    Friend Class CertificateRequired
        Shared Sub Main()
            Dim cls As New CertificateRequired()
            cls.HandleCertificateRequiredEvent()
        End Sub

        Public Sub HandleCertificateRequiredEvent()
            ' Create a new instance.
            Dim client As New ImapClient()

            AddHandler client.CertificateRequired, AddressOf client_CertificateRequired

            ' Connect to the IMAP server.
            client.Connect("myserver", 143, SecurityMode.Explicit)

            ' Authenticate.
            client.Authenticate("userName", "password")

            ' Do something here...
            ' ...

            ' Disconnect.
            client.Disconnect()
        End Sub

        Private Sub client_CertificateRequired(ByVal sender As Object, ByVal e As Atp.Security.CertificateRequiredEventArgs)
            ' Load certificates from the local machine.
            Dim my As New X509Store(StoreName.My, StoreLocation.CurrentUser)
            my.Open(OpenFlags.ReadOnly)

            ' Retrieve a list of available certificates.
            Dim certs As X509Certificate2Collection = my.Certificates

            ' If no certificate found, return.
            If certs.Count = 0 Then
                e.Certificate = Nothing
                Return
            End If

            ' Show all certificates.
            Console.WriteLine("Select certificate:")
            For i As Integer = 0 To certs.Count
                If i = 0 Then
                    Console.WriteLine(String.Format("{0}. [Nothing, skip this step]", i))
                    Continue For
                End If

                Console.WriteLine(String.Format("{0}. {1}", i, certs(i - 1).SubjectName.Name))
            Next i

            ' And ask user to choose an appropriate certificate.
            Do
                Console.Write(String.Format("Select certificate [0 - {0}]: ", certs.Count))

                Dim certIndex As Integer

                Try
                    certIndex = Integer.Parse(Console.ReadLine())
                Catch
                    Console.WriteLine("ERROR: Wrong certificate index input!")
                    Continue Do
                End Try

                If certIndex > 0 AndAlso certIndex <= certs.Count Then
                    e.Certificate = certs(certIndex)
                    Return
                End If

                If certIndex = 0 Then
                    Exit Do
                End If

                Console.WriteLine(String.Format("ERROR: You must enter number between 0 and {0}.", certs.Count))
            Loop
        End Sub
    End Class
End Namespace

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Ultimate Packages for .NET

Ultimate Packages for .NET CF

Components for .NET

Components for .NET CF

Purchase

Support

Company

Sitemap | Site Feedback | Terms of Use | Privacy Policy | Contact Us
Copyright © 2007-2010 ATP, Inc. All rights reserved.
ATP, Inc. is a Microsoft Partner. Our components are compatible with Windows 7 and optimized for Visual Studio