man/man5/vmm.cfg.5.rst
branchv0.6.x
changeset 299 d15a27eaa9d2
parent 291 7ef3f117a230
child 304 df0f7b22540c
equal deleted inserted replaced
298:ee89399346cb 299:d15a27eaa9d2
   169 
   169 
   170 .. _bin.dovecotpw:
   170 .. _bin.dovecotpw:
   171 
   171 
   172 ``dovecotpw (default: /usr/sbin/dovecotpw)`` : *String*
   172 ``dovecotpw (default: /usr/sbin/dovecotpw)`` : *String*
   173   The absolute path to the dovecotpw binary. Use the absolute path to the
   173   The absolute path to the dovecotpw binary. Use the absolute path to the
   174   doveadm binary, if you are using Dovecot v2.0. This binary is used to
   174   **doveadm**\(1) binary, if you are using Dovecot v2.0. This binary is used
   175   generate a password hash, if |misc.password_scheme|_ is set to one of
   175   to generate a password hash, if |misc.password_scheme|_ is set to one of
   176   'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'OTP', 'RPA' or 'SKEY'. This binary will
   176   'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'OTP', 'RPA' or 'SKEY'. This binary will
   177   be also required if your Python installation doesn't support the:
   177   be also required if your Python installation doesn't support the:
   178 
   178 
   179   * md4 hash algorithm (hashlib + OpenSSL or PyCrypto) used for the password
   179   * md4 hash algorithm (hashlib + OpenSSL or PyCrypto) used for the password
   180     schemes: 'PLAIN-MD4' and 'NTLM'
   180     schemes: 'PLAIN-MD4' and 'NTLM'
   282 mailboxes in the users home directories. The INBOX will be created always.
   282 mailboxes in the users home directories. The INBOX will be created always.
   283 
   283 
   284 .. _mailbox.folders:
   284 .. _mailbox.folders:
   285 
   285 
   286 ``folders (default: Drafts:Sent:Templates:Trash)`` : *String*
   286 ``folders (default: Drafts:Sent:Templates:Trash)`` : *String*
   287   A colon separated list of mailboxes that should be created. (Works currently
   287   A colon separated list of mailboxes that should be created. If no
   288   only if the |mailbox.format|_ is either **maildir** or **mbox**. For other
   288   additionally mailboxes should be created, set the value of this option to a
   289   formats use Dovecot's autocreate plugin
   289   single colon ('**:**').
   290   <http://wiki.dovecot.org/Plugins/Autocreate>.) If no additionally mailboxes
       
   291   should be created, set the value of this option to a single colon ('**:**').
       
   292 
   290 
   293   If you want to create folders containing one or more subfolders, separate
   291   If you want to create folders containing one or more subfolders, separate
   294   them with a single dot ('**.**').
   292   them with a single dot ('**.**').
   295 
   293 
       
   294   If you want to use internationalized mailbox names (e.g. 'Wysłane' or
       
   295   'Gelöschte Objekte'), write their names UTF-8 encoded. |vmm(1)|_ will convert
       
   296   internationalized mailbox names to a modified  version of the UTF-7 encoding
       
   297   (see also: :RFC:`3501`, section 5.1.3).
       
   298 
   296 .. _mailbox.format:
   299 .. _mailbox.format:
   297 
   300 
   298 ``format (default: maildir)`` : *String*
   301 ``format (default: maildir)`` : *String*
   299   The mailbox format to be used for a user's mailbox. Depending on the used
   302   The mailbox format to be used for a user's mailbox. Depending on the used
   300   Dovecot version there are up to four supported formats:
   303   Dovecot version there are up to three supported formats:
   301 
   304 
   302     ``maildir``
   305     ``maildir``
   303       since Dovecot v1.0.0
   306       since Dovecot v1.0.0
   304     ``mbox``
       
   305       since Dovecot v1.0.0
       
   306     ``dbox``
       
   307       since Dovecot v1.0.0
       
   308     ``mdbox``
   307     ``mdbox``
   309       comes with Dovecot v2.0.0
   308       since Dovecot v2.0.beta1
   310 
   309     ``sdbox``
       
   310       since Dovecot v2.0.rc3
       
   311 
       
   312 .. _mailbox.root:
       
   313 
       
   314 ``root (default: Maildir)`` : *String*
       
   315   Name of the mailbox root directory in a user's home directory. Commonly used
       
   316   names, depending on the used |mailbox.format|_, are **Maildir**, **mdbox**
       
   317   or **sdbox**.
   311 
   318 
   312 Example::
   319 Example::
   313 
   320 
   314   [mailbox]
   321   [mailbox]
   315   folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
   322   folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
   316   format = maildir
   323   format = maildir
   317 
   324   root = Maildir
   318 .. _imap_uft7:
       
   319 
       
   320 .. note:: If you want to use internationalized mailbox names in the
       
   321   **folders** setting, you have to specify them in a modified version of the
       
   322   UTF-7 encoding (see :RFC:`3501`, section 5.1.3).
       
   323 
       
   324   Dovecot provides a useful utility for mUTF-7 <-> UTF-8 conversion:
       
   325   **imap-utf7**, it's available since Dovecot version 1.2.0.
       
   326 ..
       
   327 
       
   328 imap-utf7 example::
       
   329 
       
   330   user@host:~$ /usr/local/libexec/dovecot/imap-utf7 -r Wysłane
       
   331   Wys&AUI-ane
       
   332   user@host:~$ /usr/local/libexec/dovecot/imap-utf7 "&AVo-mietnik"
       
   333   Śmietnik
       
   334 
   325 
   335 
   326 
   336 MISC
   327 MISC
   337 ----
   328 ----
   338 The **misc** section is used to define miscellaneous settings.
   329 The **misc** section is used to define miscellaneous settings.