1CTL_CONVERSATIONSDB(8)            Cyrus IMAP            CTL_CONVERSATIONSDB(8)
2
3
4

NAME

6       ctl_conversationsdb - Cyrus IMAP documentation
7
8       Perform operations on the conversations databases
9

SYNOPSIS

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

DESCRIPTION

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
21       ctl_conversationsdb   reads   its  configuration  options  out  of  the
22       imapd.conf(5) file unless specified otherwise by -C.
23
24       The configdirectory option in imapd.conf(5) is used  to  determine  the
25       default location of the conversations database.
26
27       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
34       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
38       This command was introduced in version 3.0.
39

OPTIONS

41       -C config-file
42              Use the specified configuration file config-file rather than the
43              default imapd.conf(5).
44
45       -d userid
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
50       -u userid
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
56       -v     Be more verbose when running.
57
58       -r     Be recursive; apply the main operation to every user.   Warning:
59              do not combine with -u, it will not do what you expect.
60
61       -z     Remove all conversation information from the conversations data‐
62              base for user userid, and from all the  user's  mailboxes.   The
63              information  can  all  be recalculated (eventually) from message
64              headers, using the -b option.
65
66       -b     Rebuild all conversation information in the conversations  data‐
67              base  for user userid, and in all the user's mailboxes, from the
68              header information in messages.  Does not affect messages  which
69              already have conversation information.
70
71              This is a bulk mode version of what happens to each message when
72              it arrives, and can be used to add missing conversation informa‐
73              tion  for  past messages, e.g. after using -z or after upgrading
74              Cyrus from older versions.  Note: this operation  uses  informa‐
75              tion  from  cyrus.cache  files so it does not need to read every
76              single message file.
77
78       -R     Recalculate counts of messages stored in existing  conversations
79              in  the  conversations database for user userid.  This is a lim‐
80              ited subset of -b; in particular it does  not  create  conversa‐
81              tions or assign messages to conversations.
82
83       -S     If  given  with -b, allows splitting of conversations during the
84              rewrite.   Only do this is  changing  the  maximum  conversation
85              size and you need to split those existing conversations.
86

EXAMPLES

88       [NB: Examples needed]
89

HISTORY

91       This command was introduced in version 3.0.
92

FILES

94       /etc/imapd.conf, <configurationdir>/conversations.db
95

SEE ALSO

97       imapd.conf(5), master(8)
98

AUTHOR

100       The Cyrus Team, Nic Bernstein (Onlight)
101
103       1993-2018, The Cyrus Team
104
105
106
107
1083.2.6                           March 09, 2021          CTL_CONVERSATIONSDB(8)
Impressum