Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JAMES-3663 Accomplish remaining James Webadmin CLI command groups #4415

Open
quantranhong1999 opened this issue Oct 20, 2021 · 0 comments
Open

Comments

@quantranhong1999
Copy link
Member

quantranhong1999 commented Oct 20, 2021

Hello dear Hocktoberfest, and thanks for considering helping us!

The goal of this issue is to contribute to https://github.com/apache/james-project (yes, an Apache project!) but for technical reasons, we could not open tickets on that repository...

You can gather a bit more information on what is James and why it's an awesome project on our website.

Here are the more specific task details:
Link to JIRA: https://issues.apache.org/jira/projects/JAMES/issues/JAMES-3663

We need to convert the important missing Webadmin API into our CLI form. Here is some suggestions: Creating domain mappings, Administrating quotas by users, Administrating quotas by domains...

For new ones to James, my suggestion is that you can start with Creating domain mappings group cause their commands design is already defined at here. Of course you can change it if you see that is reasonable.

Example:
We already have an API to List all domain mappings:

curl -XGET http://ip:port/domainMappings

Which will return all configured domain mappings:

{
  "firstSource.org" : ["firstDestination.com", "secondDestination.net"],
  "secondSource.com" : ["thirdDestination.com", "fourthDestination.net"]
}

and Response codes 200 OK

Please transform it to CLI form like this:

./james-cli --url http://127.0.0.1:9999 domain-mapping list

which may return something like:

 "firstSource.org" : ["firstDestination.com", "secondDestination.net"],
 "secondSource.com" : ["thirdDestination.com", "fourthDestination.net"]

It is up to you how the CLI should return.

Let begin with a command like above in a Pull Request. When you feel more familiar with this topic, let do a group of commands in a Pull Request.

If you do have any questions, just discuss it here or reach us on Gitter: https://gitter.im/apache/james-project

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants