The Maildir e-mail format is a common way of storing e-mail messages, where each message is kept in a separate file with a unique name, and each folder is a directory. The local filesystem handles file locking as messages are added, moved and deleted. A major design goal of Maildir is to eliminate program code having to handle locking, which is often difficult.
A Maildir directory (often named
Maildir) usually has three subdirectories named
The original Maildir specification was written by Daniel J. Bernstein, the author of qmail, djbdns, and other software. Although the original specification was written specifically for Bernstein's qmail, it is general enough to be implemented in many programs.
Sam Varshavchik, the author of the Courier Mail Server and other software, wrote an extension to the Maildir format called Maildir++ to support subfolders and mail quotas. Maildir++ directories contain subdirectories with names that start with a '.' (dot) that are also Maildir++ folders. This extension is not a violation of the Maildir specification, which explicitly provides for the possibility to add more than tmp, new, cur to a maildir.
The program that delivers an email message, a mail delivery agent, writes it to a file in the
tmp directory with a unique filename. Circa 1995, the algorithm recommended for generating unique filenames was to concatenate, separated by the period character, the current Unix time, the current process identifier (PID), and the current hostname; and to delay delivery for two seconds if a file with that name was found to already exist. (This algorithm was criticised in 2006 by Timo Sirainen, the creator of Dovecot.) By 2000, it was recommended to append, to the PID, the value of a per-process counter whose value should be incremented after each delivery; and the rate-limiting suggestion had been dropped. By 2003, the recommendations had been further amended to require that instead of the PID and counter, the middle part of the filename should be created by "concatenating enough of the following strings to guarantee uniqueness" even in the face of multiple simultaneous deliveries to the same maildir from one or more processes:
- #n, where n is (in hexadecimal) the output of the operating system's unix_sequencenumber() system call, which returns a number that increases by 1 every time it is called, starting from 0 after reboot.
- Xn, where n is (in hexadecimal) the output of the operating system's unix_bootnumber() system call, which reports the number of times that the system has been booted. Together with #, this guarantees uniqueness; unfortunately, most operating systems don't support unix_sequencenumber() and unix_bootnumber.
- Rn, where n is (in hexadecimal) the output of the operating system's unix_cryptorandomnumber() system call, or an equivalent source such as /dev/urandom. Unfortunately, some operating systems don't include cryptographic random number generators.
- In, where n is (in hexadecimal) the UNIX inode number of this file. Unfortunately, inode numbers aren't always available through NFS.
- Vn, where n is (in hexadecimal) the UNIX device number of this file. Unfortunately, device numbers aren't always available through NFS. (Device numbers are also not helpful with the standard UNIX filesystem: a maildir has to be within a single UNIX device for link() and rename() to work.)
- Mn, where n is (in decimal) the microsecond counter from the same gettimeofday() used for the left part of the unique name.
- Pn, where n is (in decimal) the process ID.
- Qn, where n is (in decimal) the number of deliveries made by this process.
As of November 2018, Bernstein had made no further changes to these filename generation recommendations.
The delivery process stores the message in the maildir by creating and writing to
tmp/uniquefilename, and then moving this file to
new/uniquefilename. The moving can be done using rename, which is atomic in many systems. Alternatively, it can be done by hard linking the file to
new and then unlinking the file from
tmp. Any leftover file will eventually be deleted. This sequence guarantees that a maildir-reading program will not see a partially written message. There can be multiple programs reading a maildir at the same time. They range from mail user agents (MUAs) which access the server's file system directly, through Internet Message Access Protocol or Post Office Protocol servers acting on behalf of remote MUAs, to utilities such as biff and rsync, which may or may not be aware of the maildir structure. Readers should never look in
When a cognizant maildir reading process (either a POP or IMAP server, or a mail user agent acting locally) finds messages in the
new directory it must move them to
cur. It is just a means to notify the user "you have X new messages". This moving needs to be done using
rename(), as the non-atomic link then unlink technique may result in duplicated messages. An informational suffix is appended to filenames at this stage. It consists of a colon (to separate the unique part of the filename from the actual information), a '2', a comma and various flags. The '2' specifies the version of the information that follows the comma. '2' is the only currently officially specified version, '1' being an experimental version. The specification defines flags which show whether the message has been read, deleted and so on: the initial (capital) letter of Passed, Replied, Seen, Trashed, Draft, and Flagged. Dovecot uses lowercase letters to match 26 IMAP keywords, which may include standardised keywords, such as $MDNSent, and user defined flags.
Although Maildir was intended to allow lockless usage, in practice some software that uses Maildirs also uses locks, such as Dovecot.
Filesystem Compatibility Issues
The Maildir standard can only be implemented on systems that accept colons in filenames.
Systems that don't allow colons in filenames (This includes Microsoft Windows and some configurations of Novell Storage Services.) can use an alternative separator, such as ";", or "-". It is often trivial to patch free and open source software to use a different separator.
As there is currently no agreement on what character this alternative separator should be, there can be interoperability difficulties between different Maildir-supporting programs on these systems. However, not all Maildir-related software needs to know what the separator character is, because not all Maildir-related software needs to be able to read or modify the flags of a message ("read", "replied to" etc.); software that merely delivers to a Maildir, or archives old messages from it based only on date, should work no matter what separator is in use. If only the MUA needs to read or modify message flags, and only one is used, then non-standard alternative separators may be used without interoperability problems.
Software that supports Maildir directly
- Dovecot IMAP server
- Courier Mail Server SMTP and IMAP server, for which the Maildir++ format was invented
- Exim SMTP server
- Postfix SMTP server
- Qmail SMTP server, for which the Maildir format was invented
- MeTA1 SMTP server
- OpenSMTPD SMTP server
- Dovecot delivery agent
- getmail, a Maildir-aware mail-retrieval and delivery agent alternative to Fetchmail
- aerc (efficient and extensible email client)
- Balsa previously the official GNOME mail reader (prior to Evolution)
- Cone a curses-based mail reader
- Evolution, official GNOME mail client
- KMail, KDE mail reader
- Notmuch (fast, global-search and tag-based email system)
- Mozilla Thunderbird
Notes and references
- Bernstein, Daniel J. (1995). "maildir(5)". Archived from the original on 1997-10-12. Retrieved 2018-11-23.
- Bernstein., Daniel J. (c. 2000) [First published 2000 or earlier]. "Using maildir format". Archived from the original on 2000-09-02. Retrieved 2018-11-23.
- Sam Varshavchik (2009). "maildir". Retrieved 24 July 2016.
- Sam Varshavchik (2011). "Maildir++". Retrieved 24 July 2016.
- Dovecot Wiki: maildir format
- Sirainen, Timo (2006-12-05). "Diff for 'MailboxFormat/Maildir'". Retrieved 2018-11-23.
- Bernstein., Daniel J. (2003) [The earliest version of this document was first published in 2000 or earlier]. "Using maildir format". Archived from the original on 2003-04-01. Retrieved 2018-11-23.
- "Wayback Machine snapshots of cr.yp.to/proto/maildir.html". Internet Archive. 2018. Retrieved 2018-11-23.
- "rename". The Open Group. 2013. Retrieved 23 July 2016.
That specification requires that the action of the function be atomic.
- Sam Varshavchik (25 July 2016). "Management of maildir structures". courier-users (Mailing list). Retrieved 26 July 2016.
- Sirainen, Timo (2006-12-05). "Diff for 'MailboxFormat/Maildir'". Retrieved 2018-11-23.
- mutt maildir support: workaround for filesystems that don't accept colons
- "aerc - the world's best email client homepage". aerc-mail.org.
- "Notmuch mail system homepage". notmuchmail.org. Retrieved 2019-06-22.