1CTL_CONVERSATIONSDB(8) Cyrus IMAP CTL_CONVERSATIONSDB(8)
2
6 ctl_conversationsdb - Cyrus IMAP documentation
7 Perform operations on the conversations databases
9
11 ctl_conversationsdb [ -C config-file ] -d userid > text
12 ctl_conversationsdb [ -C config-file ] -u userid < text
13 ctl_conversationsdb [ -C config-file ] [ -v ] [ -z | -b | -R ] userid
14 ctl_conversationsdb [ -C config-file ] [ -v ] [ -z | -b | -R ] -r
15
17 ctl_conversationsdb is used to perform various administrative opera‐
18 tions on a conversations database and associated information in
19 cyrus.index files.
20 ctl_conversationsdb reads its configuration options out of the
22 imapd.conf(5) file unless specified otherwise by -C.
23 The configdirectory option in imapd.conf(5) is used to determine the
25 default location of the conversations database.
26 In the first synopsis, the -d option dumps the contents of a conversa‐
28 tions database to standard output in an ASCII format. In the second
29 synopsis, the resulting file is fed back in, using the -u option to
30 "undump" from standard input. This pair of commands is useful for dis‐
31 aster recovery, or for changing the backend used to store the conversa‐
32 tions database.
33 The third synopsis is used to reconstruct conversations information in
35 various ways for a specific user, and the fourth to reconstruct conver‐
36 sations information for all users. See OPTIONS below for details.
37 This command was introduced in version 3.0.
39
41 -C config-file
42 Use the specified configuration file config-file rather than the
43 default imapd.conf(5).
44 -d, --dump
46 Dump the conversations database which corresponds to the user
47 userid to standard output in an ASCII format. The resulting
48 file can be used to recreate a database using the -u option.
49 -u, --undump
51 "Undumps" the conversations database corresponding to the user
52 userid, i.e. replaces all the entries with data from ASCII
53 records parsed from standard input. The output from the -d op‐
54 tion can be used as input.
55 -v, --verbose
57 Be more verbose when running.
58 -r, --recursive
60 Be recursive; apply the main operation to every user. Warning:
61 do not combine with -u, it will not do what you expect.
62 -z, --clear
64 Remove all conversation information from the conversations data‐
65 base for user userid, and from all the user's mailboxes. The
66 information can all be recalculated (eventually) from message
67 headers, using the -b option.
68 -b, --rebuild
70 Rebuild all conversation information in the conversations data‐
71 base for user userid, and in all the user's mailboxes, from the
72 header information in messages. Does not affect messages which
73 already have conversation information.
74 This is a bulk mode version of what happens to each message when
76 it arrives, and can be used to add missing conversation informa‐
77 tion for past messages, e.g. after using -z or after upgrading
78 Cyrus from older versions. Note: this operation uses informa‐
79 tion from cyrus.cache files so it does not need to read every
80 single message file.
81 -R, --update-counts
83 Recalculate counts of messages stored in existing conversations
84 in the conversations database for user userid. This is a lim‐
85 ited subset of -b; in particular it does not create conversa‐
86 tions or assign messages to conversations.
87 -S, --split
89 If given with -b, allows splitting of conversations during the
90 rewrite. Only do this if changing the maximum conversation
91 size and you need to split those existing conversations.
92
94 [NB: Examples needed]
95
97 This command was introduced in version 3.0.
98
100 /etc/imapd.conf, <configurationdir>/conversations.db
101
103 imapd.conf(5), master(8)
104
106 The Cyrus Team, Nic Bernstein (Onlight)
107
109 1993–2023, The Cyrus Team
1103.8.1 Sep 11, 2023 CTL_CONVERSATIONSDB(8)