cyr_backup - Cyrus IMAP documentation

Author

       The Cyrus Team

Copyright

       1993–2025, The Cyrus Team

3.10.2                                            Jun 27, 2025                                     CYR_BACKUP(8)

Description

NOTE:
          Cyrus Backups are experimental, incomplete, and deprecated as of 3.10.

       cyr_backup is a tool for inspecting the contents of a Cyrus backup.

       cyr_backup  reads  its  configuration options out of the imapd.conf(5) file unless specified otherwise by
       -C.

       In all invocations, backup is interpreted according to the specified MODE.  See Modes below.

       cyr_backup provides the following sub-commands:

       listcyr_backup [OPTIONS] [MODE] backup list chunks
                 cyr_backup [OPTIONS] [MODE] backup list mailboxes
                 cyr_backup [OPTIONS] [MODE] backup list messages
                 cyr_backup [OPTIONS] [MODE] backup list all

              Listchunks,mailboxes,ormessagescontainedinbackup.showcyr_backup [OPTIONS] [MODE] backup show mailboxes [ mboxname | uniqueid ]...
                 cyr_backup [OPTIONS] [MODE] backup show messages guid...

              showmailboxesshowsthecontents(i.e.thecontainedmessages)ofmailboxesmatchingeachgivenmboxnameoruniqueidinthenamedbackup.Theuid,expungedtime,andguidofeachmessageareshown.showmessagesshowsdetailsofmessagesmatchingeachgivenguidinthenamedbackup.Theguid,containingmailboxes,andMIMEheadersofeachmessageareshown.dumpcyr_backup [OPTIONS] [MODE] backup dump chunk idcyr_backup [OPTIONS] [MODE] backup dump message guidDumpthecontentsofthespecifiedchunkormessagecontainedinthenamedbackuptostandardout.Chunksareoutputasuncompressedbackupdataformat(whichisareplicationprotocolstream).Messagesareoutputintheiron-diskformat(typicallyMIME).dumpchunkismainlyusefulfordiagnosticpurposes.dumpmessagemaybeusefulaspartofamanualmessagerestorationprocess,whentherestorationdestinationdoesnotsupporttherestore(8)command.jsoncyr_backup [OPTIONS] [MODE] backup json chunks
                 cyr_backup [OPTIONS] [MODE] backup json mailboxes
                 cyr_backup [OPTIONS] [MODE] backup json messages
                 cyr_backup [OPTIONS] [MODE] backup json headers guid...

              Dumpinformationaboutthechunks,mailboxesormessagescontainedinthenamedbackuptostandardout,inJSONformat.

Examples

Files

History

Modes

-f,--filenamebackup  is  interpreted  as  a  filename.   The  named file does not need to be known about in the
              backups database.

       -m,--mailboxbackup is interpreted as a mailbox name.  There must be a known backup for the user whose  mailbox
              this is.

              Known  backups  are  recorded  in  the  database  specified  by  the  backup_db and backup_db_path
              configuration options.

       -u,--useridbackup is interpreted as a userid.  There must be a known backup for the specified user.

              This is the default if no mode is specified.

Name

       cyr_backup - Cyrus IMAP documentation

       Inspect contents of Cyrus backups.

Options

-Cconfig-file
              Use the specified configuration file config-file rather than the default imapd.conf(5).

       -v,--verbose
              Increase the verbosity.  Can be specified multiple times.

Synopsis

cyr_backup [OPTIONS] [MODE] backup list chunks
          cyr_backup [OPTIONS] [MODE] backup list mailboxes
          cyr_backup [OPTIONS] [MODE] backup list messages
          cyr_backup [OPTIONS] [MODE] backup list all
          cyr_backup [OPTIONS] [MODE] backup show mailboxes [ mboxname | uniqueid ]...
          cyr_backup [OPTIONS] [MODE] backup show messages guid...
          cyr_backup [OPTIONS] [MODE] backup dump chunk idcyr_backup [OPTIONS] [MODE] backup dump message guidcyr_backup [OPTIONS] [MODE] backup json chunks
          cyr_backup [OPTIONS] [MODE] backup json mailboxes
          cyr_backup [OPTIONS] [MODE] backup json messages
          cyr_backup [OPTIONS] [MODE] backup json headers guid...