[
https://issues.apache.org/jira/browse/JAMES-3400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17209447#comment-17209447
]
ASF GitHub Bot commented on JAMES-3400:
---------------------------------------
chibenwa commented on a change in pull request #251:
URL: https://github.com/apache/james-project/pull/251#discussion_r500899105
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
Review comment:
Can we replace `java -jar james_cli.jar` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
Review comment:
Can we replace `java -jar james_cli.jar` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
Review comment:
Remove this note
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
+```
+Resource name **domainToBeCreated**:
+
+- can not be null or empty
+- can not contain ‘@’
+- can not be more than 255 characters
+- can not contain ‘/’
+
+### Delete a domain
+
+Remove a domain from the domain list.
+```
+{cli} domain delete <domainToBeDeleted>
+```
+Note: Deletion of an auto-detected domain, default domain or of an
auto-detected ip is not supported. We encourage you instead to review your
[domain list
configuration](https://james.apache.org/server/config-domainlist.html).
+
+### Check if a domain exists
+Check whether a domain exists on the domain list or not.
+```
+{cli} domain exist <domainToBeChecked>
Review comment:
Can we replace `{cli}` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
+```
+Resource name **domainToBeCreated**:
+
+- can not be null or empty
+- can not contain ‘@’
+- can not be more than 255 characters
+- can not contain ‘/’
+
+### Delete a domain
+
+Remove a domain from the domain list.
+```
+{cli} domain delete <domainToBeDeleted>
+```
+Note: Deletion of an auto-detected domain, default domain or of an
auto-detected ip is not supported. We encourage you instead to review your
[domain list
configuration](https://james.apache.org/server/config-domainlist.html).
+
+### Check if a domain exists
+Check whether a domain exists on the domain list or not.
+```
+{cli} domain exist <domainToBeChecked>
+```
+
+### Get the list of domains
+Show all domains' name on the list.
+```
+{cli} domain list
+```
+
+
+
+## Manage Users
+
+### Create an user
+
+Add an user to the user list.
+```
+{cli} user create <username> <password>
Review comment:
Can we replace `{cli}` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
+```
+Resource name **domainToBeCreated**:
+
+- can not be null or empty
+- can not contain ‘@’
+- can not be more than 255 characters
+- can not contain ‘/’
+
+### Delete a domain
+
+Remove a domain from the domain list.
+```
+{cli} domain delete <domainToBeDeleted>
+```
+Note: Deletion of an auto-detected domain, default domain or of an
auto-detected ip is not supported. We encourage you instead to review your
[domain list
configuration](https://james.apache.org/server/config-domainlist.html).
+
+### Check if a domain exists
+Check whether a domain exists on the domain list or not.
+```
+{cli} domain exist <domainToBeChecked>
+```
+
+### Get the list of domains
+Show all domains' name on the list.
+```
+{cli} domain list
Review comment:
Can we replace `{cli}` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
Review comment:
Can we replace `{cli}` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
+```
+Resource name **domainToBeCreated**:
+
+- can not be null or empty
+- can not contain ‘@’
+- can not be more than 255 characters
+- can not contain ‘/’
+
+### Delete a domain
+
+Remove a domain from the domain list.
+```
+{cli} domain delete <domainToBeDeleted>
Review comment:
Can we replace `{cli}` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
+```
+Resource name **domainToBeCreated**:
+
+- can not be null or empty
+- can not contain ‘@’
+- can not be more than 255 characters
+- can not contain ‘/’
+
+### Delete a domain
+
+Remove a domain from the domain list.
+```
+{cli} domain delete <domainToBeDeleted>
+```
+Note: Deletion of an auto-detected domain, default domain or of an
auto-detected ip is not supported. We encourage you instead to review your
[domain list
configuration](https://james.apache.org/server/config-domainlist.html).
+
+### Check if a domain exists
+Check whether a domain exists on the domain list or not.
+```
+{cli} domain exist <domainToBeChecked>
+```
+
+### Get the list of domains
+Show all domains' name on the list.
+```
+{cli} domain list
+```
+
+
+
+## Manage Users
+
+### Create an user
+
+Add an user to the user list.
+```
+{cli} user create <username> <password>
+```
+Resource name <username> representing valid users, hence it should match the
criteria at [User Repositories
documentation](https://james.apache.org/server/config-users.html)
+
+Note: if the user exists already, its password will be updated.
+
+### Test an user existence
+
+Check whether an user exists on the user list or not.
+```
+{cli} user exist <username>
+```
+Resource name <username> representing valid users, hence it should match the
criteria at [User Repositories
documentation](https://james.apache.org/server/config-users.html)
+
+### Delete an user
+
+Remove an user from the user list.
+```
+{cli} user delete <username>
Review comment:
Can we replace `{cli}` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
+```
+Resource name **domainToBeCreated**:
+
+- can not be null or empty
+- can not contain ‘@’
+- can not be more than 255 characters
+- can not contain ‘/’
+
+### Delete a domain
+
+Remove a domain from the domain list.
+```
+{cli} domain delete <domainToBeDeleted>
+```
+Note: Deletion of an auto-detected domain, default domain or of an
auto-detected ip is not supported. We encourage you instead to review your
[domain list
configuration](https://james.apache.org/server/config-domainlist.html).
+
+### Check if a domain exists
+Check whether a domain exists on the domain list or not.
+```
+{cli} domain exist <domainToBeChecked>
+```
+
+### Get the list of domains
+Show all domains' name on the list.
+```
+{cli} domain list
+```
+
+
+
+## Manage Users
+
+### Create an user
+
+Add an user to the user list.
+```
+{cli} user create <username> <password>
+```
+Resource name <username> representing valid users, hence it should match the
criteria at [User Repositories
documentation](https://james.apache.org/server/config-users.html)
+
+Note: if the user exists already, its password will be updated.
+
+### Test an user existence
+
+Check whether an user exists on the user list or not.
+```
+{cli} user exist <username>
Review comment:
Can we replace `{cli}` by `james-cli` ?
##########
File path: server/protocols/webadmin-cli/README.md
##########
@@ -0,0 +1,128 @@
+# A WebAdmin based CLI for Apache James
+
+## Development
+
+Webadmin command-line interface is an upcoming replacement for the outdated,
security-vulnerable JMX command-line interface. It also aims at providing a
more modern and intuitive interface.
+
+## Run the command line
+
+## Syntax
+
+General syntax to run the command line
+
+```
+$ java -jar james_cli.jar [OPTION] ENTITY ACTION {ARGUMENT}
+```
+
+where
+
+ OPTION: optional parameter when running the command line,
+
+ ENTITY: represents the entity to perform action on,
+
+ ACTION: name of the action to perform,
+
+ ARGUMENT: arguments needed for the action.
+
+Example:
+```
+$ java -jar james_cli.jar --url http://127.0.0.1 --port 9999 domain list
+```
+
+The above command lists all domain names available on domain route at address
http://127.0.0.1:9999.
+It does not require any argument to execute. Options --url and --port are
optional. Without them, the default value is http://127.0.0.0:8000.
+As for other commands, arguments might be required after the sub-command
(ACTION such as list, add and remove).
+
+Note: the command line ```$ java -jar james_cli.jar``` will be shorten as
{cli} from here.
+
+## Navigation menu
+
+- [Manage Domains](#manage-domains)
+ - [Create a domain](#create-a-domain)
+ - [Delete a domain](#delete-a-domain)
+ - [Check if a domain exists](#check-if-a-domain-exists)
+ - [Get the list of domains](#get-the-list-of-domains)
+- [Manage Users](#manage-users)
+ - [Create an user](#create-a-user)
+ - [Test an user existence](#test-a-user-existence)
+ - [Delete an user](#delete-a-user)
+ - [Get users list](#get-users-list)
+ - [Update an user password](#update-a-user-password)
+
+## Manage Domains
+
+### Create a domain
+Add a domain to the domain list.
+```
+{cli} domain create <domainToBeCreated>
+```
+Resource name **domainToBeCreated**:
+
+- can not be null or empty
+- can not contain ‘@’
+- can not be more than 255 characters
+- can not contain ‘/’
+
+### Delete a domain
+
+Remove a domain from the domain list.
+```
+{cli} domain delete <domainToBeDeleted>
+```
+Note: Deletion of an auto-detected domain, default domain or of an
auto-detected ip is not supported. We encourage you instead to review your
[domain list
configuration](https://james.apache.org/server/config-domainlist.html).
+
+### Check if a domain exists
+Check whether a domain exists on the domain list or not.
+```
+{cli} domain exist <domainToBeChecked>
+```
+
+### Get the list of domains
+Show all domains' name on the list.
+```
+{cli} domain list
+```
+
+
+
+## Manage Users
+
+### Create an user
+
+Add an user to the user list.
+```
+{cli} user create <username> <password>
+```
+Resource name <username> representing valid users, hence it should match the
criteria at [User Repositories
documentation](https://james.apache.org/server/config-users.html)
+
+Note: if the user exists already, its password will be updated.
+
+### Test an user existence
+
+Check whether an user exists on the user list or not.
+```
+{cli} user exist <username>
+```
+Resource name <username> representing valid users, hence it should match the
criteria at [User Repositories
documentation](https://james.apache.org/server/config-users.html)
+
+### Delete an user
+
+Remove an user from the user list.
+```
+{cli} user delete <username>
+```
+
+### Get users list
+
+Show all users' name on the list.
+
+```
+{cli} user list
Review comment:
Can we replace `{cli}` by `james-cli` ?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Develope new James CLI based on WebAdmin API
> --------------------------------------------
>
> Key: JAMES-3400
> URL: https://issues.apache.org/jira/browse/JAMES-3400
> Project: James Server
> Issue Type: Improvement
> Components: CLI
> Reporter: Tran Hong Quan
> Priority: Major
>
> Webadmin command-line interface is an upcoming replacement for the outdated,
> security-vulnerable JMX command-line interface. It also aims at providing a
> more modern and intuitive interface.
> For now, objective for the new CLI is interact with Domains, Users.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
