diff --git a/source/administrator-guide/using-the-kolab-command-line.rst b/source/administrator-guide/using-the-kolab-command-line.rst --- a/source/administrator-guide/using-the-kolab-command-line.rst +++ b/source/administrator-guide/using-the-kolab-command-line.rst @@ -61,6 +61,33 @@ .. .. Not yet implemented. +.. _admin_cli_add-user-subscription: + +add-user-subscription +--------------------- + +Subscribes a user to a folder. + +.. rubric:: Synopsis + +.. parsed-literal:: + + kolab add-user-subscription + +.. rubric:: Command-Line Options + +.. option:: user + + Subscribe the specified user. + + .. NOTE:: + + The user will be subscribed only if the user also has rights to the folder. + +.. option:: pattern + + Subscribe the user specified to mailboxes matching the specified :term:`pattern`. + cm -- @@ -134,7 +161,7 @@ .. seealso:: - * :ref:`admin_cli_subscribe-user` + * :ref:`admin_cli_add-user-subscription` dam --- @@ -313,9 +340,40 @@ List folders the user is not subscribed to, instead of subscribed folders. +.. _admin_cli_rename-mailbox: + rename-mailbox -------------- +Renames a mailbox or sub-folder. + +.. rubric:: Synopsis + +.. parsed-literal:: + + kolab rename-mailbox [] + +.. rubric:: Command-Line Options + +.. program:: rename-mailbox + +.. option:: source + + Source mailbox name. + +.. option:: target + + Target mailbox name. + +.. option:: partition + + Optional partition name. + +rm +-- + +Short-hand for :ref:`admin_cli_rename-mailbox` + sam --- @@ -423,35 +481,6 @@ Set the mailbox metadata logged in as the user, enabling the modification of the /private metadata namespace annotation values. -.. _admin_cli_subscribe-user: - -subscribe-user --------------- - -.. rubric:: Synopsis - -.. parsed-literal:: - - kolab subscribe-user - -.. rubric:: Command-Line Options - -.. program:: subscribe-user - -.. option:: user - - Subscribe the specified user. - - .. NOTE:: - - The user will be subscribed only of the user also has rights to the - folder. - -.. option:: pattern - - Subscribe the user specified to mailboxes matching the specified - :term:`pattern`. - summarize-quota-allocation (sqa) -------------------------------- @@ -535,6 +564,33 @@ undelete-mailbox ---------------- +Recovers mailboxes previously deleted. + +.. rubric:: Synopsis + +.. parsed-literal:: + + kolab undelete-mailbox [options] [] + +.. rubric:: Command-Line Options + +.. program:: undelete-mailbox + +.. option:: mailbox + + Mailbox may be a string representing either of the following two options + - the fully qualified path of the deleted folder in its current location + (e.g. "DELETED/user/userid/hex[@domain]") or the original folder name, such as "user/userid[@domain]". + +.. option:: target + + Target may be the target folder to "undelete" the deleted folder to. + If not specified, the original folder name is used. + +.. option:: --dry-run + + Do not actually execute, but state what would have been executed. + user-info --------- @@ -560,11 +616,48 @@ Sieve Operations ================ -list ----- +sieve-list +---------- -put ---- +Retrieves list of sieve scripts of a user. + +.. rubric:: Synopsis + +.. parsed-literal:: + + kolab sieve-list + +sieve-put +--------- + +Put a sieve script to a user mailbox. + +.. rubric:: Synopsis + +.. parsed-literal:: + + kolab sieve-put + +sieve-refresh +------------- + +Refresh a user's managed and contributed sieve scripts. It will re-generate +sieve scripts content according to LDAP attributes of the user record and KE#14 +in a way defined in ``sievemgmt`` plugin of kolab daemon. + +.. rubric:: Synopsis + +.. parsed-literal:: + + kolab sieve-refresh + +sieve-test +---------- + +Syntactically checks sieve scripts of a user. + +.. rubric:: Synopsis + +.. parsed-literal:: -refresh -------- + kolab sieve-test