Usage:
GET /api/email.lua?id=$mid[&attachment=true&file=$hash]
Parameters: (cookie may be required) - $mid: The email ID or Message-ID: header - $hash: the file attachment hash
Response example:
{
"references": "",
"from_raw": "lewismc ",
"message-id": "<20150905153416.0CDCFDFE66@git1-us-west.apache.org>",
"@import_timestamp": "2015/10/04 09:52:41",
"body": "Body of email here...",
"request_id": "06b318af97ca96c115e878c14d0814a53407751c31388410421c1751@1441467256@",
"@version": 1,
"attachments": {},
"list": "",
"date": "2015/09/05 17:34:16",
"from": "lewismc ",
"gravatar": "a676c0bf448fcd49f588249ead719b4c",
"in-reply-to": "",
"epoch": 1441467256,
"subject": "[GitHub] any23 pull request: Gsoc 2015 Microformats2",
"mid": "06b318af97ca96c115e878c14d0814a53407751c31388410421c1751@1441467256@",
"private": false,
"tid": "06b318af97ca96c115e878c14d0814a53407751c31388410421c1751@1441467256@",
"list_raw": ""
}
Note: date and epoch are in UTC
Usage:
GET /api/stats.lua?list=$list&domain=$domain[&d=$timespan][&q=$query][&header_from=$from][&header_to=$to][&header_subject=$subject][&header_body=$body][&quick][&emailsOnly][&s=$s&e=$e][&since=$since][&dfrom=$dfrom&dto=$dto]
See below for details of timespan values
Parameters:
- $list: The list prefix (e.g. `dev`). Wildcards may be used
- $domain: The list domain (e.g. `httpd.apache.org`). Wildcards may be used
- $timespan: A [timespan](#Timespans) value
- $s: yyyy-mm start of month (day 1)
- $e: yyyy-mm end of month (last day)
- $query: A search query (may contain wildcards or negations):
- `foo`: Find all documents containing `foo` in headers or body
- `-foo`: Find all documents NOT containing `foo`.
- `foo*`: Find all documents containing `foo`, `fooa`, `foob` etc
- $from: Optional From: address
- $to: Optional To: address
- $subject: Optional Subject: line
- $body: Optional body text
- $dfrom: days ago to start
- $dto: total days to match
Options:
- $since: number of seconds since the epoch, defaults to now.
Returns '{"changed":false}' if no emails are later than epoch, otherwise proceeds with normal search
- quick: send statistics only (exclude participants, threadstruct, word-cloud, emails apart from epoch)
- emailsOnly: return email summaries only (omit thread_struct, top 10 participants and word-cloud)
Response example:
{
"took": 437179,
"firstYear": 2015,
"emails": {
{
"list_raw": "",
"gravatar": "66cf545ca7a1b8f595282bb9d8a59657",
"id": "b1d6446f5cc8f4846454cbabc48ddb08afbb601a77169f8e32e34102@",
"epoch": 1474883100,
"subject": "Re: Missing tag for 0.9 release",
"message-id": "<7f249f5e-e422-68a5-d57f-bfce585e638e@apache.org>",
"private": false,
"irt": "",
"from": "Daniel Gruno ",
"attachments": 0
},...
},
"no_threads": 10,
"domain": "ponymail.info",
"participants": {
{
"count": 3,
"name": "Daniel Gruno",
"gravatar": "66cf545ca7a1b8f595282bb9d8a59657",
"email": "hu...@apache.org"
}, ...
},
"lastYear": 2015,
"name": "dev",
"cloud": {...},
"hits": 25,
thread_struct":
{
"nest": 2,
"children": {
{
"children": {
{
"children": {
{
"children": { },
epoch: ...,
tid: ...,
nest: 1
}
},
epoch: ...,
tid: ...,
nest: 2
}
},
"epoch": 1474883100,
"tid": "b1d6446f5cc8f4846454cbabc48ddb08afbb601a77169f8e32e34102@",
"nest": 2
}
},
epoch: ...,
tid: ...,
body: ...
},
"max": 5000,
"searchlist": "",
"list": "dev@ponymail.info",
"numparts": 0,
"using_wc": false
}
Timespans supported by the &d= parameter.
- d=yyyy-mm => equivalent to &s=yyyy-mm&e=yyyy-mm
- d=lte=n[wMyd] (less than n[wMyd] ago, inclusive)
- d=gte=n[wMyd] (more than n[wMyd] ago, inclusive)
- d=.*dfr=yyyy-mm-dd.* (start date for search, inclusive)
- d=.*dto=yyyy-mm-dd.* (end date for search, inclusive)
- [wMyd] = weeks, Months, years, days
- lte and gte are mutually exclusive
- dfr and dto are normally both present
Usage:
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) - associate=$email - associate the account with the $email address - verify&hash=$hash - verify an association request $hash - removealt=$email - remove an alternate $email address - save - save preferences - addfav=$list - add a favourite $list - remfav=$list - remove a favourite $list
Response example:
{
"lists": {
"ponymail.info": {
"user": 5,
"dev": 36,
"commits": 279
}
},
"descriptions": {
},
"preferences": {
"displayMode": "threaded",
"hideStats": "no",
"theme": "default",
"notifications": "direct",
"sortOrder": "forward",
"compactQuotes": "yes",
"fullname": "Daniel Gruno",
"groupBy": "thread"
},
"took": 38487,
"login": {
"notifications": 0,
"credentials": {
"fullname": "Daniel Gruno",
"email": "foo@bar.tld"
}
}
}
Usage:
GET /api/notifications.lua[?seen=$mid]
Not available in Ponymail Foal
Parameters: (cookie required) - $mid: id of the message to be marked as having been seen
Response example:
{
"notifications": {...}
}
or
{"marked": true}
Usage:
GET /api/mbox.lua?list=issues@ponymail.apache.org&date=2016-06
Optional qualifiers include: - &header_from=$email - &header_subject=$subject_words - &header_body=$body_words
Can also use various timespan values
Response example:
TBA
Usage:
GET /api/atom.lua(?list=$lid|?mid=$mid)
Not available in Ponymail Foal
Parameters: (cookie may be required) - $lid: the list id, e.g. dev@ponymail.apache.org - $mid: The email ID (Permalink)
One of the above is required. In the case of the list id, data is returned for the last month. For email ID, the thread is returned.
Response example:
TBA
Apache Pony Mail (Incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
