repository·master·Indexed 24 days ago
https://github.com/zone-eu/wildduckA scalable, no-SPOF IMAP/POP3 mail server built with Node.js and a distributed, sharded, and replicated MongoDB backend. It includes tools for IMAP command parsing and compilation via imapHandler, MD5-based password hashing compatible with PHP, and a comprehensive installer for a full mail stack including Haraka, ZoneMTA, and Rspamd.
WildDuck is a scalable, no-SPOF (Single Point of Failure) IMAP/POP3 mail server. It is designed with a product philosophy similar to Gmail.
Key architectural feature: WildDuck uses a distributed database (sharded and replicated MongoDB) as its backend for storing all data, including emails.
The WildDuck graphics repository contains several versions of the logo for different use cases:
wildduck.svg).wildduck-type.svg).wildduck-mono.svg).WildDuck IMAP server implements the IMAP4rev1 suite with several key extensions. Notable supported features include:
Performance Note: WildDuck may be slower than Dovecot when fetching single users because it recomposes messages from different parts rather than reading directly from a filesystem. However, it offers better parallelization via MongoDB sharding and faster synchronization speeds due to its write-ahead log.
WildDuck is a mail server built on Node.js, MongoDB, and Redis. It provides several decoupled services that can be enabled or disabled individually, allowing you to distribute specific roles across different hosts (e.g., running IMAP on one host and LMTP on another).
Core services include:
Wild Duck can automatically encrypt all added messages using a user's public PGP key. This encryption applies to:
zonemta-wildduck).WildDuck supports several automated email addressing behaviors:
username+label@example.com, which is automatically delivered to username@example.com.username@example.com is treated identically to user.name@example.com.WildDuck provides two primary ways to interact with and access email messages:
For detailed API specifications, refer to the HTTP API documentation.
WildDuck is designed to be distributed by keeping minimal session state (primarily a list of known UIDs and the latest MODSEQ value).
Mailbox Loading and Updates:
NOOP call), it loads the journaled log from the database and applies updates to the UID array one by one until the state matches the latest database state. If a change cannot be notified (e.g., during a FETCH call), the user continues to see the previous state until the next opportunity for synchronization.modseq). This is useful for synchronizing mailbox states efficiently by only acting on messages that have changed since a specific sequence number.WildDuck provides built-in auditing capabilities that allow administrators to enable message auditing for specific email accounts.
Key characteristics of the auditing process:
The hashes generated by this library are compatible with PHP's crypt() function.
Hash Structure:
$1$X9U0NCH4$1.cDTvOaCzP41UQ699rOU0
$1$: Identifies the hash as being based on MD5.X9U0NCH4: The Salt.1.cDTvOaCzP41UQ699rOU0: The Hashed string.Comparison Example:
Both the JavaScript implementation and PHP's crypt() will produce the same output for the same input:
JavaScript:
var CryptMD5 = require('./cryptmd5.js');
console.log(CryptMD5.cryptMD5('focus123', 'erXgIjX7'));
// Returns: $1$erXgIjX7$fi/gmab/rku/qc6.ivndo0PHP:
echo crypt('focus123', '$1$erXgIjX7');
// Returns: $1$erXgIjX7$fi/gmab/rku/qc6.ivndo0The IMAP handler follows a two-step lifecycle for processing commands:
Parsing: A raw IMAP string (received from a client) is passed to imapHandler.parser(). This decomposes the string into a structured commandObject that identifies tags, commands, and attributes (like SEQUENCE, ATOM, or LITERAL).
Compilation: To respond to a client, you construct a commandObject (either by modifying a parsed one or creating a new one) and pass it to imapHandler.compileStream(). This returns a Stream rather than a string. This design allows the server to pipe large data (like email attachments or bodies) directly to the network socket, minimizing memory footprint.
Note for Server Developers: Because the compilation returns a stream, it is currently not possible to pause the output stream to wait for a '+' tagged server response for literal values. This makes the handler optimized for server-to-client communication rather than client-to-server.