relocate_by_id - Cyrus IMAP documentation
Contents
Copyright
1993–2025, The Cyrus Team
3.10.2 Jun 27, 2025 RELOCATE_BY_ID(8)
Description
Given a mailbox name or a space separated list of mailbox names, relocate_by_id relocates the mailbox and
its submailboxes to directory trees hashed by mailbox id rather than hashed by mailbox name.
relocate_by_id reads its configuration options out of the imapd.conf(5) file unless specified otherwise
by -C. It uses <configdirectory>/mailboxes.db to locate the mailboxes on disk.
Examples
relocate_by_id-ujsmithRelocateallmailboxandmetadatadirectoriesforuserjsmith.
Files
/etc/imapd.conf, <configdirectory>/mailboxes.db
Name
relocate_by_id - Cyrus IMAP documentation
Relocate mailbox trees by their mailbox ids
Options
-Cconfig-file
Use the specified configuration file config-file rather than the default imapd.conf(5).
-n,--dry-run
Do NOT make any changes. Just list which directories will be relocated.
-q,--quiet
Run quietly. Suppress any error output.
-u,--userids
The specified mailbox-names are users, not mailboxes. User metadata directories will also be
relocated.
See Also
imapd.conf(5)Synopsis
relocate_by_id [ -Cconfig-file ] [ -n ] [ -q ] [ -u ] [ mailbox-names... ]
