Repository: james-project
Updated Branches:
  refs/heads/master a5dc56d9d -> 46fd66b6e


JAMES-2234 Document ASCII mail address restriction in WebAdmin


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

Branch: refs/heads/master
Commit: 46fd66b6ea83ca421d20ceeb7d0d311aba7564da
Parents: a5dc56d
Author: benwa <[email protected]>
Authored: Thu Nov 23 16:54:56 2017 +0700
Committer: Antoine Duprat <[email protected]>
Committed: Wed Nov 29 11:50:52 2017 +0100

----------------------------------------------------------------------
 .../org/apache/james/webadmin/routes/GroupsRoutes.java   | 11 +++++++++--
 src/site/markdown/server/manage-webadmin.md              |  2 ++
 2 files changed, 11 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/46fd66b6/server/protocols/webadmin/webadmin-data/src/main/java/org/apache/james/webadmin/routes/GroupsRoutes.java
----------------------------------------------------------------------
diff --git 
a/server/protocols/webadmin/webadmin-data/src/main/java/org/apache/james/webadmin/routes/GroupsRoutes.java
 
b/server/protocols/webadmin/webadmin-data/src/main/java/org/apache/james/webadmin/routes/GroupsRoutes.java
index 25ada76..288a03b 100644
--- 
a/server/protocols/webadmin/webadmin-data/src/main/java/org/apache/james/webadmin/routes/GroupsRoutes.java
+++ 
b/server/protocols/webadmin/webadmin-data/src/main/java/org/apache/james/webadmin/routes/GroupsRoutes.java
@@ -83,6 +83,8 @@ public class GroupsRoutes implements Routes {
     private static final String GROUP_ADDRESS_PATH = ROOT_PATH + SEPARATOR + 
":" + GROUP_ADDRESS;
     private static final String USER_ADDRESS = "userAddress";
     private static final String USER_IN_GROUP_ADDRESS_PATH = 
GROUP_ADDRESS_PATH + SEPARATOR + ":" + USER_ADDRESS;
+    private static final String MAILADDRESS_ASCII_DISCLAIMER = "Note that 
email addresses are restricted to ASCII character set. " +
+        "Mail addresses not matching this criteria will be rejected.";
 
     private final UsersRepository usersRepository;
     private final DomainList domainList;
@@ -130,8 +132,13 @@ public class GroupsRoutes implements Routes {
     @Path(ROOT_PATH + "/{" + GROUP_ADDRESS + "}/{" + USER_ADDRESS + "}")
     @ApiOperation(value = "adding a member into a group")
     @ApiImplicitParams({
-        @ApiImplicitParam(required = true, dataType = "string", name = 
GROUP_ADDRESS, paramType = "path"),
-        @ApiImplicitParam(required = true, dataType = "string", name = 
USER_ADDRESS, paramType = "path")
+        @ApiImplicitParam(required = true, dataType = "string", name = 
GROUP_ADDRESS, paramType = "path",
+            value = "Mail address of the group. Sending a mail to that address 
will send it to all group members.\n" +
+            MAILADDRESS_ASCII_DISCLAIMER),
+        @ApiImplicitParam(required = true, dataType = "string", name = 
USER_ADDRESS, paramType = "path",
+            value = "Mail address of the group. Sending a mail to the group 
mail address will send an email to " +
+                "that email address (as well as other members).\n" +
+                MAILADDRESS_ASCII_DISCLAIMER)
     })
     @ApiResponses(value = {
         @ApiResponse(code = 200, message = "OK", response = List.class),

http://git-wip-us.apache.org/repos/asf/james-project/blob/46fd66b6/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 5fb5d2c..8f3f7e0 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -435,6 +435,8 @@ This feature uses [Recipients rewrite 
table](/server/config-recipientrewritetabl
 the [RecipientRewriteTable 
mailet](https://github.com/apache/james-project/blob/master/server/mailet/mailets/src/main/java/org/apache/james/transport/mailets/RecipientRewriteTable.java)
 to be configured.
 
+Note that email addresses are restricted to ASCII character set. Mail 
addresses not matching this criteria will be rejected.
+
 ### Listing groups
 
 ```


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to