| 1 |
g2boojum |
1.1 |
GLEP: 32
|
| 2 |
|
|
Title: Maildir Location
|
| 3 |
antarus |
1.2 |
Version: $Revision: 1.1 $
|
| 4 |
|
|
Last-Modified: $Date: 2004/11/03 23:38:05 $
|
| 5 |
g2boojum |
1.1 |
Author: Georgi Georgiev <chutz@gg3.net>
|
| 6 |
antarus |
1.2 |
Status: Deferred
|
| 7 |
g2boojum |
1.1 |
Type: Standards Track
|
| 8 |
|
|
Content-Type: text/x-rst
|
| 9 |
|
|
Created: 03-Nov-2004
|
| 10 |
|
|
Post-History: 03-Nov-2004
|
| 11 |
|
|
|
| 12 |
|
|
|
| 13 |
|
|
Abstract
|
| 14 |
|
|
========
|
| 15 |
|
|
|
| 16 |
|
|
Ebuilds that install mail delivery agents often need to know the default
|
| 17 |
|
|
location of users' mailbox. When the mailbox is of a maildir type, there is no
|
| 18 |
|
|
set standard what the name of the directory should be. The most popular
|
| 19 |
|
|
extensions are "Maildir", ".Maildir" and Gentoo has adopted its own ".maildir"
|
| 20 |
|
|
name.
|
| 21 |
|
|
|
| 22 |
|
|
This GLEP proposes a user-definable maildir location.
|
| 23 |
|
|
|
| 24 |
|
|
Motivation
|
| 25 |
|
|
==========
|
| 26 |
|
|
|
| 27 |
|
|
To provide the means to change the default location of a maildir, that is
|
| 28 |
|
|
currently hardcoded in ebuilds.
|
| 29 |
|
|
|
| 30 |
|
|
The ".maildir" name is not adequate for most situations.
|
| 31 |
|
|
|
| 32 |
|
|
- "Maildir" is the defacto standard name for maildir mailboxes.
|
| 33 |
|
|
|
| 34 |
|
|
- People transferring e-mail configuration from other systems prefer to keep
|
| 35 |
|
|
the original naming conventions.
|
| 36 |
|
|
|
| 37 |
|
|
- In a virtual hosting environment, having a hidden file in a directory
|
| 38 |
|
|
dedicated for e-mail delivery is not a plus.
|
| 39 |
|
|
|
| 40 |
|
|
- All postfix and qmail related documentation gives "Maildir" as an example
|
| 41 |
|
|
name.
|
| 42 |
|
|
|
| 43 |
|
|
Rationale
|
| 44 |
|
|
=========
|
| 45 |
|
|
|
| 46 |
|
|
The following comments were made in a discussion [#bugreport]_ on the Gentoo
|
| 47 |
|
|
bugzilla
|
| 48 |
|
|
|
| 49 |
|
|
- The default location should be specified in ``rc.conf``
|
| 50 |
|
|
|
| 51 |
|
|
- Preventing users from shooting themselves in the foot is not an issue
|
| 52 |
|
|
|
| 53 |
|
|
Implementation
|
| 54 |
|
|
==============
|
| 55 |
|
|
|
| 56 |
|
|
A ``maildir.eclass`` has been submitted to Bug 52076 [#bugreport]_.
|
| 57 |
|
|
|
| 58 |
|
|
Patches that implement features similar to this GLEP have already been
|
| 59 |
|
|
submitted to Bug 52076 [#bugreport]_.
|
| 60 |
|
|
|
| 61 |
|
|
MAILDIR variable
|
| 62 |
|
|
----------------
|
| 63 |
|
|
|
| 64 |
|
|
The default location for maildir delivery is specified by the ``$MAILDIR``
|
| 65 |
|
|
variable. This variable is specified in ``rc.conf``.
|
| 66 |
|
|
|
| 67 |
|
|
maildir.eclass
|
| 68 |
|
|
--------------
|
| 69 |
|
|
|
| 70 |
|
|
This eclass exports a ``$MAILDIR`` variable to the ebuilds that inherit it. If
|
| 71 |
|
|
``$MAILDIR`` has not been specified in ``rc.conf`` the eclass exports
|
| 72 |
|
|
``MAILDIR=.maildir`` for backwards compatibility reasons.
|
| 73 |
|
|
|
| 74 |
|
|
Patching ebuilds
|
| 75 |
|
|
----------------
|
| 76 |
|
|
|
| 77 |
|
|
Since most ebuilds that currently need to know what the maildir delivery
|
| 78 |
|
|
location is already take the default ``.maildir`` location into account when
|
| 79 |
|
|
installing, modifying ebuilds to implement this GLEP is as simple as
|
| 80 |
|
|
inheriting the ``maildir.eclass`` and substituting ``.maildir`` in the ebuild
|
| 81 |
|
|
with the ``$MAILDIR`` variable. Care should be taken, to also modify any
|
| 82 |
|
|
patches or scripts that are used by the ebuild, that already have ``.maildir``
|
| 83 |
|
|
hardcoded (vpopmail, exim).
|
| 84 |
|
|
|
| 85 |
|
|
Backwards Compatibility
|
| 86 |
|
|
=======================
|
| 87 |
|
|
|
| 88 |
|
|
The default location is ".maildir", unless it is overridden. This way, there
|
| 89 |
|
|
would be no backwards compatibility issues.
|
| 90 |
|
|
|
| 91 |
|
|
References
|
| 92 |
|
|
==========
|
| 93 |
|
|
|
| 94 |
|
|
.. [#bugreport] Bug 52076 (http://bugs.gentoo.org/show_bug.cgi?id=52076)
|
| 95 |
|
|
|
| 96 |
|
|
Copyright
|
| 97 |
|
|
=========
|
| 98 |
|
|
|
| 99 |
|
|
This document has been placed in the public domain.
|