JAMES-2396 Adding a navigation menu to webadmin documentation page
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/5da7e2e0 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/5da7e2e0 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/5da7e2e0 Branch: refs/heads/master Commit: 5da7e2e01aa6823965790b3d8026970f28471323 Parents: 189490a Author: benwa <btell...@linagora.com> Authored: Fri May 11 10:54:39 2018 +0700 Committer: Matthieu Baechler <matth...@apache.org> Committed: Thu May 17 09:54:19 2018 +0200 ---------------------------------------------------------------------- src/site/markdown/server/manage-webadmin.md | 84 ++++++++++++++++++++++++ 1 file changed, 84 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/5da7e2e0/src/site/markdown/server/manage-webadmin.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md index cc69984..f61d79c 100644 --- a/src/site/markdown/server/manage-webadmin.md +++ b/src/site/markdown/server/manage-webadmin.md @@ -19,8 +19,28 @@ In case of any error, the system will return an error message which is json form } ``` +## Navigation menu + + - [Administrating domains](#Administrating_domains) + - [Administrating users](#Administrating_users) + - [Administrating user mailboxes](#Administrating_user_mailboxes) + - [Administrating quotas by users](#Administrating_quotas_by_users) + - [Administrating quotas by domains](#Administrating_quotas_by_domains) + - [Cassandra Schema upgrades](#Cassandra_Schema_upgrades) + - [Correcting ghost mailbox](#Correcting_ghost_mailbox) + - [Creating address group](#Creating_address_group) + - [Creating address forwards](#Creating_address_forwards) + - [Administrating mail repositories](#Administrating_mail_repositories) + - [Administrating mail queues](#Administrating_mail_queues) + - [Task management](#Task_management) + ## Administrating domains + - [Create a domain](#Create_a_domain) + - [Delete a domain](#Delete_a_domain) + - [Test if a domain exists](#Test_if_a_domain_exists) + - [Get the list of domains](#Get_the_list_of_domains) + ### Create a domain ``` @@ -82,6 +102,11 @@ Response codes: ## Administrating users + - [Create a user](#Create_a_user) + - [Updating a user password](#Updating_a_user_password) + - [Deleting a domain](#Deleting_a_user) + - [Retrieving the user list](#Retrieving_the_user_list) + ### Create a user ``` @@ -139,6 +164,12 @@ Response codes: ## Administrating user mailboxes + - [Creating a mailbox](#Creating_a_mailbox) + - [Deleting a mailbox and its children](#Deleting_a_mailbox_and_its_children) + - [Testing existence of a mailbox](#Testing_existence_of_a_mailbox) + - [Listing user mailboxes](#Listing_user_mailboxes) + - [Deleting_user_mailboxes](#Deleting_user_mailboxes) + ### Creating a mailbox ``` @@ -229,6 +260,15 @@ Response codes: ## Administrating quotas by users + - [Getting the quota for a user](#Getting_the_quota_for_a_user) + - [Updating the quota for a user](#Updating_the_quota_for_a_user) + - [Getting the quota count for a user](#Getting_the_quota_count_for_a_user) + - [Updating the quota count for a user](#Updating_the_quota_count_for_a_user) + - [Deleting the quota count for a user](#Deleting_the_quota_count_for_a_user) + - [Getting the quota size for a user](#Getting_the_quota_size_for_a_user) + - [Updating the quota size for a user](#Updating_the_quota_size_for_a_user) + - [Deleting the quota size for a user](#Deleting_the_quota_size_for_a_user) + ### Getting the quota for a user ``` @@ -413,6 +453,15 @@ Response codes: ## Administrating quotas by domains + - [Getting the quota for a domain](#Getting_the_quota_for_a_domain) + - [Updating the quota for a domain](#Updating_the_quota_for_a_domain) + - [Getting the quota count for a domain](#Getting_the_quota_count_for_a_domain) + - [Updating the quota count for a domain](#Updating_the_quota_count_for_a_domain) + - [Deleting the quota count for a domain](#Deleting_the_quota_count_for_a_domain) + - [Getting the quota size for a domain](#Getting_the_quota_size_for_a_domain) + - [Updating the quota size for a domain](#Updating_the_quota_size_for_a_domain) + - [Deleting the quota size for a domain](#Deleting_the_quota_size_for_a_domain) + ### Getting the quota for a domain ``` @@ -606,6 +655,11 @@ These schema updates can be triggered by webadmin using the Cassandra backend. Note that currently the progress can be tracked by logs. + - [Retrieving current Cassandra schema version](#Retrieving_current_Cassandra_schema_version) + - [Retrieving latest available Cassandra schema version](#Retrieving_latest_available_Cassandra_schema_version) + - [Upgrading to a specific version](#Upgrading_to_a_specific_version) + - [Upgrading to the latest version](#Upgrading_to_the_latest_version) + ### Retrieving current Cassandra schema version ``` @@ -773,6 +827,11 @@ to be configured. Note that email addresses are restricted to ASCII character set. Mail addresses not matching this criteria will be rejected. + - [Listing groups](#Listing_groups) + - [Listing members of a group](#Listing_members_of_a_group) + - [Adding a group member](#Adding_a_group_member) + - [Removing a group member](#Removing_a_group_member) + ### Listing groups ``` @@ -856,6 +915,11 @@ to be configured. Note that email addresses are restricted to ASCII character set. Mail addresses not matching this criteria will be rejected. + - [Listing Forwards](#Listing_Forwards) + - [Listing destinations in a forward](#Listing_destinations_in_a_forward) + - [Adding a new destination to a forward](#Adding_a_new_destination_to_a_forward) + - [Removing a destination of a forward](#Removing_a_destination_of_a_forward) + ### Listing Forwards ``` @@ -927,6 +991,15 @@ Response codes: ## Administrating mail repositories + - [Listing mail repositories](#Listing_mail_repositories) + - [Getting additional information for a mail repository](#Getting_additional_information_for_a_mail_repository) + - [Listing mails contained in a mail repository](#Listing_mails_contained_in_a_mail_repository) + - [Reading a mail details](#Reading_a_mail_details) + - [Removing a mail from a mail repository](#Removing_a_mail_from_a_mail_repository) + - [Removing all mails from a mail repository](#Removing_all_mails_from_a_mail_repository) + - [Reprocessing mails from a mail repository](#Reprocessing_mails_from_a_mail_repository) + - [Reprocessing a specific mail from a mail repository](#Reprocessing_a_specific_mail_from_a_mail_repository) + ### Listing mail repositories ``` @@ -1250,6 +1323,12 @@ The scheduled task will have the following type `reprocessingOneTask` and the fo ## Administrating mail queues + - [Listing mail queues](#Listing_mail_queues) + - [Getting a mail queue details](#Getting_a_mail_queue_details) + - [Listing the mails of a mail queue](#Listing_the_mails_of_a_mail_queue) + - [Deleting mails from a mail queue](#Deleting_mails_from_a_mail_queue) + - [Flushing mails from a mail queue](#Flushing_mails_from_a_mail_queue) + ### Listing mail queues ``` @@ -1365,6 +1444,11 @@ Some webadmin features schedules tasks. The task management API allow to monitor Note that the `taskId` used in the following APIs is returned by other WebAdmin APIs scheduling tasks. + - [Getting a task details](#Getting_a_task_details) + - [Awaiting a task](#Awaiting_a_task) + - [Cancelling a task](#Cancelling_a_task) + - [Listing tasks](#Listing_tasks) + ### Getting a task details ``` --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
