(MFC) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Chilkat C/C++ Library Downloads MS Visual C/C++ Libs

See Also: Using MFC CString in Chilkat

#include <CkImap.h>
#include <CkMailboxes.h>

void ChilkatSample(void)
    {
    CkString strOut;

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

    CkImap imap;

    // Connect to an IMAP server.
    // Use TLS
    imap.put_Ssl(true);
    imap.put_Port(993);
    bool success = imap.Connect("MY-IMAP-DOMAIN");
    if (success != true) {
        strOut.append(imap.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Login
    success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    if (success != true) {
        strOut.append(imap.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

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

    const char *refName = "";
    // refName is usually set to an empty string.
    // A non-empty reference name argument is the name of a mailbox or a level of
    // mailbox hierarchy, and indicates the context in which the mailbox
    // name is interpreted.

    // Select all mailboxes matching this pattern:
    const char *wildcardedMailbox = "*";

    CkMailboxes *mboxes = imap.ListMailboxes(refName,wildcardedMailbox);
    if (imap.get_LastMethodSuccess() == false) {
        strOut.append(imap.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    int i = 0;
    while (i < mboxes->get_Count()) {
        strOut.append(mboxes->getName(i));
        strOut.append("\r\n");
        i = i + 1;
    }

    // Sample output looks like this:
    // INBOX.vendors.shareit
    // INBOX.oldSupport
    // INBOX.vendors.paypal
    // INBOX.sales
    // INBOX.lists
    // INBOX.Drafts
    // INBOX.vendors.dell
    // INBOX.Trash
    // INBOX.invoiceRequests
    // INBOX.purchases
    // INBOX.vendors.inMotion
    // INBOX.oldEmail
    // INBOX.vendors
    // INBOX.lists.python
    // INBOX.vendors.myhosting
    // INBOX.Templates
    // INBOX.friends
    // INBOX.bounceSamples
    // INBOX.lists.ruby
    // INBOX.vendors.peer1
    // INBOX.Sent
    // INBOX.Junk
    // INBOX

    // Disconnect from the IMAP server.
    success = imap.Disconnect();

    delete mboxes;


    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }