nodemailer/wildduck
1
1
Fork 0
mirror of https://github.com/nodemailer/wildduck.git synced 2024-12-27 02:10:52 +08:00
Code Issues Projects Releases Packages Wiki Activity
wildduck/docs
History
Hakan FIRAT 5019cf13b2
fix(git): Changed git: url in install script to https: (#610) 
git clone git://github.com/nodemailer/wildduck.git  =>
git clone https://github.com/nodemailer/wildduck.git
2024-02-22 13:39:06 +02:00
..
additional-software added screenshot and link to WildDuck UI third party project 2021-04-01 13:44:55 +05:30
api feat(api-search): Allow searching for messages by uid (#587) 2024-01-02 13:23:43 +02:00
general fix(git): Changed git: url in install script to https: (#610) 2024-02-22 13:39:06 +02:00
in-depth typo 2021-09-05 15:43:06 +03:00
.nojekyll Combine readme and wiki onto centralized docs 2020-05-02 17:38:12 +02:00
_sidebar.md updated docs for default values 2021-09-05 15:38:48 +03:00
api-error-codes.md Set a maximum limit for application passwords (50) 2022-07-04 16:52:08 +03:00
CNAME Combine readme and wiki onto centralized docs 2020-05-02 17:38:12 +02:00
index.html feat: add graphics 2021-02-02 22:31:48 +03:30
README.md fix: license 2021-02-02 22:49:38 +03:30

README.md

WildDuck Mail Server

WildDuck is a scalable no-SPOF IMAP/POP3 mail server. WildDuck uses a distributed database (sharded + replicated MongoDB) as a backend for storing all data, including emails.

WildDuck tries to follow Gmail in product design. If there's a decision to be made then usually the answer is to do whatever Gmail has done.

Contact

Gitter chat

Requirements

  • MongoDB to store all data
  • Redis for pubsub and counters
  • Node.js at least version 10.0.0

Optional requirements

  • Redis Sentinel for automatic Redis failover
  • Build tools to install optional dependencies that need compiling

WildDuck can be installed on any Node.js compatible platform.

No-SPOF architecture

Every component of the WildDuck mail server can be replicated which eliminates potential single point of failures.

Storage

Attachment de-duplication and compression gives up to 56% of storage size reduction.

Goals of the Project

  1. Build a scalable and distributed IMAP/POP3 server that uses clustered database instead of single machine file system as mail store
  2. Allow using internationalized email addresses
  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

Future considerations

  • Optimize FETCH queries to load only partial data for BODY subparts

  • Parse incoming message into the mime tree as a stream. Currently the entire message is buffered in memory before being parsed.

  • Maybe allow some kind of message manipulation through plugins

  • WildDuck does not plan to be the most feature-rich IMAP client in the world. Most IMAP extensions are useless because there aren't too many clients that are able to benefit from these extensions. There are a few extensions though that would make sense to be added to WildDuck:

    • IMAP4 non-synchronizing literals, LITERAL- (RFC7888). Synchronized literals are needed for APPEND to check mailbox quota, small values could go with the non-synchronizing version.
    • LIST-STATUS (RFC5819)
    • What else? (definitely not NOTIFY nor QRESYNC)

License

WildDuck Mail Agent is licensed under the European Union Public License 1.2 or later.