NAME

       kopano-archiver-restore - Restore all stubbed and removed messages in a primary store with
       the messages found in the currently or previously attached archives(s).

SYNOPSIS

       kopano-archiver-restore [OPTION...]

DESCRIPTION

       kopano-archiver-restore can be used to repopulate a primary store to a state where no
       archive is required to read any message. In a less cryptic way this means that all stubbed
       messages are destubbed and all messages that were deleted after archiving are restored.

       The advantage of using kopano-archiver-restore over dragging the messages back from the
       archive in Outlook or Webaccess is that the restores messages are sanitized, allowing them
       to be properly rearchived later.

STRATEGY

       The strategy taken by kopano-archiver-restore is that it iterates through all folder in
       the primary store, and tries to open the archive folders that are attached to that store.
       There can be more than one attached archive folder, and these folders are not required to
       exist in an archive that is currently attached. So folders of previously used archives
       will be restored as well if they still exist.

       Once the archives have been resolved, kopano-archiver-restore will create a list of
       restorable messages based on the reference entryid found in the archived copies. When
       multiple archives are found, multiple archived copies for the same primary message can
       exist. In that case kopano-archiver-restore will choose the most recent one.

       Once the list of restorable messages is complete, kopano-archiver-restore will start
       restoring by first determining if the primary message, referenced by the reference entryid
       from the archived copies exist and if so if it is stubbed. If the primary message exists
       and is not stubbed, there's no need to restore anything. If the message exists but is
       stubbed, it will be destubbed. If the primary message does not exist, a new message is
       created based on the archived copy. In this case the archived copy is updated so it will
       reference the newly created message. This is needed to make sure a subsequent run of
       kopano-archiver-restore won't create another copy.

OPTIONS

       --detach
           Detach the selected or all archive stores before starting the restore procedure. This
           avoids the archiver from re-archiving restored messages.

       --unhook
           Unhook the selected ot all archive stores once the restore process has completed. This
           implies --detach and only works on archive stores.

       --remove
           Remove the selected ot all archive stores once the restore process has completed. This
           implies --unhook and only works on archive stores.

       --user, -u NAME
           Run the script for just the specified user(s). By default, it runs for all users.

       --log-level, -l NAME
           Specify log-level, for example, 'error', 'warning' 'info' or 'debug'.

       --server-socket, -s SOCKET
           Connect to storage server through specified socket.

       --ssl-key, -k FILE
           Specify SSL key file.

       --ssl-pass, -p PASSWORD
           Specify SSL key password.

AUTHOR

       Written by Zarafa.