Repository: incubator-ponymail Updated Branches: refs/heads/master c3a5b55cf -> 668892d41
More docs Project: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/commit/668892d4 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/tree/668892d4 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/diff/668892d4 Branch: refs/heads/master Commit: 668892d41f848a4804e20e530807ec60b64370a6 Parents: c3a5b55 Author: Sebb <s...@apache.org> Authored: Sat Oct 15 20:58:34 2016 +0100 Committer: Sebb <s...@apache.org> Committed: Sat Oct 15 20:58:34 2016 +0100 ---------------------------------------------------------------------- docs/API.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ponymail/blob/668892d4/docs/API.md ---------------------------------------------------------------------- diff --git a/docs/API.md b/docs/API.md index 46f9cab..4713578 100644 --- a/docs/API.md +++ b/docs/API.md @@ -57,10 +57,30 @@ Response example: { "took": 437179, "firstYear": 2015, - "emails": {...}, + "emails": { + { + "list_raw": "<dev.ponymail.apache.org>", + "gravatar": "66cf545ca7a1b8f595282bb9d8a59657", + "id": "b1d6446f5cc8f4846454cbabc48ddb08afbb601a77169f8e32e34102@<dev.ponymail.apache.org>", + "epoch": 1474883100, + "subject": "Re: Missing tag for 0.9 release", + "message-id": "<7f249f5e-e422-68a5-d57f-bfce585e6...@apache.org>", + "private": false, + "irt": "<CAOGo0VYrCOR=820LSDZA=czc==sowcarkasaevvuxtuexp9...@mail.gmail.com>", + "from": "Daniel Gruno <h...@apache.org>", + "attachments": 0 + },... + }, "no_threads": 10, "domain": "ponymail.info", - "participants": {...}, + "participants": { + { + "count": 3, + "name": "Daniel Gruno", + "gravatar": "66cf545ca7a1b8f595282bb9d8a59657", + "email": "hu...@apache.org" + }, ... + }, "lastYear": 2015, "name": "dev", "cloud": {...}, @@ -77,7 +97,7 @@ Response example: ### Fetching preferences and quick list overview Usage: -`GET /api/preferences.lua[?logout=true]` +`GET /api/preferences.lua[?logout][?associate=$email][?verify&hash=$hash][?removealt=$email][?save][?addfav=$list][?remfav=$list]` Parameters: (cookie required) - logout: Whether to log out of the system (optional)
