This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.

Listescape plugin

The Listescape plugin allows users to use characters in mailboxes names that would otherwise be illegal (due to the underlying mailbox storage), for example:

The Listescape plugin allows you to use all of these characters, as long as the virtual separator (i.e. what is set by the separator= setting and used as such by the IMAP protocol) is changed to something else, which means that the plugin does not make it possible to use the virtual separator in folder names.

The characters are escaped to the mailbox name as \NN hex codes.

So what would be a good hierarchy separator to use?

Examples

Allow '.' characters with Maildir++ layout when virtual hierarchy separator is changed to '/' (it could be anything else except '.' itself):

mail_plugins = $mail_plugins listescape

namespace private {
  separator = /
  inbox = yes
}

plugin {
  # The default escape character is '\', but you can change it.
  # Note that even here the expansion of % takes place, thus you need to
  # use "%%" if you want to have the % sign as the escape character.
  #listescape_char = "\\"
}

Allow both '.' and '/' characters when virtual hierarchy separator is changed to '$':

mail_plugins = $mail_plugins listescape

namespace private {
  separator = $
  inbox = yes
}

Plugins/Listescape (last edited 2013-05-25 10:34:16 by TimoSirainen)