This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 65 and 67 (spanning 2 versions)
Revision 65 as of 2015-04-30 13:40:18
Size: 9515
Editor: broadband-188-255-26-201
Comment:
Revision 67 as of 2017-05-10 11:31:02
Size: 9738
Editor: TimoSirainen
Comment:
Deletions are marked like this. Additions are marked like this.
Line 28: Line 28:
  * {{{LAYOUT}}} : specifies the directory layout under the [[MailLocation/mbox#Directory_layout|mbox]] or [[MailLocation/Maildir#Directory_layout|Maildir]] formats.   * {{{LAYOUT}}} : specifies the directory layout to use:
   * Maildir++: The default used by Maildir format
   * fs: The default used by mbox and dbox formats
   * index: Uses mailbox GUIDs as the directory names. The mapping between mailbox names and GUIDs exists in dovecot.list.index* files.
  * {{{UTF-8}}} : Store mailbox names on disk using UTF-8 instead of modified UTF-7.
Line 176: Line 180:
If you need to override namespace's location, first give it a name ("user" below): If you need to override namespace's location, first give it a name ("inbox" below):
Line 179: Line 183:
namespace user { namespace inbox {
Line 192: Line 196:
export USERDB_KEYS="$USERDB_KEYS namespace/user/location"
exec env "NAMESPACE/USER/LOCATION=$location" "$@"
export USERDB_KEYS="$USERDB_KEYS namespace/inbox/location"
exec env "NAMESPACE/INBOX/LOCATION=$location" "$@"

Mail location

There are three different places where the mail location is looked up from:

  1. mail_location setting in dovecot.conf is used if nothing else overrides it.

  2. mail userdb field overrides mail_location setting.

  3. location setting inside namespaces overrides everything. Usually this should be used only for public and shared namespaces.

By default the mail_location setting is empty, which means that Dovecot attempts to locate automatically where your mails are. This is done by looking at ~/Maildir, /var/mail/username, ~/mail and ~/Mail in that order. It's usually a good idea to explicitly specify where the mails are, even if the autodetection happens to work. Autodetection commonly fails for new users who don't have the mail directory created yet.

Format

The format of the mailbox location specification is as follows:

where:

  • mailbox-format is a tag identifying one of the formats described at Mailbox Formats.

  • path is the path to a directory where the mail is stored. This must be an absolute path, not a relative path. Even if relative paths appear to work, this usage is deprecated and will likely stop working at some point. Do not use the home directory, for reasons see Home vs. mail directory

  • key = value can appear zero or more times to set various optional parameters. Possible values for key are:

    • INDEX : specifies the location of index files.

    • INBOX : specifies the location of the INBOX.

    • LAYOUT : specifies the directory layout to use:

      • Maildir++: The default used by Maildir format
      • fs: The default used by mbox and dbox formats
      • index: Uses mailbox GUIDs as the directory names. The mapping between mailbox names and GUIDs exists in dovecot.list.index* files.
    • UTF-8 : Store mailbox names on disk using UTF-8 instead of modified UTF-7.

    • CONTROL : specifies the location of control files under the mbox or Maildir formats.

    • SUBSCRIPTIONS : specifies the file used for storing subscriptions. The default is "subscriptions". If you're trying to avoid name collisions with a mailbox named "subscriptions", then also consider setting MAILBOXDIR.

    • MAILBOXDIR : specifies directory name under which all mailbox directories are stored. With dbox formats the default is "mailboxes/" while with other mailbox formats the default is empty. Typically this should be changed only for lazy_expunge namespace with mdbox.

    • DIRNAME : specifies the directory name used for mailbox directories, or in the case of mbox specifies the mailbox message file name. With dbox formats the default is "dbox-Mails/" while with other mailbox formats the default is empty. Can be used under either mbox, Maildir or dbox formats. Note that this directory is used only for the mail directory and the alt directory, not for index/control directories (but see below).

    • FULLDIRNAME : Same as DIRNAME, but use the directory name also for index and control directory paths. This should be used instead of DIRNAME for new installations. (v2.2.8+)

    • ALT : specifies the Alternate storage path for dbox formats.

  • The colons and equals signs are literal and there are no spaces in an actual mailbox location specification.

Variables

You can use several variables in the mail_location setting. See Variables for a full list, but the most commonly used ones are:

  • %u: Full username.

  • %n: User part in user@domain, same as %u if there's no domain.

  • %d: Domain part in user@domain, empty if there's no domain.

Typical settings

Typically with Maildir it would be set to:

mail_location = maildir:~/Maildir

with mbox:

mail_location = mbox:~/mail:INBOX=/var/mail/%u

or if you'd like to use the dbox format:

# single-dbox
mail_location = sdbox:~/dbox

or:

# multi-dbox
mail_location = mdbox:~/mdbox

Use only absolute paths. Even if relative paths would appear to work, they might just as well break some day.

Directory hashing

You can use two different kinds of hashes in variables:

  • %H modifiers returns a 32bit hash of the given string as hex. For example %2.256H would return max. 256 different hashes in range 00 .. ff.

  • %M returns a MD5 hash of the string as hex. This can be used for two level hashing by getting substrings of the MD5 hash. For example %1Mu/%2.1Mu/%u returns directories from 0/0/user to f/f/user.

Index files

Index files are by default stored under the same directory as mails. With maildir they are stored in the actual maildirs, with mbox they are stored under .imap/ directory. You may want to change the index file location if you're using NFS or if you're setting up shared mailboxes.

You can change the index file location by adding :INDEX=<path> to mail_location. For example:

mail_location = maildir:~/Maildir:INDEX=/var/indexes/%u

The index directories are created automatically, but note that it requires that Dovecot has actually access to create the directories. Either make sure that the index root directory (/var/indexes in the above example) is writable to the logged in user, or create the user's directory with proper permissions before the user logs in.

If you really want to, you can also disable the index files completely by appending :INDEX=MEMORY.

Private index files (v2.2+)

Since v2.2 the recommended way to enable private flags for shared mailboxes is to create private indexes with :INDEXPVT=<path>. See SharedMailboxes/Public for more information.

INBOX path

INBOX path can be specified to exist elsewhere than the rest of the mailboxes, for example:

mail_location = mbox:~/mail:INBOX=/var/mail/%u
mail_location = maildir:~/Maildir:INBOX=~/Maildir/.INBOX

Note that it's still not possible to mix maildir and mbox formats this way. You need to use namespaces for that.

Homeless users

Having a home directory for users is highly recommended. The Pigeonhole Sieve plugin already requires a home directory to work, and it probably won't be the last feature to require a home. See VirtualUsers#homedirs for more reasons why it's a good idea, and how to give Dovecot a home directory even if you don't have a "real home directory".

If you really don't want to set any home directory, you can use something like:

mail_location = maildir:/home/%u/Maildir 

Per-user mail locations

It's possible to override the default mail_location for specific users by making the user database return mail extra field. See the user database page for the specific userdb you're using for more information how to do this. Below are however a couple of examples.

Note that %h doesn't work in the userdb queries or templates. ~/ gets expanded later, so use it instead.

Note also that since location specified within a namespace overrides mail_location setting, in case you specified that parameter, you'll have to override in in the user database, specifying namespace/inbox/location extra field instead of mail.

SQL

user_query = SELECT home, uid, gid, mail FROM users WHERE user = '%u' 

LDAP

user_attrs = homeDirectory=home, uidNumber=uid, gidNumber=gid, mailLocation=mail

Passwd-file

user:{PLAIN}password:1000:1000::/home/user::userdb_mail=mbox:~/mail:INBOX=/var/mail/%u 

Mixing mbox and maildir

It's possible to use both mboxes and maildirs for the same user by configuring multiple namespaces. See Namespaces.

Having both mboxes and maildirs mixed within the same namespace isn't currently supported.

Custom mailbox location detection

Dovecot by default detects the mailboxes in this order:

  1. maildir: ~/Maildir
  2. mbox: ~/mail, and /var/mail/%u if it exists
  3. mbox: ~/Mail, and /var/mail/%u if it exists

If you need something else, you can override the mail_executable setting to run a script, which sets the MAIL environment properly. For example:

#!/bin/sh

if [ -d $HOME/.maildir ]; then
  export MAIL=maildir:$HOME/.maildir
else
  export MAIL=mbox:$HOME/mail:INBOX=/var/mail/$USER
fi
export USERDB_KEYS="$USERDB_KEYS mail"

exec "$@"

Custom namespace location

If you need to override namespace's location, first give it a name ("inbox" below):

namespace inbox {
  ..
}

Then in the script use:

#!/bin/sh

# do the lookup here
location=mbox:$HOME/mail

export USERDB_KEYS="$USERDB_KEYS namespace/inbox/location"
exec env "NAMESPACE/INBOX/LOCATION=$location" "$@"

None: MailLocation (last edited 2019-09-11 14:05:46 by MichaelSlusarz)