summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRuben Pollan <meskio@sindominio.net>2017-03-30 13:56:59 +0200
committerKali Kaneko (leap communications) <kali@leap.se>2017-04-03 15:43:47 +0200
commitfd33671d4455c164f4a99b3f727494bdc8263fae (patch)
tree25f98fa1dfb3e13638942e13cbf3242bb45f899e /docs
parent30d5903c7ed45f54146e4fb83d1ebb997e725a9a (diff)
[docs] document mail status API
- Resolves: #8775
Diffstat (limited to 'docs')
-rw-r--r--docs/core/index.rst67
1 files changed, 67 insertions, 0 deletions
diff --git a/docs/core/index.rst b/docs/core/index.rst
index c7fb1780..5b74f122 100644
--- a/docs/core/index.rst
+++ b/docs/core/index.rst
@@ -363,6 +363,73 @@ JSON-encoded data to the POST.
.. _cmd_keys_list:
+/mail/status
+-----------------------
+**POST /mail/status
+
+ Get the status of the mail service
+
+ **Example request**::
+
+
+ curl -X POST localhost:7070/API/mail/status -d '["foobar@mail.bitmask.net"]'
+
+
+ **Example response**::
+
+
+ {
+ "result": {
+ "status": "on",
+ "keys": "found",
+ "unread": 5,
+ "childrenStatus": {
+ "keymanager": {
+ "status": "on",
+ "keys": "found",
+ "error": null
+ },
+ "smtp": {
+ "status": "on",
+ "error": null
+ },
+ "incoming": {
+ "status": "on",
+ "unread": 5,
+ "error": null
+ },
+ "imap": {
+ "status": "on",
+ "error": null
+ }
+ },
+ "error": null
+ },
+ "error": null
+ }
+
+
+ **Form parameters**:
+ * ``address`` *(required)* - the email address of the account.
+
+ **Values**:
+
+ The possible values for ``status`` are:
+ * ``on``
+ * ``off``
+ * ``starting``
+ * ``stopping``
+ * ``failure``
+
+ The possible values for the ``keys`` field are:
+ * ``null`` - nothing is known about the private key status.
+ * ``sync`` - syncing soledad to see if there is a private key.
+ * ``generating`` - creating a new private key as none was found.
+ * ``found`` - there is a valid private key in KeyManager.
+
+
+.. _cmd_prov_del:
+
/keys/list
-------------------
**POST /keys/list**