React Native

Rename an IMAP Mailbox

Demonstrates the Chilkat Imap.RenameMailbox method, which renames a mailbox from the first name to the second. Changing the hierarchy components in the new name can also move a mailbox within the server's folder tree. This example renames OldName to NewName.

Background: Because a mailbox's full name encodes its place in the folder hierarchy, renaming is also how you move a folder: renaming Inbox/Draft to Archive/Draft relocates it under a different parent. The messages inside move along with the folder. This makes RenameMailbox the tool for both relabeling and reorganizing an account's folder structure.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

import { Imap } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the Imap.RenameMailbox method, which renames a mailbox.  Changing hierarchy
  // components can also move a mailbox within the server's folder tree.

  const imap = new Imap();

  imap.ssl = true;
  imap.port = 993;

  try {
    await imap.connectAsync('imap.example.com');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.loginAsync('user@example.com', 'myPassword');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  // Rename a mailbox from "OldName" to "NewName".
  try {
    await imap.renameMailboxAsync('OldName', 'NewName');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  console.log('Mailbox renamed.');

  try {
    await imap.disconnectAsync();
  } catch {
    console.log(imap.lastErrorText);
    return;
  }
}