diff options
| author | Aurélien Bompard <aurelien@bompard.org> | 2012-12-10 12:25:38 +0100 |
|---|---|---|
| committer | Aurélien Bompard <aurelien@bompard.org> | 2012-12-10 12:25:38 +0100 |
| commit | 0a8e5ee78fb231606a0b43f6688aca47e941d91c (patch) | |
| tree | 6ca9f83c9706430d72224c928feeb41d5ef55d23 /hyperkitty/templates/api.html | |
| parent | c29c544ad61059f2360845b48f4f44b76687d153 (diff) | |
| download | hyperkitty-0a8e5ee78fb231606a0b43f6688aca47e941d91c.tar.gz hyperkitty-0a8e5ee78fb231606a0b43f6688aca47e941d91c.tar.xz hyperkitty-0a8e5ee78fb231606a0b43f6688aca47e941d91c.zip | |
Non-code changes (license texts, indentation, etc.)
Diffstat (limited to 'hyperkitty/templates/api.html')
| -rw-r--r-- | hyperkitty/templates/api.html | 124 |
1 files changed, 61 insertions, 63 deletions
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 %} - <h2>REST API</h2> - <p> - HyperKitty comes with a small REST API allowing you to programatically retrieve - emails and information. - </p> - - <div class="odd" style="padding-left: 1em"> - <h3>Formats</h3> - <p> - This REST API can return the information into several formats. - The default format is html to allow human readibility.<br /> - To change the format, just add - <span style="font-style:italic">?format=<FORMAT></span> to the url - </p> - <p>The list of available formats is:</p> - <ul> - <li>json <a>(?format=json)</a></li> - <li>json-p <a>(?format=json-p)</a></li> - <li>txt <a>(?format=txt)</a></li> - <li>xml <a>(?format=xml)</a></li> - <li>html <a>(?format=html)</a></li> - <li>xhtml <a>(?format=xhtml)</a></li> - </ul> - </div> - - <div class="even" style="padding-left: 1em"> - <h3>Emails <a>/api/email/<list name>/<Message-ID></a></h3> - <p> + <h2>REST API</h2> + <p> + HyperKitty comes with a small REST API allowing you to programatically retrieve + emails and information. + </p> + + <div class="odd" style="padding-left: 1em"> + <h3>Formats</h3> + <p> + This REST API can return the information into several formats. + The default format is html to allow human readibility.<br /> + To change the format, just add + <span style="font-style:italic">?format=<FORMAT></span> to the url + </p> + <p>The list of available formats is:</p> + <ul> + <li>json <a>(?format=json)</a></li> + <li>json-p <a>(?format=json-p)</a></li> + <li>txt <a>(?format=txt)</a></li> + <li>xml <a>(?format=xml)</a></li> + <li>html <a>(?format=html)</a></li> + <li>xhtml <a>(?format=xhtml)</a></li> + </ul> + </div> + + <div class="even" style="padding-left: 1em"> + <h3>Emails <a>/api/email/<list name>/<Message-ID></a></h3> + <p> 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. - </p> - <p> For example: <a href="{% url api_email mlist_fqdn='devel@fp.o', hashid='13129854572893334' %}"> - {% url api_email mlist_fqdn='devel@fp.o', hashid='13129854572893334' %} - </a> - </p> - </div> - <div class="odd" style="padding-left: 1em"> - <h3>Threads <a>/api/thread/<list name>/<ThreadID></a></h3> - <p> - </p> - <p> + </p> + <p> For example: <a href="{% url api_email mlist_fqdn='devel@fp.o', hashid='13129854572893334' %}"> + {% url api_email mlist_fqdn='devel@fp.o', hashid='13129854572893334' %} + </a> + </p> + </div> + <div class="odd" style="padding-left: 1em"> + <h3>Threads <a>/api/thread/<list name>/<ThreadID></a></h3> + <p> 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. - </p> - <p> For example: <a href="{% url api_thread mlist_fqdn='devel@fp.o', threadid='13129854572893334' %}"> - {% url api_thread mlist_fqdn='devel@fp.o', threadid='13129854572893334' %} - </a> - </p> - </div> - <div class="even" style="padding-left: 1em"> - <h3>Search <a>/api/search/<list name>/<field>/<keyword></a></h3> - <p> - </p> - <p> + </p> + <p> For example: <a href="{% url api_thread mlist_fqdn='devel@fp.o', threadid='13129854572893334' %}"> + {% url api_thread mlist_fqdn='devel@fp.o', threadid='13129854572893334' %} + </a> + </p> + </div> + <div class="even" style="padding-left: 1em"> + <h3>Search <a>/api/search/<list name>/<field>/<keyword></a></h3> + <p> 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. - </p> - <p>The list of available field is:</p> - <ul> - <li>From</li> - <li>Subject</li> - <li>Content</li> - <li>SubjectContent</li> - </ul> - <p> For example: <a href="{% url api_search mlist_fqdn='devel@fp.o', field='From', keyword='pingoured' %}"> - {% url api_search mlist_fqdn='devel@fp.o', field='From', keyword='pingoured' %} - </a> - </p> - </div> + </p> + <p>The list of available field is:</p> + <ul> + <li>From</li> + <li>Subject</li> + <li>Content</li> + <li>SubjectContent</li> + </ul> + <p> For example: <a href="{% url api_search mlist_fqdn='devel@fp.o', field='From', keyword='pingoured' %}"> + {% url api_search mlist_fqdn='devel@fp.o', field='From', keyword='pingoured' %} + </a> + </p> + </div> {% endblock %} + +{# vim: set noet: #} |