This documentation is for Dovecot v1.x, see wiki2 for v2.x documentation.
Differences between revisions 43 and 51 (spanning 8 versions)
Revision 43 as of 2006-09-24 13:10:20
Size: 16409
Editor: TimoSirainen
Revision 51 as of 2007-03-19 20:49:32
Size: 3213
Editor: TimoSirainen
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Line 26: Line 24:
By default UW-IMAP allows access to whole home directory, and many people have chosen to store their mails in the {{{mail/}}} directory. This usually means that IMAP clients have set "IMAP namespace" to {{{"mail/"}}}, which doesn't work well with Dovecot, as Dovecot uses the {{{mail/}}} directory directly by default. So if the IMAP namespace were kept as {{{"mail/"}}}, Dovecot would try to access the {{{~/mail/mail/}}} directory.
 * [:Migration/UW:UW-IMAP / UW-POP3]
 * [:Migration/Linuxconf:Linuxconf / VIMAP]
 * [:Migration/Courier:Courier IMAP and POP3]
 * [:Migration/Cyrus:Cyrus IMAP and POP3]
Line 29: Line 29:
Thus, removing the prefix from IMAP clients would be the first step. Next problem is that subscribed mailboxes are listed as {{{"mail/box"}}} or {{{"~/mail/box" or "~user/mail/box"}}} in subscriptions file. You'd have to remove the {{{mail/}}} directory part from all of these. The subscriptions file name is also different, UW-IMAP uses {{{.mailboxlist}}} while Dovecot uses {{{.subscriptions}}}.

Dovecot uses UW-IMAP compatible UID and message flag headers in mboxes, so that's not a problem.


default_mail_env = mbox:~/mail:INBOX=/var/mail/%u
# make sure mbox_locks are the same with all software that accesses your mboxes
mbox_locks = dotlock fcntl}}}
If you want to make a '''transparent migration''' to Dovecot without having to change the configuration on hundreds of client systems, you will need a slightly different configuration:

 * If your clients have the server prefix set to something like {{{"~/mail"}}}, you may want to enable {{{mail_full_filesystem_access}}} in your Dovecot configuration. Dovecot will otherwise reject mailbox names or prefixes that start with "~". An alternative to this with 1.0-tests is to [:Namespaces:set up multiple hidden namespaces].
 * You can either rename your {{{.mailboxlist}}} file to {{{.subscriptions}}} for all your users using [""], or change the definition of SUBSCRIPTION_FILE_NAME in ''src/lib-storage/subscription-file/subscription-file.c''. In 1.0-test, this value is defined in ''src/lib-storage/subscription-fileindex/maildir/maildir-storage.h'' and ''src/lib-storage/subscription-fileindex/mbox/maildir-storage.h''. .subscriptions is located inside of the mail directory, whereas it is possible .mailboxlist was outside of it (in user's home directory).
 * If an {{{~/mbox}}} file exists, UW-IMAP moves mails from {{{/var/mail/user}}} there. Currently Dovecot doesn't support this feature, so you'll have to either move everyone's mails to {{{~/mbox}}} and reconfigure the MTA, MDA or LDA to store mails there, or alternatively get the {{{~/mbox}}} users to move their mails back to {{{/var/mail/user}}}. The mbox feature may be implemented later, but it's not planned in near future.
 * You should read This document describes the migration process using scripts if you want to migrate from UW_IMAP with mbox to Dovecot using maildir (which will increase performance). Also see the [#convert Converting Mailbox Formats] section below.
Every folder on a system using UW-IMAP has a system message in the top with the subject "DON'T DELETE THIS MESSAGE -- FOLDER INTERNAL DATA". This system message has information about the folder and its state.

Dovecot 1.0 releases use these system messages. Keep them.

Dovecot 0.99.x does not use these system messages to anything so you can delete them without any problems - unless you have users using PINE together with an IMAP or POP3 mail client.

= UW-POP3 (UW-IMAP's POP3 wrapper, ipop3d) =
By default Dovecot generates POP3 UIDs differently than UW-IMAP, which causes POP3 clients to not recognize them and redownload messages they had downloaded previously.

If you want Dovecot to use the same UID format as UW-IMAP/ipop3d so that clients can recognize them, your required action depends on the Dovecot version.

 Dovecot 0.99.X:: With Dovecot 0.99.x you'll have to [ patch Dovecot].
 Dovecot 1.0 (including test and betas):: With Dovecot 1.0 versions you can set this configuration option:
pop3_uidl_format = %08Xv%08Xu}}}
'''Note:''' Confirm that old and new UIDLs match after the patch or reconfiguration. Check with:

telnet localhost 110
user test
pass test
== VIMAP ==
VIMAP or [ Virtual Imap] was a patched version of UW-IMAP that was modified to work with [ Linuxconf's] virtual email configuration. The project doesn't seem to have much life and [ Patrick Hall] who wrote the patch is thrilled that Dovecot can now be configured to be fully compatible. Details of how to do this are described in the [:VirtualUsers:Virtual Users] section.

= Courier, Courier-IMAP =
Courier by default uses "INBOX." as private IMAP namespace, so it has exactly the same problems as described with UW-IMAP above. Again, if you want the migration to be transparent for IMAP clients, see ["Namespaces"] how to set namespaces to be Courier-compatible.

 * Courier's {{{courierimapsubscribed}}} is compatible with Dovecot's {{{subscriptions}}} file, just rename it and remove the "INBOX." prefixes. (NOTE: with 0.99.x it's {{{.subscriptions}}}, with 1.0 it's {{{subscriptions}}} without the dot)
 * Courier's {{{courierimapuiddb}}} is compatible with Dovecot's {{{dovecot-uidlist}}} file, just rename it.
 * Courier's message flags are compatible with Dovecot (as they are specified by the Maildir specification)
 * Courier's message keywords implementation isn't Dovecot compatible and there is currently no easy way to migrate them.
See also the [ courier2dovecot] script by Arto Bendiken.

See also the [] script by Michael Watkins.


# normal home directories
default_mail_env = maildir:~/Maildir
# for virtual users
default_mail_env = maildir:~/}}}
For POP3 UIDL compatibility with Courier, the Dovecot configuration depends on the Courier version used:

 Courier version 0:: {{{
# Courier version 0 (using maildir filenames)
pop3_uidl_format = %f}}}
 Courier version 1:: {{{
# Courier version 1 (UID)
pop3_uidl_format = %u}}}
 Courier version 2 and early Courier version 3:: {{{
# Courier version 2 (UIDVALIDITY and UID - you most likely want this)
pop3_uidl_format = %v-%u}}}
=== Courier version 3 (younger versions) ===
Here everything has changed: Courier's UID data are now stored in{{{courierpop3dsizelist}}}and in a completely new format. But it's still possible to convert it to the format dovecot needs (link to perlscript and further configuration details will follow later).

= Cyrus =
See [ cyrus2courier], it is Dovecot-compatible. Cyrus2courier is also mirrored at [].

For POP3 UIDL compatibility, use one of:

 Cyrus versions up to v2.1.3:: {{{
# Cyrus (old format - up to v2.1.3)
pop3_uidl_format = %u}}}
 Cyrus versions v2.1.4 and newer:: {{{
# Cyrus (new format - v2.1.4 and above)
pop3_uidl_format = %v.%u}}}
See for an alternative migration script (in Python) for Cyrus IMAPd 2.2, which will preserve delivery timestamps and "read" status.

There is also a script called [ IMAPsync] which does a nice job of synching from one IMAP server to another without caring what IMAP server is runing on either end. It has been effective for various migrations for us so far, and worked well for migrating from a Cyrus IMAP server to Dovecot. Here's an example of how you might run the script for a single user:

imapsync --syncinternaldates \
  --host1 --authmech1 LOGIN --user1 --password1 secret \
  --host2 --authmech2 LOGIN --user2 --password2 secret }}}
This is quite easy to script this for a number of users, assuming you have their passwords. Even if you do not, the script also supports logging in as an admin user that has the ability to copy message for sub users, and a variety of other authentication options.

= Other POP3 servers (X-UIDL) =
== Other POP3 servers (X-UIDL) ==
Line 137: Line 41:
 * [ tpop3d] When used with maildir, tpop3d UIDL is a hexadecimal representation of first 16 2-byte words of md5 sum of the message filename. When used with mailbox, tpop3d UIDL is a hexadecimal representation of first 16 2-byte words of md5 sum of first 512 bytes of message (or full messsage if it less then 512 bytes).
Line 138: Line 43:

= Converting Mailbox Formats =
== Converting from MBX to MBOX ==
If you are using UW-IMAP and using the MBX format, you will need to convert it to MBOX format. The conversion process isn't pretty, but here is a script that works. You will need to get and compile the mailutil program from the UW-IMAP web site.

'''WARNING:''' Script versions listed here before 2006-05-18 11:40 UTC converted into mbx rather than mbox format, i. e. older versions did the opposite of what they were supposed to do. Use the version below:

#! /bin/sh
# Written by Marc Perkel - public domain
# overhauled by Matthias Andree, 2006
# Usage: mbx-convert <filename>
# This code assumes there a user named "marc" with the primary group "marc".
# Change to any real user on your system.
# Yes - it look bizzare - but it gets the job done
# abort on error
set -e
if [ $# -ne 1 ] ; then
  echo >&2 "Usage: $0 <filename>"
  exit 1
# set up automatic cleanup
trap 'rm -f "${homedir}"/in.$$ "${homedir}"/out.$$' 0
# First copy to users home dir and make the user the owner
cp "$1" "${homedir}/in.$$"
chown "$user":"$group" "${homedir}/in.$$"
# Run mailutil to convert as the user other than root
# mailutil requires this
su "$user" -c "mailutil copy in.$$ \#driver.unix/out.$$"
# create new file with same permissions/owner as old
cp -p "$1" "${1}.new"
# cat instead of copy leaves the original owner and permissions alone
if cat "${homedir}/out.$$" >"${1}.new" ; then
  # cat succeeded, rename file into place
  mv "${1}.new" "$1"
  # cat failed, remove temp file
  rm -f "${1}.new"
  exit 1
Make a copy of some folders and test it first. Once you are satisfied that it works then:

 * Write a script to convert all your files.
 * Shut down your email system so files can't be modified
 * Copy all your email to a backup location in case you have to revert
 * Run the script
 * Turn on Dovecot and test to verify it is working
 * Important - make sure that you changed your SMTP configuration to write MBOX and not MBX.
 * Turn on SMTP and verify it is all working
'''User comments:'''

 * Is this hassle actually necessary? I have run mailutil as root like this (mailutil as provided by the PINE 4.61 package for SUSE Linux 10.0): {{{mailutil copy /tmp/foo.mbx.orig '#driver.unix//tmp/foo.test'}}} and did not encounter any problems. ''-- MatthiasAndree, 2006-05-18''
== Converting from MBOX to Maildir ==
[ mb2md] is a script which can convert the files for you.

Check also the '''User-Contributed Maildir Support''' section [ on the qmail community site] for more choices.

Example (user's mail in {{{~someuser/mail}}} and inbox in {{{/var/mail/someuser}}}):

cd ~someuser -s mail -R -m -d /var/mail/incoming/someuser
mv mail mail.old}}}
Now the mail will be in {{{~someuser/Maildir}}}.

If you are migrating from UW-IMAP, you also need to do:

cp -p .mailboxlist Maildir/subscriptions}}}
Note that maildir handles subdirectories differently. You need to replace "/" with "." in the subscriptions file:

sed "s/\//\./" subscriptions >
mv subscriptions}}}
Don't forget to update {{{default_mail_env}}} in dovecot.conf (as needed)

== Converting from Maildir to MBOX ==
This is especially helpful if you want to archive your mail to a single file for storage on a CD, a PC, etc. But it can also be helpful if you want to use MBOX with dovecot.

Use the reformail program that comes with [ maildrop]. You can also use the formail program that comes with [ procmail]. Here is a simple script showing how this works.

To use it, adjust the script to invoke the right command according to your system.

Then {{{cd}}} to the user's home directory (one level above {{{Maildir}}}) and run the script with two arguments: the mailbox name (You can use "." for the top-level folder), and the output mbox filename, for example:

cd ~hans
perl . >/tmp/hans-inbox
perl Sent >/tmp/hans-sent}}}
'''WARNING:''' versions of the script provided here before 2006-05-18 11:40 UTC did not save the new/ directory contents, i. e. they missed unread messages!

#!/usr/bin/env perl
# dw = Dovecot Wiki :-)
# NOTE! The output file must not contain single quotes (')!
# figure out which program to run
$cmd="reformail -f1";
system("$cmd </dev/null >/dev/null 2>/dev/null") == 0 or $cmd="formail";
system("$cmd </dev/null >/dev/null 2>/dev/null") == 0
or die "cannot find reformail or formail on your \$PATH!\nAborting";
if (($outputfile eq '') || ($dir eq ''))
{ die "Usage: ./ mailbox outputfile\nAborting"; }
if (!stat("Maildir/$dir/cur") || !stat("Maildir/$dir/new"))
{ die "Maildir/$dir is not a maildir.\nAborting"; }
@files = (<Maildir/$dir/cur/*>,<Maildir/$dir/new/*>);
foreach $file (@files) {
  next unless -f $file; # skip non-regular files
  next unless -s $file; # skip empty files
  next unless -r $file; # skip unreadable files
  $file =~ s/'/'"'"'/; # escape ' (single quote)
  $run = "cat '$file' | $cmd >>'$outputfile'";
  system($run) == 0 or warn "cannot run \"$run\".";

Migration to Dovecot

Dovecot is one of the easiest IMAP servers to migrate to because of its very powerful configuration options. Dovecot can store email in both MBOX and MAILDIR formats, making it compatible with most other mail storage formats. Dovecot is also very flexible as to where it stores the email. It supports many methods for storing user data and password authentication. You can set it up to authenticate against multiple databases.

Migration involves several separate tasks. You either need to convert your data or make Dovecot read your existing data. Dovecot is very good at being compatible and configurable so that it is likely to read your existing mail folders and user and password configurations. Tasks for conversion include:

  • Where and how to store the email
  • User configuration - home directory structure - UID/GID - password storage
  • Authentication of users

When migrating from another IMAP server, you should make sure that these are preserved:

  1. Message flags
    • Lost flags can be really annoying, you most likely want to avoid it.
  2. Message UIDs (and for IMAP, the UIDVALIDITY value)
    • If UIDs are lost, at the minimum clients' message cache gets cleaned and messages are re-downloaded as new.
    • Some IMAP clients store metadata by assigning it to specific UID, if UIDs are changed these will be lost.
  3. Mailbox subscription list
    • Users would be able to manually subscribe them again if you don't want to mess with it.

When migrating from another POP3 server, you should make sure that POP3 UIDLs are preserved, otherwise if client had kept mails in the server all the mails are downloaded again as new mails. pop3_uidl_format and pop3_reuse_xuidl will help you here. If your existing server used IMAP UIDs for the POP3 UIDL, you'll also need to make sure the IMAP UIDs stay the same.

Here are the more server-specific instructions:

  • [:Migration/UW:UW-IMAP / UW-POP3]

  • [:Migration/Linuxconf:Linuxconf / VIMAP]

  • [:Migration/Courier:Courier IMAP and POP3]

  • [:Migration/Cyrus:Cyrus IMAP and POP3]

Other POP3 servers (X-UIDL)

Some POP3 servers generate the X-UIDL header. To use this header when available and ease migration, use:

# Use X-UIDL header if available
pop3_reuse_xuidl = yes

Different POP3 servers generate UIDs differently. If you want to preserve them to avoid users downloading their mails twice, you'll need to figure out how the server generates the UID and patch Dovecot accordingly to do the same.

Here is a list of POP3 servers and how they generate their UIDs. Please update if you know more:

  • [ popa3d] Generates MD5 sum from a couple of headers. Dovecot uses compatible MD5 sums internally but converts them into strings in a bit different way.

  • [ tpop3d] When used with maildir, tpop3d UIDL is a hexadecimal representation of first 16 2-byte words of md5 sum of the message filename. When used with mailbox, tpop3d UIDL is a hexadecimal representation of first 16 2-byte words of md5 sum of first 512 bytes of message (or full messsage if it less then 512 bytes).


None: Migration (last edited 2010-11-02 22:24:58 by TimoSirainen)