(DataFlex) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoImap
    Boolean iSuccess
    String sRefName
    String sWildcardedMailbox
    Variant vMboxes
    Handle hoMboxes
    Integer i
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    // 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

    // Connect to an IMAP server.
    // Use TLS
    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993
    Get ComConnect Of hoImap "imap.someMailServer.com" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

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

    // First examine the already subscribed mailboxes.
    Move "" To sRefName
    Move "*" To sWildcardedMailbox

    // Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
    Get ComListSubscribed Of hoImap sRefName sWildcardedMailbox To vMboxes
    If (IsComObject(vMboxes)) Begin
        Get Create (RefClass(cComChilkatMailboxes)) To hoMboxes
        Set pvComObject Of hoMboxes To vMboxes
    End
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComCount Of hoMboxes To iTemp1
    For i From 0 To (iTemp1 - 1)
        Get ComGetName Of hoMboxes i To sTemp1
        Showln sTemp1
    Loop

    Showln "----"
    Send Destroy of hoMboxes

    // Sample output.

    // INBOX
    // INBOX/recent
    // INBOX/misc
    // INBOX/misc/solutions
    // ...
    // Outbox
    // Deleted Items
    // Sent Items
    // Drafts
    // Junk E-mail
    // Trash
    // Sent
    // Templates

    // Let's unsubscribe to "INBOX/misc/solutions".
    Get ComUnsubscribe Of hoImap "INBOX/misc/solutions" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
    Get ComListSubscribed Of hoImap "" "INBOX/misc*" To vMboxes
    If (IsComObject(vMboxes)) Begin
        Get Create (RefClass(cComChilkatMailboxes)) To hoMboxes
        Set pvComObject Of hoMboxes To vMboxes
    End
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComCount Of hoMboxes To iTemp1
    For i From 0 To (iTemp1 - 1)
        Get ComGetName Of hoMboxes i To sTemp1
        Showln sTemp1
    Loop

    Send Destroy of hoMboxes
    Showln "----"

    // Re-subscribe to "INBOX/misc/solutions".
    Get ComSubscribe Of hoImap "INBOX/misc/solutions" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
    Get ComListSubscribed Of hoImap "" "INBOX/misc*" To vMboxes
    If (IsComObject(vMboxes)) Begin
        Get Create (RefClass(cComChilkatMailboxes)) To hoMboxes
        Set pvComObject Of hoMboxes To vMboxes
    End
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComCount Of hoMboxes To iTemp1
    For i From 0 To (iTemp1 - 1)
        Get ComGetName Of hoMboxes i To sTemp1
        Showln sTemp1
    Loop

    Send Destroy of hoMboxes
    Showln "----"

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


End_Procedure