james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From btell...@apache.org
Subject [10/20] james-project git commit: JAMES-2151 Add website documentation for WebAdmin Sieve quotas
Date Tue, 26 Jun 2018 09:13:06 GMT
JAMES-2151 Add website documentation for WebAdmin Sieve quotas


Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/e8d5319d
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/e8d5319d
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/e8d5319d

Branch: refs/heads/master
Commit: e8d5319d2af59af9eef6cf0b636b346a2a3cd92d
Parents: b9ac736
Author: benwa <btellier@linagora.com>
Authored: Wed Jun 20 16:15:28 2018 +0700
Committer: benwa <btellier@linagora.com>
Committed: Tue Jun 26 16:06:31 2018 +0700

----------------------------------------------------------------------
 src/site/markdown/server/manage-webadmin.md | 105 +++++++++++++++++++++++
 1 file changed, 105 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/e8d5319d/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 f516efd..71e6cf0 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -34,6 +34,7 @@ In case of any error, the system will return an error message which is json
form
  - [Administrating mail repositories](#Administrating_mail_repositories)
  - [Administrating mail queues](#Administrating_mail_queues)
  - [Administrating DLP Configuration](#Administrating_dlp_configuration)
+ - [Administrating Sieve quotas](#Administrating_Sieve_quotas)
  - [Task management](#Task_management)
 
 ## Administrating domains
@@ -1926,6 +1927,110 @@ Response codes:
  - 404: The domain does not exist.
  - 500: Internal error
 
+## Administrating Sieve quotas
+
+Some limitations on space Users Sieve script can occupy can be configured by default, and
overridden by user.
+
+ - [Retrieving global sieve quota](#Retieving_global_sieve_quota)
+ - [Updating global sieve quota](#Updating_global_sieve_quota)
+ - [Removing global sieve quota](#Removing_global_sieve_quota)
+ - [Retieving user sieve quota](#Retieving_user_sieve_quota)
+ - [Updating user sieve quota](#Updating_user_sieve_quota)
+ - [Removing user sieve quota](#Removing_user_sieve_quota)
+
+### Retrieving global sieve quota
+
+This endpoints allows to retrieve the global Sieve quota, which will be users default:
+
+```
+curl -XGET http://ip:port/sieve/quota/default
+```
+
+Will return the bytes count allowed by user per default on this server.
+
+```
+102400
+```
+
+Response codes:
+ - 200: Request is a success and the value is returned
+ - 404: No quota is being configured
+
+### Updating global sieve quota
+
+This endpoints allows to update the global Sieve quota, which will be users default:
+
+```
+curl -XPUT http://ip:port/sieve/quota/default
+```
+
+With the body being the bytes count allowed by user per default on this server.
+
+```
+102400
+```
+
+Response codes:
+ - 204: Operation succeeded
+ - 400: Invalid payload
+
+### Removing global sieve quota
+
+This endpoints allows to remove the global Sieve quota. There will no more be users default:
+
+```
+curl -XDELETE http://ip:port/sieve/quota/default
+```
+
+Response codes:
+ - 204: Operation succeeded
+
+### Retrieving user sieve quota
+
+This endpoints allows to retrieve the Sieve quota of a user, which will be this users quota:
+
+```
+curl -XGET http://ip:port/sieve/quota/users/user@domain.com
+```
+
+Will return the bytes count allowed for this user.
+
+```
+102400
+```
+
+Response codes:
+ - 200: Request is a success and the value is returned
+ - 404: No quota is being configured for this user
+
+### Updating user sieve quota
+
+This endpoints allows to update the Sieve quota of a user, which will be users default:
+
+```
+curl -XPUT http://ip:port/sieve/quota/users/user@domain.com
+```
+
+With the body being the bytes count allowed for this user on this server.
+
+```
+102400
+```
+
+Response codes:
+ - 204: Operation succeeded
+ - 400: Invalid payload
+
+### Removing user sieve quota
+
+This endpoints allows to remove the Sieve quota of a user. There will no more quota for this
userrrrrrr:
+
+```
+curl -XDELETE http://ip:port/sieve/quota/users/user@domain.com
+```
+
+Response codes:
+ - 204: Operation succeeded
 
 ## Task management
 


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Mime
View raw message