| 1 |
.. cyrusman:: ctl_conversationsdb(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
|
| 5 |
.. _imap-reference-manpages-systemcommands-ctl_conversationsdb: |
| 6 |
|
| 7 |
======================= |
| 8 |
**ctl_conversationsdb** |
| 9 |
======================= |
| 10 |
|
| 11 |
Perform operations on the conversations databases |
| 12 |
|
| 13 |
Synopsis |
| 14 |
======== |
| 15 |
|
| 16 |
.. parsed-literal:: |
| 17 |
|
| 18 |
**ctl_conversationsdb** [ -C *config-file* ] **-d** *userid* > text |
| 19 |
**ctl_conversationsdb** [ -C *config-file* ] **-u** *userid* < text |
| 20 |
**ctl_conversationsdb** [ -C *config-file* ] [ **-v** ] [ **-z** | **-b** | **-R** ] *userid* |
| 21 |
**ctl_conversationsdb** [ -C *config-file* ] [ **-v** ] [ **-z** | **-b** | **-R** ] **-r** |
| 22 |
|
| 23 |
Description |
| 24 |
=========== |
| 25 |
|
| 26 |
**ctl_conversationsdb** is used to perform various administrative |
| 27 |
operations on a conversations database and associated information in |
| 28 |
*cyrus.index* files. |
| 29 |
|
| 30 |
**ctl_conversationsdb** |default-conf-text| |
| 31 |
|
| 32 |
|def-confdir-text| conversations database. |
| 33 |
|
| 34 |
In the first synopsis, the **-d** option dumps the contents of a |
| 35 |
conversations database to standard output in an ASCII format. In the |
| 36 |
second synopsis, the resulting *file* is fed back in, using the |
| 37 |
**-u** option to "undump" from standard input. This pair of commands |
| 38 |
is useful for disaster recovery, or for changing the backend used to |
| 39 |
store the conversations database. |
| 40 |
|
| 41 |
The third synopsis is used to reconstruct conversations information |
| 42 |
in various ways for a specific user, and the fourth to reconstruct |
| 43 |
conversations information for all users. See ``OPTIONS`` below for |
| 44 |
details. |
| 45 |
|
| 46 |
|v3-new-command| |
| 47 |
|
| 48 |
Options |
| 49 |
======= |
| 50 |
|
| 51 |
.. program:: ctl_conversationsdb |
| 52 |
|
| 53 |
.. option:: -C config-file |
| 54 |
|
| 55 |
|cli-dash-c-text| |
| 56 |
|
| 57 |
.. option:: -d, --dump |
| 58 |
|
| 59 |
Dump the conversations database which corresponds to the user *userid* |
| 60 |
to standard output in an ASCII format. The resulting file can be |
| 61 |
used to recreate a database using the **-u** option. |
| 62 |
|
| 63 |
.. option:: -u, --undump |
| 64 |
|
| 65 |
"Undumps" the conversations database corresponding to the user *userid*, |
| 66 |
i.e. replaces all the entries with data from ASCII records parsed |
| 67 |
from standard input. The output from the **-d** option can be used |
| 68 |
as input. |
| 69 |
|
| 70 |
.. option:: -v, --verbose |
| 71 |
|
| 72 |
Be more verbose when running. |
| 73 |
|
| 74 |
.. option:: -r, --recursive |
| 75 |
|
| 76 |
Be recursive; apply the main operation to every user. Warning: do |
| 77 |
not combine with **-u**, it will not do what you expect. |
| 78 |
|
| 79 |
.. option:: -z, --clear |
| 80 |
|
| 81 |
Remove all conversation information from the conversations database |
| 82 |
for user *userid*, and from all the user's mailboxes. The |
| 83 |
information can all be recalculated (eventually) from message |
| 84 |
headers, using the **-b** option. |
| 85 |
|
| 86 |
.. option:: -Z, --clearcids cid,... |
| 87 |
|
| 88 |
Remove all conversation information from the conversations database |
| 89 |
for user *userid*, and from all the user's mailboxes for conversations |
| 90 |
matching the comma separated list of cids in hex format. Can be |
| 91 |
specified more than once. |
| 92 |
|
| 93 |
The information can all be recalculated (eventually) from message |
| 94 |
headers, using the **-b** option. |
| 95 |
|
| 96 |
.. option:: -M, --clearmodseq |
| 97 |
|
| 98 |
Reset the modseqs for all messages and conversation highwatermarks |
| 99 |
for user *userid*, and from the user's counters file. |
| 100 |
|
| 101 |
.. option:: -b, --rebuild |
| 102 |
|
| 103 |
Rebuild all conversation information in the conversations database |
| 104 |
for user *userid*, and in all the user's mailboxes, from the header |
| 105 |
information in messages. Does not affect messages which already |
| 106 |
have conversation information. |
| 107 |
|
| 108 |
This is a bulk mode version of what happens to each message when it |
| 109 |
arrives, and can be used to add missing conversation information |
| 110 |
for past messages, e.g. after using **-z** or after upgrading |
| 111 |
Cyrus from older versions. Note: this operation uses information |
| 112 |
from *cyrus.cache* files so it does not need to read every single |
| 113 |
message file. |
| 114 |
|
| 115 |
.. option:: -R, --update-counts |
| 116 |
|
| 117 |
Recalculate counts of messages stored in existing conversations in |
| 118 |
the conversations database for user *userid*. This is a limited |
| 119 |
subset of **-b**; in particular it does not create conversations or |
| 120 |
assign messages to conversations. |
| 121 |
|
| 122 |
.. option:: -S, --split |
| 123 |
|
| 124 |
If given with **-b**, allows splitting of conversations during the |
| 125 |
rewrite. Only do this if changing the maximum conversation size |
| 126 |
and you need to split those existing conversations. |
| 127 |
|
| 128 |
Examples |
| 129 |
======== |
| 130 |
|
| 131 |
[NB: Examples needed] |
| 132 |
|
| 133 |
History |
| 134 |
======= |
| 135 |
|
| 136 |
|v3-new-command| |
| 137 |
|
| 138 |
Files |
| 139 |
===== |
| 140 |
|
| 141 |
/etc/imapd.conf, <configurationdir>/conversations.db |
| 142 |
|
| 143 |
See Also |
| 144 |
======== |
| 145 |
:cyrusman:`imapd.conf(5)`, :cyrusman:`master(8)` |