Rearrange README's and make the content make sense
[pixelated-user-agent.git] / service / README.md
1 Pixelated User Agent Service
2 ============================
3
4 This is the service for the Pixelated User Agent. The primary purpose of this is to integrate well with the Pixelated Provider and provide all the capabilities necessary for the UI to work well.
5
6 The aim is to support these resources/endpoints:
7
8 ```
9 GET    /mails
10 DELETE /mails
11 POST   /mails
12 PUT    /mails
13 POST   /mails/read
14
15 GET    /mail/:id
16 DELETE /mail/:id
17 POST   /mail/:id/star
18 POST   /mail/:id/unstar
19 POST   /mail/:id/replied
20 POST   /mail/:id/unreplied
21 POST   /mail/:id/read
22 POST   /mail/:id/unread
23 GET    /mail/:id/tags
24 POST   /mail/:id/tags
25
26 GET    /draft_reply_for/:id
27
28 GET    /contacts
29 GET    /contact/:id
30
31 GET    /stats
32
33 GET    /tags
34 POST   /tags
35 ```
36
37 The implementation of the User Agent Service will be in Python, in order to better work together with LEAP. Another goal of the User Agent Service will be to run well on all major client platforms. Finally, there will be a lot of support for search and indexing, and also for encryption and signing. However, we want to push most of these features back to LEAP so that Bitmask can leverage them as well.