RELOCATE_BY_ID(8)

📦
version 3.12.3 · 4 versions
, in ubuntu stonking

✨ RELOCATE_BY_ID — the Cyrus IMAP glow-up page (section 8, bestie) ✨

okay so picture this: it's a relocate_by_id kind of day. This is a Cyrus IMAP manual page, section 8, and it's about ✨moving your mailbox trees around✨ no cap.

🎀 NAME 🎀

relocate_by_id — Cyrus IMAP documentation. Relocates mailbox trees by their mailbox ids. periodt.

🦋 SYNOPSIS 🦋

relocate_by_id [ -C config-file ] [ -n ] [ -q ] [ -u ] [ mailbox-names... ]

💅 DESCRIPTION 💅

So here's the vibe: you give it a mailbox name, or honestly a whole space separated list of mailbox names, and relocate_by_id relocates the mailbox and all of its submailboxes into directory trees that are hashed by mailbox id instead of hashed by mailbox name. It's giving "new filing system, same mailboxes." 😌

relocate_by_id reads its config options out of the imapd.conf(5) file, unless you tell it otherwise with -C, obviously. And it uses <configdirectory>/mailboxes.db to actually locate the mailboxes on disk. iykyk.

✨ OPTIONS ✨

  • -C config-file — use the config file config-file instead of the default imapd.conf(5). Main character energy: you're the one choosing your own config.
  • -n, --dry-run — do NOT make any changes, bestie. It just lists which directories would get relocated. Look, don't touch. 🙈
  • -q, --quiet — run quietly. Suppresses any error output. Silent era. 💀
  • -u, --userids — the mailbox-names you specified are users, not mailboxes. User metadata directories get relocated too. Important distinction, don't skip it. 🌸

🌈 EXAMPLES 🌈

relocate_by_id -u jsmith

Relocate all mailbox and metadata directories for user jsmith. slay. 💖

🍓 FILES 🍓

  • /etc/imapd.conf
  • <configdirectory>/mailboxes.db

👑 SEE ALSO 👑

🧚 AUTHOR 🧚

The Cyrus Team, Ken Murchison (Fastmail). icons, all of them. 💜

1993–2026, The Cyrus Team

and that's the whole page, bestie — version 3.12.3, dated Jul 15, 2026, from your favorite RELOCATE_BY_ID(8) era. go relocate something responsibly. 🫶✨

📦 where this page comes from