http://git-wip-us.apache.org/repos/asf/james-site/blob/446b2187/content/server/manage-webadmin.html ---------------------------------------------------------------------- diff --git a/content/server/manage-webadmin.html b/content/server/manage-webadmin.html index 7b89212..cfe99b1 100644 --- a/content/server/manage-webadmin.html +++ b/content/server/manage-webadmin.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- Generated by Apache Maven Doxia at 2018-03-22 --> +<!-- Generated by Apache Maven Doxia at 2018-06-07 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -36,7 +36,7 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20180322" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> <!-- Google Analytics --> @@ -74,7 +74,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2018-03-22</span> + <span id="publishDate">Last Published: 2018-06-07</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -105,7 +105,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -114,7 +114,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="collapsed"> @@ -126,7 +126,7 @@ <li class="collapsed"> <a href="../server/install.html" title="3. Install James">3. Install James</a> </li> - <li class="collapsed"> + <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> <li class="expanded"> @@ -244,7 +244,49 @@ } </pre></div></div> <div class="section"> +<h2><a name="Navigation_menu"></a>Navigation menu</h2> + +<ul> + +<li><a href="#administrating-domains">Administrating domains</a></li> + +<li><a href="#administrating-users">Administrating users</a></li> + +<li><a href="#administrating-user-mailboxes">Administrating user mailboxes</a></li> + +<li><a href="#administrating-quotas-by-users">Administrating quotas by users</a></li> + +<li><a href="#administrating-quotas-by-domains">Administrating quotas by domains</a></li> + +<li><a href="#administrating-global-quotas">Administrating global quotas</a></li> + +<li><a href="#cassandra-schema-upgrades">Cassandra Schema upgrades</a></li> + +<li><a href="#correcting-ghost-mailbox">Correcting ghost mailbox</a></li> + +<li><a href="#creating-address-group">Creating address group</a></li> + +<li><a href="#creating-address-forwards">Creating address forwards</a></li> + +<li><a href="#administrating-mail-repositories">Administrating mail repositories</a></li> + +<li><a href="#administrating-mail-queues">Administrating mail queues</a></li> + +<li><a href="#task-management">Task management</a></li> +</ul></div> +<div class="section"> <h2><a name="Administrating_domains"></a>Administrating domains</h2> + +<ul> + +<li><a href="#create-a-domain">Create a domain</a></li> + +<li><a href="#delete-a-domain">Delete a domain</a></li> + +<li><a href="#test-if-a-domain-exists">Test if a domain exists</a></li> + +<li><a href="#get-the-list-of-domains">Get the list of domains</a></li> +</ul> <div class="section"> <h3><a name="Create_a_domain"></a>Create a domain</h3> @@ -329,6 +371,17 @@ </ul></div></div> <div class="section"> <h2><a name="Administrating_users"></a>Administrating users</h2> + +<ul> + +<li><a href="#create-a-user">Create a user</a></li> + +<li><a href="#updating-a-user-password">Updating a user password</a></li> + +<li><a href="#deleting-a-user">Deleting a domain</a></li> + +<li><a href="#retrieving-the-user-list">Retrieving the user list</a></li> +</ul> <div class="section"> <h3><a name="Create_a_user"></a>Create a user</h3> @@ -401,6 +454,19 @@ </ul></div></div> <div class="section"> <h2><a name="Administrating_user_mailboxes"></a>Administrating user mailboxes</h2> + +<ul> + +<li><a href="#creating-a-mailbox">Creating a mailbox</a></li> + +<li><a href="#deleting-a-mailbox-and-its-children">Deleting a mailbox and its children</a></li> + +<li><a href="#testing-existence-of-a-mailbox">Testing existence of a mailbox</a></li> + +<li><a href="#listing-user-mailboxes">Listing user mailboxes</a></li> + +<li><a href="#deleting-user-mailboxes">Deleting_user_mailboxes</a></li> +</ul> <div class="section"> <h3><a name="Creating_a_mailbox"></a>Creating a mailbox</h3> @@ -511,6 +577,27 @@ </ul></div></div> <div class="section"> <h2><a name="Administrating_quotas_by_users"></a>Administrating quotas by users</h2> + +<ul> + +<li><a href="#getting-the-quota-for-a-user">Getting the quota for a user</a></li> + +<li><a href="#updating-the-quota-for-a-user">Updating the quota for a user</a></li> + +<li><a href="#getting-the-quota-count-for-a-user">Getting the quota count for a user</a></li> + +<li><a href="#updating-the-quota-count-for-a-user">Updating the quota count for a user</a></li> + +<li><a href="#deleting-the-quota-count-for-a-user">Deleting the quota count for a user</a></li> + +<li><a href="#getting-the-quota-size-for-a-user">Getting the quota size for a user</a></li> + +<li><a href="#updating-the-quota-size-for-a-user">Updating the quota size for a user</a></li> + +<li><a href="#deleting-the-quota-size-for-a-user">Deleting the quota size for a user</a></li> + +<li><a href="#searching-user-by-quota-ratio">Searching user by quota ratio</a></li> +</ul> <div class="section"> <h3><a name="Getting_the_quota_for_a_user"></a>Getting the quota for a user</h3> @@ -524,10 +611,31 @@ <div class="source"> <div class="source"> <pre>{ - "global": {"count":252,"size":242}, - "domain": {"count":152,"size":142}, - "user": {"count":52,"size":42}, - "computed": {"count":52,"size":42} + "global": { + "count":252, + "size":242 + }, + "domain": { + "count":152, + "size":142 + }, + "user": { + "count":52, + "size":42 + }, + "computed": { + "count":52, + "size":42 + }, + "occupation": { + "size":1000, + "count":10000, + "ratio": { + "size":0.8, + "count":0.6, + "max":0.8 + } + } } </pre></div></div> @@ -540,6 +648,8 @@ <li>The <tt>user</tt> entry represent the quota limit allowed for this specific user.</li> <li>The <tt>computed</tt> entry represent the quota limit applied for this user, resolved from the upper values.</li> + +<li>The <tt>occupation</tt> entry represent the occupation of the quota for this user. This includes used count and size as well as occupation ratio (used / limit).</li> </ul> <p>Note that <tt>quota</tt> object can contain a fixed value, an empty value (null) or an unlimited value (-1):</p> @@ -740,9 +850,99 @@ <li>409: The requested restriction can’t be enforced right now.</li> <li>500: Internal server error - Something went bad on the server side.</li> +</ul></div> +<div class="section"> +<h3><a name="Searching_user_by_quota_ratio"></a>Searching user by quota ratio</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XGET http://ip:port/quota/users?minOccupationRatio=0.8&maxOccupationRatio=0.99&limit=100&offset=200&domain=oppen-paas.org +</pre></div></div> +<p>Will return:</p> + +<div class="source"> +<div class="source"> +<pre>[ + { + "username":"[email protected]", + "detail": { + "global": { + "count":252, + "size":242 + }, + "domain": { + "count":152, + "size":142 + }, + "user": { + "count":52, + "size":42 + }, + "computed": { + "count":52, + "size":42 + }, + "occupation": { + "size":1000, + "count":10000, + "ratio": { + "size":0.8, + "count":0.6, + "max":0.8 + } + } + } + }, + ... +] +</pre></div></div> +<p>Where:</p> + +<ul> + +<li><b>minOccupationRatio</b> is a query parameter determining the minimum occupation ratio of users to be returned.</li> + +<li><b>maxOccupationRatio</b> is a query parameter determining the maximum occupation ratio of users to be returned.</li> + +<li><b>domain</b> is a query parameter determining the domain of users to be returned.</li> + +<li><b>limit</b> is a query parameter determining the maximum number of users to be returned.</li> + +<li><b>offset</b> is a query parameter determining the number of users to skip.</li> +</ul> +<p>Please note that users are alphabetically ordered on username.</p> +<p>The response is a list of usernames, with attached quota details as defined <a href="#getting-the-quota-for-a-user">here</a>.</p> +<p>Response codes:</p> + +<ul> + +<li>200: List of users had successfully been returned.</li> + +<li>400: Validation issues with parameters</li> + +<li>500: Internal server error - Something went bad on the server side.</li> </ul></div></div> <div class="section"> <h2><a name="Administrating_quotas_by_domains"></a>Administrating quotas by domains</h2> + +<ul> + +<li><a href="#getting-the-quota-for-a-domain">Getting the quota for a domain</a></li> + +<li><a href="#updating-the-quota-for-a-domain">Updating the quota for a domain</a></li> + +<li><a href="#getting-the-quota-count-for-a-domain">Getting the quota count for a domain</a></li> + +<li><a href="#updating-the-quota-count-for-a-domain">Updating the quota count for a domain</a></li> + +<li><a href="#deleting-the-quota-count-for-a-domain">Deleting the quota count for a domain</a></li> + +<li><a href="#getting-the-quota-size-for-a-domain">Getting the quota size for a domain</a></li> + +<li><a href="#updating-the-quota-size-for-a-domain">Updating the quota size for a domain</a></li> + +<li><a href="#deleting-the-quota-size-for-a-domain">Deleting the quota size for a domain</a></li> +</ul> <div class="section"> <h3><a name="Getting_the_quota_for_a_domain"></a>Getting the quota for a domain</h3> @@ -971,12 +1171,238 @@ <li>500: Internal server error - Something went bad on the server side.</li> </ul></div></div> <div class="section"> +<h2><a name="Administrating_global_quotas"></a>Administrating global quotas</h2> + +<ul> + +<li><a href="#getting-the-global-quota">Getting the global quota</a></li> + +<li><a href="#updating-global-quota">Updating global quota</a></li> + +<li><a href="#getting-the-global-quota-count">Getting the global quota count</a></li> + +<li><a href="#updating-the-global-quota-count">Updating the global quota count</a></li> + +<li><a href="#deleting-the-global-quota-count">Deleting the global quota count</a></li> + +<li><a href="#getting-the-global-quota-size">Getting the global quota size</a></li> + +<li><a href="#updating-the-global-quota-size">Updating the global quota size</a></li> + +<li><a href="#deleting-the-global-quota-size">Deleting the global quota size</a></li> +</ul> +<div class="section"> +<h3><a name="Getting_the_global_quota"></a>Getting the global quota</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XGET http://ip:port/quota/ +</pre></div></div> +<p>Resource name usernameToBeUsed should be an existing user</p> +<p>The answer is the details of the quota of that user.</p> + +<div class="source"> +<div class="source"> +<pre>{ + "count":252, + "size":242 +} +</pre></div></div> +<p>Note that <tt>quota</tt> object can contain a fixed value, an empty value (null) or an unlimited value (-1):</p> + +<div class="source"> +<div class="source"> +<pre>{"count":52,"size":42} + +{"count":null,"size":null} + +{"count":52,"size":-1} +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>200: The quota was successfully retrieved</li> + +<li>500: Internal error while accessing quota</li> +</ul></div> +<div class="section"> +<h3><a name="Updating_global_quota"></a>Updating global quota</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XPUT http://ip:port/quota +</pre></div></div> +<p>The body can contain a fixed value, an empty value (null) or an unlimited value (-1):</p> + +<div class="source"> +<div class="source"> +<pre>{"count":52,"size":42} + +{"count":null,"size":null} + +{"count":52,"size":-1} +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>204: The quota has been updated</li> + +<li>400: The body is not a positive integer neither an unlimited value (-1).</li> + +<li>500: Internal server error - Something went bad on the server side.</li> +</ul></div> +<div class="section"> +<h3><a name="Getting_the_global_quota_count"></a>Getting the global quota count</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XGET http://ip:port/quota/count +</pre></div></div> +<p>Resource name usernameToBeUsed should be an existing user</p> +<p>The answer looks like:</p> + +<div class="source"> +<div class="source"> +<pre>52 +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>200: The quota was successfully retrieved</li> + +<li>500: Internal error while accessing the quota</li> +</ul></div> +<div class="section"> +<h3><a name="Updating_the_global_quota_count"></a>Updating the global quota count</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XPUT http://ip:port/quota/count +</pre></div></div> +<p>The body can contain a fixed value or an unlimited value (-1):</p> + +<div class="source"> +<div class="source"> +<pre>52 +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>204: The quota has been updated</li> + +<li>400: The body is not a positive integer neither an unlimited value (-1).</li> + +<li>500: Internal server error - Something went bad on the server side.</li> +</ul></div> +<div class="section"> +<h3><a name="Deleting_the_global_quota_count"></a>Deleting the global quota count</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XDELETE http://ip:port/quota/users/usernameToBeUsed/count +</pre></div></div> +<p>Resource name usernameToBeUsed should be an existing user</p> +<p>Response codes:</p> + +<ul> + +<li>204: The quota has been updated to unlimited value.</li> + +<li>400: The body is not a positive integer neither an unlimited value (-1).</li> + +<li>404: The user does not exist</li> + +<li>409: The requested restriction can’t be enforced right now.</li> + +<li>500: Internal server error - Something went bad on the server side.</li> +</ul></div> +<div class="section"> +<h3><a name="Getting_the_global_quota_size"></a>Getting the global quota size</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XGET http://ip:port/quota/size +</pre></div></div> +<p>The answer looks like:</p> + +<div class="source"> +<div class="source"> +<pre>52 +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>200: The quota was successfully retrieved</li> + +<li>500: Internal error while accessing the quota</li> +</ul></div> +<div class="section"> +<h3><a name="Updating_the_global_quota_size"></a>Updating the global quota size</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XPUT http://ip:port/quota/size +</pre></div></div> +<p>The body can contain a fixed value or an unlimited value (-1):</p> + +<div class="source"> +<div class="source"> +<pre>52 +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>204: The quota has been updated</li> + +<li>400: The body is not a positive integer neither an unlimited value (-1).</li> + +<li>409: The requested restriction can’t be enforced right now.</li> + +<li>500: Internal server error - Something went bad on the server side.</li> +</ul></div> +<div class="section"> +<h3><a name="Deleting_the_global_quota_size"></a>Deleting the global quota size</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XDELETE http://ip:port/quota/size +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>204: The quota has been updated to unlimited value.</li> + +<li>400: The body is not a positive integer neither an unlimited value (-1).</li> + +<li>409: The requested restriction can’t be enforced right now.</li> + +<li>500: Internal server error - Something went bad on the server side.</li> +</ul></div></div> +<div class="section"> <h2><a name="Cassandra_Schema_upgrades"></a>Cassandra Schema upgrades</h2> <p>Cassandra upgrades implies the creation of a new table. Thus restarting James is needed, as new tables are created on restart.</p> <p>Once done, we ship code that tries to read from new tables, and if not possible backs up to old tables. You can thus safely run without running additional migrations.</p> <p>On the fly migration can be enabled. However, one might want to force the migration in a controlled fashion, and update automatically current schema version used (assess in the database old versions is no more used, as the corresponding tables are empty). Note that this process is safe: we ensure the service is not running concurrently on this James instance, that it does not bump version upon partial failures, that race condition in version upgrades will be idempotent, etc…</p> <p>These schema updates can be triggered by webadmin using the Cassandra backend.</p> <p>Note that currently the progress can be tracked by logs.</p> + +<ul> + +<li><a href="#retrieving-current-cassandra-schema-version">Retrieving current Cassandra schema version</a></li> + +<li><a href="#retrieving-latest-available-cassandra-schema-version">Retrieving latest available Cassandra schema version</a></li> + +<li><a href="#upgrading-to-a-specific-version">Upgrading to a specific version</a></li> + +<li><a href="#upgrading-to-the-latest-version">Upgrading to the latest version</a></li> +</ul> <div class="section"> <h3><a name="Retrieving_current_Cassandra_schema_version"></a>Retrieving current Cassandra schema version</h3> @@ -1156,8 +1582,20 @@ <h2><a name="Creating_address_group"></a>Creating address group</h2> <p>You can use <b>webadmin</b> to define address groups.</p> <p>When a specific email is sent to the group mail address, every group member will receive it.</p> +<p>Note that the group mail address is virtual: it does not correspond to an existing user.</p> <p>This feature uses <a href="/server/config-recipientrewritetable.html">Recipients rewrite table</a> and requires the <a class="externalLink" href="https://github.com/apache/james-project/blob/master/server/mailet/mailets/src/main/java/org/apache/james/transport/mailets/RecipientRewriteTable.java";>RecipientRewriteTable mailet</a> to be configured.</p> <p>Note that email addresses are restricted to ASCII character set. Mail addresses not matching this criteria will be rejected.</p> + +<ul> + +<li><a href="#listing-groups">Listing groups</a></li> + +<li><a href="#listing-members-of-a-group">Listing members of a group</a></li> + +<li><a href="#adding-a-group-member">Adding a group member</a></li> + +<li><a href="#removing-a-group-member">Removing a group member</a></li> +</ul> <div class="section"> <h3><a name="Listing_groups"></a>Listing groups</h3> @@ -1245,7 +1683,134 @@ <li>500: Internal error</li> </ul></div></div> <div class="section"> +<h2><a name="Creating_address_forwards"></a>Creating address forwards</h2> +<p>You can use <b>webadmin</b> to define address forwards.</p> +<p>When a specific email is sent to the base mail address, every forward destination addresses will receive it.</p> +<p>Please note that the base address can be optionaly part of the forward destination. In that case, the base recipient also receive a copy of the mail. Otherwise he is ommitted.</p> +<p>Forwards can be defined for existing users. It then defers from “groups”.</p> +<p>This feature uses <a href="/server/config-recipientrewritetable.html">Recipients rewrite table</a> and requires the <a class="externalLink" href="https://github.com/apache/james-project/blob/master/server/mailet/mailets/src/main/java/org/apache/james/transport/mailets/RecipientRewriteTable.java";>RecipientRewriteTable mailet</a> to be configured.</p> +<p>Note that email addresses are restricted to ASCII character set. Mail addresses not matching this criteria will be rejected.</p> + +<ul> + +<li><a href="#listing-forwards">Listing Forwards</a></li> + +<li><a href="#listing-destinations-in-a-forward">Listing destinations in a forward</a></li> + +<li><a href="#adding-a-new-destination-to-a-forward">Adding a new destination to a forward</a></li> + +<li><a href="#removing-a-destination-of-a-forward">Removing a destination of a forward</a></li> +</ul> +<div class="section"> +<h3><a name="Listing_Forwards"></a>Listing Forwards</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XGET http://ip:port/address/forwards +</pre></div></div> +<p>Will return the users having forwards configured as a list of JSON Strings representing mail addresses. For instance:</p> + +<div class="source"> +<div class="source"> +<pre>["[email protected]", "[email protected]"] +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>200: Success</li> + +<li>500: Internal error</li> +</ul></div> +<div class="section"> +<h3><a name="Listing_destinations_in_a_forward"></a>Listing destinations in a forward</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XGET http://ip:port/address/forwards/[email protected] +</pre></div></div> +<p>Will return the destination addresses of this forward as a list of JSON Strings representing mail addresses. For instance:</p> + +<div class="source"> +<div class="source"> +<pre>[ + {"mailAddres":"[email protected]"}, + {"mailAddres":"[email protected]"} +] +</pre></div></div> +<p>Response codes:</p> + +<ul> + +<li>200: Success</li> + +<li>400: Forward structure is not valid</li> + +<li>404: The given user don’t have forwards or does not exist</li> + +<li>500: Internal error</li> +</ul></div> +<div class="section"> +<h3><a name="Adding_a_new_destination_to_a_forward"></a>Adding a new destination to a forward</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XPUT http://ip:port/address/forwards/[email protected]/targets/[email protected] +</pre></div></div> +<p>Will add <a class="externalLink" href="mailto:[email protected]";>[email protected]</a> to <a class="externalLink" href="mailto:[email protected]";>[email protected]</a>, creating the forward if needed</p> +<p>Response codes:</p> + +<ul> + +<li>200: Success</li> + +<li>400: Forward structure or member is not valid</li> + +<li>403: Server does not own the requested domain</li> + +<li>404: Requested forward address does not match an existing user</li> + +<li>500: Internal error</li> +</ul></div> +<div class="section"> +<h3><a name="Removing_a_destination_of_a_forward"></a>Removing a destination of a forward</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XDELETE http://ip:port/address/forwards/[email protected]/targets/[email protected] +</pre></div></div> +<p>Will remove <a class="externalLink" href="mailto:[email protected]";>[email protected]</a> from <a class="externalLink" href="mailto:[email protected]";>[email protected]</a>, removing the forward if forward is empty after deletion</p> +<p>Response codes:</p> + +<ul> + +<li>200: Success</li> + +<li>400: Forward structure or member is not valid</li> + +<li>500: Internal error</li> +</ul></div></div> +<div class="section"> <h2><a name="Administrating_mail_repositories"></a>Administrating mail repositories</h2> + +<ul> + +<li><a href="#listing-mail-repositories">Listing mail repositories</a></li> + +<li><a href="#getting-additional-information-for-a-mail-repository">Getting additional information for a mail repository</a></li> + +<li><a href="#listing-mails-contained-in-a-mail-repository">Listing mails contained in a mail repository</a></li> + +<li><a href="#reading-a-mail-details">Reading a mail details</a></li> + +<li><a href="#removing-a-mail-from-a-mail-repository">Removing a mail from a mail repository</a></li> + +<li><a href="#removing-all-mails-from-a-mail-repository">Removing all mails from a mail repository</a></li> + +<li><a href="#reprocessing-mails-from-a-mail-repository">Reprocessing mails from a mail repository</a></li> + +<li><a href="#reprocessing-a-specific-mail-from-a-mail-repository">Reprocessing a specific mail from a mail repository</a></li> +</ul> <div class="section"> <h3><a name="Listing_mail_repositories"></a>Listing mail repositories</h3> @@ -1595,6 +2160,21 @@ </pre></div></div></div></div> <div class="section"> <h2><a name="Administrating_mail_queues"></a>Administrating mail queues</h2> + +<ul> + +<li><a href="#listing-mail-queues">Listing mail queues</a></li> + +<li><a href="#getting-a-mail-queue-details">Getting a mail queue details</a></li> + +<li><a href="#listing-the-mails-of-a-mail-queue">Listing the mails of a mail queue</a></li> + +<li><a href="#deleting-mails-from-a-mail-queue">Deleting mails from a mail queue</a></li> + +<li><a href="#clearing-a-mail-queue">Clearing a mail queue</a></li> + +<li><a href="#flushing-mails-from-a-mail-queue">Flushing mails from a mail queue</a></li> +</ul> <div class="section"> <h3><a name="Listing_mail_queues"></a>Listing mail queues</h3> @@ -1689,20 +2269,72 @@ <div class="source"> <pre>curl -XDELETE http://ip:port/mailQueues/mailQueueName/mails?sender=senderMailAddress </pre></div></div> -<p>This request should have exactly one query parameter from the following list: * sender: which is a mail address (i.e. <a class="externalLink" href="mailto:[email protected]";>[email protected]</a>) * name: which is a string * recipient: which is a mail address (i.e. <a class="externalLink" href="mailto:[email protected]";>[email protected]</a>)</p> +<p>This request should have exactly one query parameter from the following list:</p> + +<ul> + +<li>sender: which is a mail address (i.e. <a class="externalLink" href="mailto:[email protected]";>[email protected]</a>)</li> + +<li>name: which is a string</li> + +<li>recipient: which is a mail address (i.e. <a class="externalLink" href="mailto:[email protected]";>[email protected]</a>)</li> +</ul> <p>The mails from the given mail queue matching the query parameter will be deleted.</p> <p>Response codes:</p> <ul> -<li>204: Success (No content)</li> +<li>201: Success. Corresponding task id is returned.</li> <li>400: Invalid request</li> <li>404: The mail queue does not exist</li> <li>500: Internal error</li> -</ul></div> +</ul> +<p>The scheduled task will have the following type <tt>deleteMailsFromMailQueue</tt> and the following <tt>additionalInformation</tt>:</p> + +<div class="source"> +<div class="source"> +<pre>{ + "mailQueueName":"outgoing", + "initialCount":10, + "remainingCount": 5, + "sender": "[email protected]", + "name": "Java Developer", + "recipient: "[email protected]" +} +</pre></div></div></div> +<div class="section"> +<h3><a name="Clearing_a_mail_queue"></a>Clearing a mail queue</h3> + +<div class="source"> +<div class="source"> +<pre>curl -XDELETE http://ip:port/mailQueues/mailQueueName/mails +</pre></div></div> +<p>All mails from the given mail queue will be deleted.</p> +<p>Response codes:</p> + +<ul> + +<li>201: Success. Corresponding task id is returned.</li> + +<li>400: Invalid request</li> + +<li>404: The mail queue does not exist</li> + +<li>500: Internal error</li> +</ul> +<p>The scheduled task will have the following type <tt>clearMailQueue</tt> and the following <tt>additionalInformation</tt>:</p> + +<div class="source"> +<div class="source"> +<pre>{ + "mailQueueName":"outgoing", + "initialCount":10, + "remainingCount": 0 +} +</pre></div></div></div> <div class="section"> <h3><a name="Flushing_mails_from_a_mail_queue"></a>Flushing mails from a mail queue</h3> @@ -1729,6 +2361,17 @@ <h2><a name="Task_management"></a>Task management</h2> <p>Some webadmin features schedules tasks. The task management API allow to monitor and manage the execution of the following tasks.</p> <p>Note that the <tt>taskId</tt> used in the following APIs is returned by other WebAdmin APIs scheduling tasks.</p> + +<ul> + +<li><a href="#getting-a-task-details">Getting a task details</a></li> + +<li><a href="#awaiting-a-task">Awaiting a task</a></li> + +<li><a href="#cancelling-a-task">Cancelling a task</a></li> + +<li><a href="#listing-tasks">Listing tasks</a></li> +</ul> <div class="section"> <h3><a name="Getting_a_task_details"></a>Getting a task details</h3>
http://git-wip-us.apache.org/repos/asf/james-site/blob/446b2187/content/server/manage.html ---------------------------------------------------------------------- diff --git a/content/server/manage.html b/content/server/manage.html index f471988..1295a79 100644 --- a/content/server/manage.html +++ b/content/server/manage.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- Generated by Apache Maven Doxia at 2018-03-22 --> +<!-- Generated by Apache Maven Doxia at 2018-06-07 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -36,7 +36,7 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20180322" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> <!-- Google Analytics --> @@ -74,7 +74,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2018-03-22</span> + <span id="publishDate">Last Published: 2018-06-07</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -105,7 +105,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -114,7 +114,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="collapsed"> @@ -126,7 +126,7 @@ <li class="collapsed"> <a href="../server/install.html" title="3. Install James">3. Install James</a> </li> - <li class="collapsed"> + <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> <li class="expanded"> http://git-wip-us.apache.org/repos/asf/james-site/blob/446b2187/content/server/metrics.html ---------------------------------------------------------------------- diff --git a/content/server/metrics.html b/content/server/metrics.html index 5d9feeb..d79422b 100644 --- a/content/server/metrics.html +++ b/content/server/metrics.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- Generated by Apache Maven Doxia at 2018-03-22 --> +<!-- Generated by Apache Maven Doxia at 2018-06-07 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -36,7 +36,7 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20180322" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> <!-- Google Analytics --> @@ -74,7 +74,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2018-03-22</span> + <span id="publishDate">Last Published: 2018-06-07</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -105,7 +105,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -114,7 +114,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="collapsed"> @@ -126,7 +126,7 @@ <li class="collapsed"> <a href="../server/install.html" title="3. Install James">3. Install James</a> </li> - <li class="collapsed"> + <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> <li class="expanded"> @@ -296,6 +296,10 @@ <li>Diverse Response time percentiles, counts and rates for DNS</li> <li>Cassandra Java driver metrics</li> + +<li>Tika HTTP client statistics</li> + +<li>SpamAssassin TCP client statistics</li> </ul> Retrieve <a class="externalLink" href="https://github.com/apache/james-project/tree/master/grafana-reporting";>available boards</a> for Grafana. http://git-wip-us.apache.org/repos/asf/james-site/blob/446b2187/content/server/monitor-folders.html ---------------------------------------------------------------------- diff --git a/content/server/monitor-folders.html b/content/server/monitor-folders.html index daa580a..ed891db 100644 --- a/content/server/monitor-folders.html +++ b/content/server/monitor-folders.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- Generated by Apache Maven Doxia at 2018-03-22 --> +<!-- Generated by Apache Maven Doxia at 2018-06-07 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -36,7 +36,7 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20180322" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> <!-- Google Analytics --> @@ -74,7 +74,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2018-03-22</span> + <span id="publishDate">Last Published: 2018-06-07</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -105,7 +105,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -114,7 +114,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="collapsed"> @@ -126,7 +126,7 @@ <li class="collapsed"> <a href="../server/install.html" title="3. Install James">3. Install James</a> </li> - <li class="collapsed"> + <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> <li class="collapsed"> http://git-wip-us.apache.org/repos/asf/james-site/blob/446b2187/content/server/monitor-jmx.html ---------------------------------------------------------------------- diff --git a/content/server/monitor-jmx.html b/content/server/monitor-jmx.html index 3b6438a..2ab0fe0 100644 --- a/content/server/monitor-jmx.html +++ b/content/server/monitor-jmx.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- Generated by Apache Maven Doxia at 2018-03-22 --> +<!-- Generated by Apache Maven Doxia at 2018-06-07 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -36,7 +36,7 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20180322" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> <!-- Google Analytics --> @@ -74,7 +74,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2018-03-22</span> + <span id="publishDate">Last Published: 2018-06-07</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -105,7 +105,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -114,7 +114,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="collapsed"> @@ -126,7 +126,7 @@ <li class="collapsed"> <a href="../server/install.html" title="3. Install James">3. Install James</a> </li> - <li class="collapsed"> + <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> <li class="collapsed"> http://git-wip-us.apache.org/repos/asf/james-site/blob/446b2187/content/server/monitor-logging.html ---------------------------------------------------------------------- diff --git a/content/server/monitor-logging.html b/content/server/monitor-logging.html index 82dd0de..3c85a0c 100644 --- a/content/server/monitor-logging.html +++ b/content/server/monitor-logging.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- Generated by Apache Maven Doxia at 2018-03-22 --> +<!-- Generated by Apache Maven Doxia at 2018-06-07 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -36,7 +36,7 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20180322" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> <!-- Google Analytics --> @@ -74,7 +74,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2018-03-22</span> + <span id="publishDate">Last Published: 2018-06-07</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -105,7 +105,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -114,7 +114,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="collapsed"> @@ -126,7 +126,7 @@ <li class="collapsed"> <a href="../server/install.html" title="3. Install James">3. Install James</a> </li> - <li class="collapsed"> + <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> <li class="collapsed"> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
