(PureBasic) List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkMailboxes.pb"
IncludeFile "CkImap.pb"

Procedure ChilkatExample()

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

    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to an IMAP server.
    ; Use TLS
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success.i = CkImap::ckConnect(imap,"imap.someMailServer.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Login
    success = CkImap::ckLogin(imap,"admin@chilkatsoft.com","myPassword")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; The ListMailboxes method returns a Mailboxes object
    ; that contains the collection of mailboxes.
    ; It accepts two arguments: a refName and a wildcardedMailbox.

    ; List all mailboxes under INBOX.vendors
    refName.s = "INBOX.vendors"

    ; Select all mailboxes matching this pattern:
    wildcardedMailbox.s = "*"

    mboxes.i = CkImap::ckListMailboxes(imap,refName,wildcardedMailbox)
    If CkImap::ckLastMethodSuccess(imap) = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    i.i = 0
    While i < CkMailboxes::ckCount(mboxes)
        Debug CkMailboxes::ckGetName(mboxes,i)
        i = i + 1
    Wend

    ; Sample output looks like this:
    ; INBOX.vendors.shareit
    ; INBOX.vendors.paypal
    ; INBOX.vendors.dell
    ; INBOX.vendors.inMotion
    ; INBOX.vendors.myhosting
    ; INBOX.vendors.peer1

    ; Disconnect from the IMAP server.
    success = CkImap::ckDisconnect(imap)

    CkMailboxes::ckDispose(mboxes)



    CkImap::ckDispose(imap)


    ProcedureReturn
EndProcedure