Add inboxapp temporary service
[pixelated-user-agent.git] / inboxapp-service / README.md
1 SMail Back
2 ==========
3
4 This is the backend for SMail. The primary purpose of this is to integrate well with LEAP and provide all the capabilities necessary for the frontend 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 SMail Back will be in Python, in order to better work together with LEAP. Another goal of SMail Back 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.
38
39 We will likely start by implementing a simple SMTP and IMAP implementation in order to make it easier to test - and we will then gradually implement a LEAP backend that provides the production functionality we are aiming for.
40
41 Instructions
42 ===
43
44 To run the app we suggest you using python + virtualenv. If you are developing in with TW Brazil you can fetch a vagrant base box from secret.local:~/smail-back-precise64.box.
45
46 Inboxapp as provider
47 ---
48 You will need to install inboxapp in your machine and sync an account to it. Follow instructions from inboxapp [instalation](https://www.inboxapp.com/docs/gettingstarted#installation) guide. Once you have an account sync you can configure it in config/inboxapp.cfg and you should be good to go.
49  
50