Page MenuHomePhorge
Differential D210 Diff 458 source/administrator-guide/using-the-kolab-command-line.rst

Changeset View

Standalone View

View Options

source/administrator-guide/using-the-kolab-command-line.rst

Show First 20 Lines • Show All 55 Lines • ▼ Show 20 Lines
.. ..
.. Not yet implemented. .. Not yet implemented.
.. ..
.. add-user .. add-user
.. -------- .. --------
.. ..
.. Not yet implemented. .. 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 <user> <pattern>
.. 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 cm
-- --
Short-hand for :ref:`admin_cli_create-mailbox`. Short-hand for :ref:`admin_cli_create-mailbox`.
.. _admin_cli_create-mailbox: .. _admin_cli_create-mailbox:
create-mailbox create-mailbox
▲ Show 20 Lines • Show All 57 Lines • ▼ Show 20 Lines.. parsed-literal::
# :command:`kolab create-mailbox` \\ # :command:`kolab create-mailbox` \\
--user john.doe@example.org \\ --user john.doe@example.org \\
--metadata=/private/vendor/kolab/folder-type=event.default \\ --metadata=/private/vendor/kolab/folder-type=event.default \\
"New Calendar" "New Calendar"
.. seealso:: .. seealso::
* :ref:`admin_cli_subscribe-user` * :ref:`admin_cli_add-user-subscription`
dam dam
--- ---
Short-hand for :ref:`admin_cli_delete-mailbox-acl` Short-hand for :ref:`admin_cli_delete-mailbox-acl`
.. delete-domain .. delete-domain
.. ------------- .. -------------
▲ Show 20 Lines • Show All 162 Lines • ▼ Show 20 Lines
.. option:: user .. option:: user
The user identifier to list the (un)subscribed folders for. The user identifier to list the (un)subscribed folders for.
.. option:: --unsubscribed .. option:: --unsubscribed
List folders the user is not subscribed to, instead of subscribed folders. List folders the user is not subscribed to, instead of subscribed folders.
.. _admin_cli_rename-mailbox:
rename-mailbox rename-mailbox
-------------- --------------
Renames a mailbox or sub-folder.
.. rubric:: Synopsis
.. parsed-literal::
kolab rename-mailbox <source> <target> [<partition>]
.. 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 sam
--- ---
Short-hand for :ref:`admin_cli_set-mailbox-acl` Short-hand for :ref:`admin_cli_set-mailbox-acl`
.. _admin_cli_set-mailbox-acl: .. _admin_cli_set-mailbox-acl:
set-mailbox-acl set-mailbox-acl
▲ Show 20 Lines • Show All 91 Lines • ▼ Show 20 Lines
.. program:: set-mailbox-metadata .. program:: set-mailbox-metadata
.. option:: --user user .. option:: --user user
Set the mailbox metadata logged in as the user, enabling the modification of Set the mailbox metadata logged in as the user, enabling the modification of
the /private metadata namespace annotation values. the /private metadata namespace annotation values.
.. _admin_cli_subscribe-user:
subscribe-user
--------------
.. rubric:: Synopsis
.. parsed-literal::
kolab subscribe-user <user> <pattern>
.. 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) summarize-quota-allocation (sqa)
-------------------------------- --------------------------------
Summarize all quota allocation for all mailboxes. Summarize all quota allocation for all mailboxes.
.. rubric:: Command-Line Options .. rubric:: Command-Line Options
.. program:: summarize-quota-allocation .. program:: summarize-quota-allocation
▲ Show 20 Lines • Show All 67 Lines • ▼ Show 20 Lines
.. ..
.. When initially connecting to list the mailboxes matching .. When initially connecting to list the mailboxes matching
.. :option:`transfer-mailbox pattern`, connect to the server specified, instead .. :option:`transfer-mailbox pattern`, connect to the server specified, instead
.. of the configured IMAP server. .. of the configured IMAP server.
undelete-mailbox undelete-mailbox
---------------- ----------------
Recovers mailboxes previously deleted.
.. rubric:: Synopsis
.. parsed-literal::
kolab undelete-mailbox [options] <mailbox> [<target>]
.. 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 user-info
--------- ---------
This command retrieves information about a user from the Web Administration This command retrieves information about a user from the Web Administration
Panel API (places a ``user.info`` API call), and prints all attributes for the Panel API (places a ``user.info`` API call), and prints all attributes for the
corresponding user type. corresponding user type.
.. rubric:: Synopsis .. rubric:: Synopsis
Show All 9 Lines
.. option:: address .. option:: address
The primary or secondary recipient email address for the user, that is The primary or secondary recipient email address for the user, that is
globally unique, such as ``john.doe@example.org``. globally unique, such as ``john.doe@example.org``.
Sieve Operations Sieve Operations
================ ================
list sieve-list
---- ----------
put Retrieves list of sieve scripts of a user.
---
.. rubric:: Synopsis
.. parsed-literal::
kolab sieve-list <email>
sieve-put
---------
Put a sieve script to a user mailbox.
.. rubric:: Synopsis
.. parsed-literal::
kolab sieve-put <email> <file> <script_name>
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 <email>
sieve-test
----------
Syntactically checks sieve scripts of a user.
.. rubric:: Synopsis
.. parsed-literal::
refresh kolab sieve-test <email>
-------