~ubuntu-branches/ubuntu/utopic/dovecot/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/wiki/Plugins.Listescape.txt

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2014-01-08 09:35:49 UTC
  • mfrom: (4.1.35 sid)
  • Revision ID: package-import@ubuntu.com-20140108093549-i72o93pux8p0dlaf
Tags: 1:2.2.9-1ubuntu1
* Merge from Debian unstable, remaining changes:
  + Add mail-stack-delivery package:
    - Update d/rules
    - d/control: convert existing dovecot-postfix package to a dummy
      package and add new mail-stack-delivery package.
    - Update maintainer scripts.
    - Rename d/dovecot-postfix.* to debian/mail-stack-delivery.*
    - d/mail-stack-delivery.preinst: Move previously installed backups and
      config files to a new package namespace.
    - d/mail-stack-delivery.prerm: Added to handle downgrades.
  + Use Snakeoil SSL certificates by default:
    - d/control: Depend on ssl-cert.
    - d/dovecot-core.postinst: Relax grep for SSL_* a bit.
  + Add autopkgtest to debian/tests/*.
  + Add ufw integration:
    - d/dovecot-core.ufw.profile: new ufw profile.
    - d/rules: install profile in dovecot-core.
    - d/control: dovecot-core - suggest ufw.
  + d/dovecot-core.dirs: Added usr/share/doc/dovecot-core
  + Add apport hook:
    - d/rules, d/source_dovecot.py
  + Add upstart job:
    - d/rules, d/dovecot-core.dovecot.upstart, d/control,
      d/dovecot-core.dirs, dovecot-imapd.{postrm, postinst, prerm},
      d/dovecot-pop3d.{postinst, postrm, prerm}.
      d/mail-stack-deliver.postinst: Convert init script to upstart.
  + Use the autotools-dev dh addon to update config.guess/config.sub for
    arm64.
* Dropped changes, included in Debian:
  - Update Dovecot name to reflect distribution in login greeting.
  - Update Drac plugin for >= 2.0.0 support.
* d/control: Drop dovecot-postfix package as its no longer required.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
=================
3
3
 
4
4
The Listescape plugin allows users to use characters in mailboxes names that
5
 
would otherwise be illegal, for example:
 
5
would otherwise be illegal (due to the underlying mailbox storage), for
 
6
example:
6
7
 
7
 
 * Maildir++ layout disallows using the '.' character, since it's used
8
 
   internally as the hierarchy separator.
 
8
 * Maildir++ layout disallows using the '.' character (unless LAYOUT=fs is
 
9
   used), since it's used internally as the folder hierarchy separator.
9
10
 * The '~' character at the beginning of the mailbox name is disallowed,
10
11
   because of the possibility that it gets expanded to user's home directory.
11
 
 * The '/' character is disallowed with all layouts (if it's not the hierarchy
12
 
   separator).
 
12
 * The '/' character is disallowed on POSIX systems.
13
13
 
14
14
The Listescape plugin allows you to use all of these characters, as long as the
15
 
virtual separator is changed to something else. The characters are escaped to
16
 
the mailbox name as \NN hex codes.
 
15
virtual separator (i.e. what is set by the separator= setting and used as such
 
16
by the IMAP protocol) is changed to something else, which means that the plugin
 
17
does *not* make it possible to use the virtual separator in folder names.
 
18
 
 
19
The characters are escaped to the mailbox name as \NN hex codes.
17
20
 
18
21
So what would be a good hierarchy separator to use?
19
22
 
20
23
 * '.' and '/' are very commonly used and should work everywhere
21
 
 * '\' is used by Exchange, and should also work everywhere
 
24
 * '\' is used by Exchange, and should also work everywhere (when specifying
 
25
   this in the separator= setting it must be quoted, so one sets separator =
 
26
   "\\")
22
27
 * '^' is used internally by Thunderbird and causes some trouble with it
23
28
 * others?
24
29
 
26
31
--------
27
32
 
28
33
Allow '.' characters with Maildir++ layout when virtual hierarchy separator is
29
 
changed to '/':
 
34
changed to '/' (it could be anything else except '.' itself):
30
35
 
31
36
---%<-------------------------------------------------------------------------
32
37
mail_plugins = $mail_plugins listescape
56
61
}
57
62
---%<-------------------------------------------------------------------------
58
63
 
59
 
(This file was created from the wiki on 2012-04-23 04:42)
 
64
(This file was created from the wiki on 2013-11-24 04:42)