search

jrsupplee / mailinabox

Experimental quotas for Mail-in-a-Box
https://mailinabox.email/
Creative Commons Zero v1.0 Universal
10 stars 7 forks source link

API support #6

Closed na2axl closed 5 years ago

na2axl commented 5 years ago

Thanks @jrsupplee for this helpful patch on MiaB. I've seen that the only way to manage quota is through command line, there is any way to do the same job through APIs ? Or do you plan a feature like that ?

na2axl commented 5 years ago

Hi @jrsupplee, I've just started to use your patch and I've browsed the sources, I've found the way to use APIs :grin:, but I think you can add it on the README...

Thanks and feel free to close this issue.

jrsupplee commented 5 years ago

I am not sure where the API documentation is located for mail-in-a-box. It is not in the README. Have you found documentation for the rest of the API?

ctrl-i commented 5 years ago

Perhaps @na2axl means something like this?

na2axl commented 5 years ago

Yes @ctrl-i is totally what I want. Since this patch comes with a totally new feature, It will be nice if it have an API documentation in the Users page like any other MiaB functionnalities (I principally use the API to automate tasks without accessing the MiaB CP).

jrsupplee commented 5 years ago

@ctrl-i this is the API documentation for DNS. As far as I know there is no documentation for the General API. If there is, please give me a link.

ctrl-i commented 5 years ago

@ctrl-i this is the API documentation for DNS. As far as I know there is no documentation for the General API. If there is, please give me a link.

I think that is just the general thing that was wanted not the actual documentation. There are similar things for a lot of the API in the MIAB HTML pages and I think @na2axl was wanting something similar for the quotas.

jrsupplee commented 5 years ago

@ctrl-i: There are similar things for a lot of the API in the MIAB HTML pages

Link please

ctrl-i commented 5 years ago

@ctrl-i: There are similar things for a lot of the API in the MIAB HTML pages

Link please

I give up, I was only trying to help.

jrsupplee commented 5 years ago

@ctrl-i: I give up, I was only trying to help.

My point is, with the exception of the DNS API, that there is no API documentation that I have seen. @na2axl went to the source code to understand the API which is how everyone must do it. I do not think having documentation for just the quota functions that were added will be very useful.

However, if someone is willing to write up some documentation I will put in the README

jrsupplee commented 5 years ago

So I found that there is documentation for the mail users API on the mail users' page. I updated the documentation for the quota extensions and released a new version.