| 1 |
.. cyrusman:: relocate_by_id(8) |
| 2 |
|
| 3 |
.. author: Ken Murchison (Fastmail) |
| 4 |
|
| 5 |
.. _imap-reference-manpages-systemcommands-relocate_by_id: |
| 6 |
|
| 7 |
================== |
| 8 |
**relocate_by_id** |
| 9 |
================== |
| 10 |
|
| 11 |
Relocate mailbox trees by their mailbox ids |
| 12 |
|
| 13 |
Synopsis |
| 14 |
======== |
| 15 |
|
| 16 |
.. parsed-literal:: |
| 17 |
|
| 18 |
**relocate_by_id** [ **-C** *config-file* ] [ **-n** ] [ **-q** ] [ **-u** ] [ *mailbox-names*... ] |
| 19 |
|
| 20 |
Description |
| 21 |
=========== |
| 22 |
|
| 23 |
Given a mailbox name or a space separated list of mailbox names, |
| 24 |
**relocate_by_id** relocates the mailbox and its submailboxes to |
| 25 |
directory trees hashed by mailbox id rather than hashed by mailbox name. |
| 26 |
|
| 27 |
**relocate_by_id** |default-conf-text| It uses <configdirectory>/mailboxes.db |
| 28 |
to locate the mailboxes on disk. |
| 29 |
|
| 30 |
Options |
| 31 |
======= |
| 32 |
|
| 33 |
.. program:: relocate_by_id |
| 34 |
|
| 35 |
.. option:: -C config-file |
| 36 |
|
| 37 |
|cli-dash-c-text| |
| 38 |
|
| 39 |
.. option:: -n, --dry-run |
| 40 |
|
| 41 |
Do NOT make any changes. Just list which directories will be relocated. |
| 42 |
|
| 43 |
.. option:: -q, --quiet |
| 44 |
|
| 45 |
Run quietly. Suppress any error output. |
| 46 |
|
| 47 |
.. option:: -u, --userids |
| 48 |
|
| 49 |
The specified *mailbox-names* are users, not mailboxes. |
| 50 |
User metadata directories will also be relocated. |
| 51 |
|
| 52 |
Examples |
| 53 |
======== |
| 54 |
|
| 55 |
.. parsed-literal:: |
| 56 |
|
| 57 |
**relocate_by_id -u** *jsmith* |
| 58 |
|
| 59 |
.. |
| 60 |
|
| 61 |
Relocate all mailbox and metadata directories for user *jsmith*. |
| 62 |
|
| 63 |
Files |
| 64 |
===== |
| 65 |
|
| 66 |
/etc/imapd.conf, |
| 67 |
<configdirectory>/mailboxes.db |
| 68 |
|
| 69 |
See Also |
| 70 |
======== |
| 71 |
|
| 72 |
:cyrusman:`imapd.conf(5)` |