Chilkat2-Python

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 Chilkat2-Python Downloads

Download Chilkat for Chilkat2-Python

Chilkat2-Python

import sys
import chilkat2

success = False

# Demonstrates the Imap.RenameMailbox method, which renames a mailbox.  Changing hierarchy
# components can also move a mailbox within the server's folder tree.

imap = chilkat2.Imap()

imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.example.com")
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

success = imap.Login("user@example.com","myPassword")
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

# Rename a mailbox from "OldName" to "NewName".
success = imap.RenameMailbox("OldName","NewName")
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

print("Mailbox renamed.")

success = imap.Disconnect()
if (success == False):
    print(imap.LastErrorText)
    sys.exit()