nodemailer/wildduck
1
1
Fork 0
mirror of https://github.com/nodemailer/wildduck.git synced 2024-09-20 15:26:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Andris Reinman 2017-07-24 22:08:07 +03:00 committed by GitHub
parent 534e917b0f
commit 38b449ecb1
1 changed files with 7 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -68,7 +68,13 @@ Any IMAP or POP3 client will do. Use the credentials from step 4\. to log in.
3. Provide Gmail-like features like pushing sent messages automatically to Sent Mail folder or notifying about messages moved to Junk folder so these could be marked as spam
4. Provide parsed mailbox and message data over HTTP. This should make creating webmail interfaces super easy, no need to parse RFC822 messages to get text content or attachments
## FAQ
# HTTP API
Users, mailboxes and messages can be managed with HTTP requests against Wild Duck API
### [API Reference](https://github.com/nodemailer/wildduck/wiki/API-Docs)
# FAQ
### Does it work?
@ -168,20 +174,6 @@ If a messages is downloaded by a client this message gets marked as _Seen_
If a messages is deleted by a client this message gets marked as Seen and moved to Trash folder
# HTTP API
> **NB!** The HTTP API is being re-designed
Users, mailboxes and messages can be managed with HTTP requests against Wild Duck API
TODO:
1. Expose counters (seen/unseen messages, message count in mailbox etc.)
2. Search/list messages
3. Expose journal updates through WebSocket or similar
[API REFERENCE](https://github.com/nodemailer/wildduck/wiki/API-Docs)
## Message filtering
> The filtering system is subject to change with the API updates. Most probably the filters are going to reside in separate collection and not as part of the user object.