From 0a8e5ee78fb231606a0b43f6688aca47e941d91c Mon Sep 17 00:00:00 2001 From: Aurélien Bompard Date: Mon, 10 Dec 2012 12:25:38 +0100 Subject: Non-code changes (license texts, indentation, etc.) --- hyperkitty/templates/api.html | 124 +++++++++++++++++++++--------------------- 1 file changed, 61 insertions(+), 63 deletions(-) (limited to 'hyperkitty/templates/api.html') diff --git a/hyperkitty/templates/api.html b/hyperkitty/templates/api.html index c6e2b85..763574b 100644 --- a/hyperkitty/templates/api.html +++ b/hyperkitty/templates/api.html @@ -1,73 +1,71 @@ {% extends "base.html" %} {% block content %} -

REST API

-

- HyperKitty comes with a small REST API allowing you to programatically retrieve - emails and information. -

- -
-

Formats

-

- This REST API can return the information into several formats. - The default format is html to allow human readibility.
- To change the format, just add - ?format=<FORMAT> to the url -

-

The list of available formats is:

- -
- -
-

Emails /api/email/<list name>/<Message-ID>

-

+

REST API

+

+ HyperKitty comes with a small REST API allowing you to programatically retrieve + emails and information. +

+ +
+

Formats

+

+ This REST API can return the information into several formats. + The default format is html to allow human readibility.
+ To change the format, just add + ?format=<FORMAT> to the url +

+

The list of available formats is:

+ +
+ +
+

Emails /api/email/<list name>/<Message-ID>

+

Using the address /api/email/<list name>/<Message-ID> you will be able to retrieve the information known about a specific email on the specified mailing-list. -

-

For example: - {% url api_email mlist_fqdn='devel@fp.o', hashid='13129854572893334' %} - -

-
-
-

Threads /api/thread/<list name>/<ThreadID>

-

-

-

+

+

For example: + {% url api_email mlist_fqdn='devel@fp.o', hashid='13129854572893334' %} + +

+
+
+

Threads /api/thread/<list name>/<ThreadID>

+

Using the address /api/thread/<list name>/<Message-ID> you will be able to retrieve the all the email for a specific thread on the specified mailing-list. -

-

For example: - {% url api_thread mlist_fqdn='devel@fp.o', threadid='13129854572893334' %} - -

-
-
-

Search /api/search/<list name>/<field>/<keyword>

-

-

-

+

+

For example: + {% url api_thread mlist_fqdn='devel@fp.o', threadid='13129854572893334' %} + +

+
+
+

Search /api/search/<list name>/<field>/<keyword>

+

Using the address /api/search/<list name>/<field>/<keyword> you will be able to search for all emails of the specified mailing-list containing the provided keyword in the given field. -

-

The list of available field is:

-
    -
  • From
    • -
  • Subject
    • -
  • Content
    • -
  • SubjectContent
    • -
-

For example: - {% url api_search mlist_fqdn='devel@fp.o', field='From', keyword='pingoured' %} - -

-
+

+

The list of available field is:

+ +

For example: + {% url api_search mlist_fqdn='devel@fp.o', field='From', keyword='pingoured' %} + +

+
{% endblock %} + +{# vim: set noet: #} -- cgit