React Native Requires Chilkat v11.0.0+
React Native
List IMAP Mailboxes
List the mailboxes available within an IMAP account.Chilkat React Native Downloads
import { Imap, Mailboxes } from '@chilkat/react-native'
async function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
const imap = new Imap();
// Connect to an IMAP server.
// Use TLS
imap.ssl = true;
imap.port = 993;
try {
await imap.connectAsync('MY-IMAP-DOMAIN');
} catch {
console.log(imap.lastErrorText);
return;
}
// Login
try {
await imap.loginAsync('MY-IMAP-LOGIN', 'MY-IMAP-PASSWORD');
} catch {
console.log(imap.lastErrorText);
return;
}
const 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 wildcardedMailbox = '*';
const subscribed = false;
const mboxes = new Mailboxes();
try {
await imap.mbxListAsync(subscribed, refName, wildcardedMailbox, mboxes);
} catch {
console.log(imap.lastErrorText);
return;
}
let i = 0;
while (i < mboxes.count) {
console.log(mboxes.getName(i));
i++;
}
// 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.
await imap.disconnectAsync();
}