DataFlex

Using Client Certificate w/ IMAP SSL

Demonstrates how to use a client-side certificate with an IMAP SSL connection. The SetSslClientCert method is called to specify a certificate to be used for the SSL connection. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoImap
    Variant vCert
Store    Handle hoCertStore
    Variant vJsonCN
    Handle hoJsonCN
    Variant vCert
    Handle hoCert
    Variant vCert
2    Handle hoCert2
    Boolean iFetchUids
    Variant vMessageSet
    Handle hoMessageSet
    Variant vBundle
    Handle hoBundle
    Boolean iHeadersOnly
    Variant vEmail
    Handle hoEmail
    Integer i
    Integer iNumEmails
    String sTemp1

    Move False To iSuccess

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

    // To use a secure SSL connection, set SSL and the port:
    Set ComSsl Of hoImap To True
    // The typical port for IMAP SSL is 993
    Set ComPort Of hoImap To 993

    // Load a certificate from a PFX file and use it.
    // Note: Other methods are available to load pre-installed
    // certificates from registry-based certificate stores.

    // Create an instance of a certificate store object, load a PFX file,
    // locate the certificate we need, and use it for signing.
    // (a PFX file may contain more than one certificate.)
    Get Create (RefClass(cComChilkatCertStore)) To hoCertStore
    If (Not(IsComObjectCreated(hoCertStore))) Begin
        Send CreateComObject of hoCertStore
    End
    // The 1st argument is the filename, the 2nd arg is the 
    // PFX file's password:
    Get ComLoadPfxFile Of hoCertStore "myCertWithPrivateKey.pfx" "secret" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoCertStore To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Find the certificate by the subject common name:
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonCN
    If (Not(IsComObjectCreated(hoJsonCN))) Begin
        Send CreateComObject of hoJsonCN
    End
    Get ComUpdateString Of hoJsonCN "CN" "cert common name" To iSuccess

    Get Create (RefClass(cComChilkatCert)) To hoCert
    If (Not(IsComObjectCreated(hoCert))) Begin
        Send CreateComObject of hoCert
    End
    Get pvComObject of hoJsonCN to vJsonCN
    Get pvComObject of hoCert to vCert
    Get ComFindCert Of hoCertStore vJsonCN vCert To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoCertStore To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // If a PFX file is known to contain a single certificate,
    // you may load it directly into a Chilkat certificate object.
    // This snippet of source code shows how:
    Get Create (RefClass(cComChilkatCert)) To hoCert2
    If (Not(IsComObjectCreated(hoCert2))) Begin
        Send CreateComObject of hoCert2
    End
    // The 1st argument is the filename, the 2nd arg is the 
    // PFX file's password:
    Get ComLoadPfxFile Of hoCert2 "myClientCert.pfx" "secret" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoCert To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Use the cert:
    Get pvComObject of hoCert to vCert
    Get ComSetSslClientCert Of hoImap vCert To iSuccess

    // Connect to an IMAP server.
    Get ComConnect Of hoImap "imap.example.com" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Login
    Get ComLogin Of hoImap "myLogin" "myPassword" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Select an IMAP mailbox
    Get ComSelectMailbox Of hoImap "Inbox" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Get the message IDs of all the emails in the mailbox
    Move True To iFetchUids
    Get Create (RefClass(cComChilkatMessageSet)) To hoMessageSet
    If (Not(IsComObjectCreated(hoMessageSet))) Begin
        Send CreateComObject of hoMessageSet
    End
    Get pvComObject of hoMessageSet to vMessageSet
    Get ComQueryMbx Of hoImap "ALL" iFetchUids vMessageSet To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Fetch the emails into a bundle object:
    Get Create (RefClass(cComChilkatEmailBundle)) To hoBundle
    If (Not(IsComObjectCreated(hoBundle))) Begin
        Send CreateComObject of hoBundle
    End
    Move False To iHeadersOnly
    Get pvComObject of hoMessageSet to vMessageSet
    Get pvComObject of hoBundle to vBundle
    Get ComFetchMsgSet Of hoImap iHeadersOnly vMessageSet vBundle To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Loop over the bundle and display the FROM and SUBJECT of each.
    Get Create (RefClass(cComChilkatEmail)) To hoEmail
    If (Not(IsComObjectCreated(hoEmail))) Begin
        Send CreateComObject of hoEmail
    End
    Move 0 To i
    Get ComMessageCount Of hoBundle To iNumEmails
    While (i < iNumEmails)
        Get pvComObject of hoEmail to vEmail
        Get ComEmailAt Of hoBundle i vEmail To iSuccess

        Get ComFrom Of hoEmail To sTemp1
        Showln sTemp1
        Get ComSubject Of hoEmail To sTemp1
        Showln sTemp1
        Showln "--"
        Move (i + 1) To i
    Loop

    // Disconnect from the IMAP server.
    Get ComDisconnect Of hoImap To iSuccess


End_Procedure