List IMAP Mailboxes

Download Chilkat .NET for 2.0 / 3.5 Framework

Download Chilkat .NET for 1.0 / 1.1 Framework

List the mailboxes available within an IMAP account.

Chilkat.Imap imap = new Chilkat.Imap();

bool success;

// Anything unlocks the component and begins a fully-functional 30-day trial.
success = imap.UnlockComponent("Anything for 30-day trial");
if (success != true) {
    MessageBox.Show(imap.LastErrorText);
    return;
}

// Connect to an IMAP server.
success = imap.Connect("mail.chilkatsoft.com");
if (success != true) {
    MessageBox.Show(imap.LastErrorText);
    return;
}

// Login
success = imap.Login("admin@chilkatsoft.com","*myPassword5*");
if (success != true) {
    MessageBox.Show(imap.LastErrorText);
    return;
}

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

string refName;
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:
string wildcardedMailbox;
wildcardedMailbox = "*";

Chilkat.Mailboxes mboxes;
mboxes = imap.ListMailboxes(refName,wildcardedMailbox);
if (mboxes == null ) {
    MessageBox.Show(imap.LastErrorText);
    return;
}

int i;
for (i = 0; i <= mboxes.Count - 1; i++) {
    textBox1.Text += mboxes.GetName(i) + "\r\n";
    textBox1.Refresh();
}

// 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.
imap.Disconnect();