| 1 |
<?xml version="1.0" encoding="utf-8" ?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 4 |
|
| 5 |
<head> |
| 6 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 7 |
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
| 8 |
<title>GLEP 32 -- Maildir Location</title> |
| 9 |
<link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
| 10 |
</head> |
| 11 |
<body bgcolor="white"> |
| 12 |
<table class="navigation" cellpadding="0" cellspacing="0" |
| 13 |
width="100%" border="0"> |
| 14 |
<tr><td class="navicon" width="150" height="35"> |
| 15 |
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
| 16 |
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
| 17 |
border="0" width="150" height="35" /></a></td> |
| 18 |
<td class="textlinks" align="left"> |
| 19 |
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
| 20 |
[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
| 21 |
[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0032.txt">GLEP Source</a></b>] |
| 22 |
</td></tr></table> |
| 23 |
<table class="rfc2822 docutils field-list" frame="void" rules="none"> |
| 24 |
<col class="field-name" /> |
| 25 |
<col class="field-body" /> |
| 26 |
<tbody valign="top"> |
| 27 |
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">32</td> |
| 28 |
</tr> |
| 29 |
<tr class="field"><th class="field-name">Title:</th><td class="field-body">Maildir Location</td> |
| 30 |
</tr> |
| 31 |
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> |
| 32 |
</tr> |
| 33 |
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0032.txt?cvsroot=gentoo">2007/04/21 03:13:16</a></td> |
| 34 |
</tr> |
| 35 |
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Georgi Georgiev <chutz at gg3.net></td> |
| 36 |
</tr> |
| 37 |
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Deferred</td> |
| 38 |
</tr> |
| 39 |
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
| 40 |
</tr> |
| 41 |
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> |
| 42 |
</tr> |
| 43 |
<tr class="field"><th class="field-name">Created:</th><td class="field-body">03-Nov-2004</td> |
| 44 |
</tr> |
| 45 |
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">03-Nov-2004</td> |
| 46 |
</tr> |
| 47 |
</tbody> |
| 48 |
</table> |
| 49 |
<hr /> |
| 50 |
<div class="contents topic"> |
| 51 |
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
| 52 |
<ul class="simple"> |
| 53 |
<li><a class="reference" href="#abstract" id="id4" name="id4">Abstract</a></li> |
| 54 |
<li><a class="reference" href="#motivation" id="id5" name="id5">Motivation</a></li> |
| 55 |
<li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li> |
| 56 |
<li><a class="reference" href="#implementation" id="id7" name="id7">Implementation</a><ul> |
| 57 |
<li><a class="reference" href="#maildir-variable" id="id8" name="id8">MAILDIR variable</a></li> |
| 58 |
<li><a class="reference" href="#maildir-eclass" id="id9" name="id9">maildir.eclass</a></li> |
| 59 |
<li><a class="reference" href="#patching-ebuilds" id="id10" name="id10">Patching ebuilds</a></li> |
| 60 |
</ul> |
| 61 |
</li> |
| 62 |
<li><a class="reference" href="#backwards-compatibility" id="id11" name="id11">Backwards Compatibility</a></li> |
| 63 |
<li><a class="reference" href="#references" id="id12" name="id12">References</a></li> |
| 64 |
<li><a class="reference" href="#copyright" id="id13" name="id13">Copyright</a></li> |
| 65 |
</ul> |
| 66 |
</div> |
| 67 |
<div class="section"> |
| 68 |
<h1><a class="toc-backref" href="#id4" id="abstract" name="abstract">Abstract</a></h1> |
| 69 |
<p>Ebuilds that install mail delivery agents often need to know the default |
| 70 |
location of users' mailbox. When the mailbox is of a maildir type, there is no |
| 71 |
set standard what the name of the directory should be. The most popular |
| 72 |
extensions are "Maildir", ".Maildir" and Gentoo has adopted its own ".maildir" |
| 73 |
name.</p> |
| 74 |
<p>This GLEP proposes a user-definable maildir location.</p> |
| 75 |
</div> |
| 76 |
<div class="section"> |
| 77 |
<h1><a class="toc-backref" href="#id5" id="motivation" name="motivation">Motivation</a></h1> |
| 78 |
<p>To provide the means to change the default location of a maildir, that is |
| 79 |
currently hardcoded in ebuilds.</p> |
| 80 |
<p>The ".maildir" name is not adequate for most situations.</p> |
| 81 |
<ul class="simple"> |
| 82 |
<li>"Maildir" is the defacto standard name for maildir mailboxes.</li> |
| 83 |
<li>People transferring e-mail configuration from other systems prefer to keep |
| 84 |
the original naming conventions.</li> |
| 85 |
<li>In a virtual hosting environment, having a hidden file in a directory |
| 86 |
dedicated for e-mail delivery is not a plus.</li> |
| 87 |
<li>All postfix and qmail related documentation gives "Maildir" as an example |
| 88 |
name.</li> |
| 89 |
</ul> |
| 90 |
</div> |
| 91 |
<div class="section"> |
| 92 |
<h1><a class="toc-backref" href="#id6" id="rationale" name="rationale">Rationale</a></h1> |
| 93 |
<p>The following comments were made in a discussion <a class="footnote-reference" href="#bugreport" id="id1" name="id1">[1]</a> on the Gentoo |
| 94 |
bugzilla</p> |
| 95 |
<ul class="simple"> |
| 96 |
<li>The default location should be specified in <tt class="docutils literal"><span class="pre">rc.conf</span></tt></li> |
| 97 |
<li>Preventing users from shooting themselves in the foot is not an issue</li> |
| 98 |
</ul> |
| 99 |
</div> |
| 100 |
<div class="section"> |
| 101 |
<h1><a class="toc-backref" href="#id7" id="implementation" name="implementation">Implementation</a></h1> |
| 102 |
<p>A <tt class="docutils literal"><span class="pre">maildir.eclass</span></tt> has been submitted to Bug 52076 <a class="footnote-reference" href="#bugreport" id="id2" name="id2">[1]</a>.</p> |
| 103 |
<p>Patches that implement features similar to this GLEP have already been |
| 104 |
submitted to Bug 52076 <a class="footnote-reference" href="#bugreport" id="id3" name="id3">[1]</a>.</p> |
| 105 |
<div class="section"> |
| 106 |
<h2><a class="toc-backref" href="#id8" id="maildir-variable" name="maildir-variable">MAILDIR variable</a></h2> |
| 107 |
<p>The default location for maildir delivery is specified by the <tt class="docutils literal"><span class="pre">$MAILDIR</span></tt> |
| 108 |
variable. This variable is specified in <tt class="docutils literal"><span class="pre">rc.conf</span></tt>.</p> |
| 109 |
</div> |
| 110 |
<div class="section"> |
| 111 |
<h2><a class="toc-backref" href="#id9" id="maildir-eclass" name="maildir-eclass">maildir.eclass</a></h2> |
| 112 |
<p>This eclass exports a <tt class="docutils literal"><span class="pre">$MAILDIR</span></tt> variable to the ebuilds that inherit it. If |
| 113 |
<tt class="docutils literal"><span class="pre">$MAILDIR</span></tt> has not been specified in <tt class="docutils literal"><span class="pre">rc.conf</span></tt> the eclass exports |
| 114 |
<tt class="docutils literal"><span class="pre">MAILDIR=.maildir</span></tt> for backwards compatibility reasons.</p> |
| 115 |
</div> |
| 116 |
<div class="section"> |
| 117 |
<h2><a class="toc-backref" href="#id10" id="patching-ebuilds" name="patching-ebuilds">Patching ebuilds</a></h2> |
| 118 |
<p>Since most ebuilds that currently need to know what the maildir delivery |
| 119 |
location is already take the default <tt class="docutils literal"><span class="pre">.maildir</span></tt> location into account when |
| 120 |
installing, modifying ebuilds to implement this GLEP is as simple as |
| 121 |
inheriting the <tt class="docutils literal"><span class="pre">maildir.eclass</span></tt> and substituting <tt class="docutils literal"><span class="pre">.maildir</span></tt> in the ebuild |
| 122 |
with the <tt class="docutils literal"><span class="pre">$MAILDIR</span></tt> variable. Care should be taken, to also modify any |
| 123 |
patches or scripts that are used by the ebuild, that already have <tt class="docutils literal"><span class="pre">.maildir</span></tt> |
| 124 |
hardcoded (vpopmail, exim).</p> |
| 125 |
</div> |
| 126 |
</div> |
| 127 |
<div class="section"> |
| 128 |
<h1><a class="toc-backref" href="#id11" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
| 129 |
<p>The default location is ".maildir", unless it is overridden. This way, there |
| 130 |
would be no backwards compatibility issues.</p> |
| 131 |
</div> |
| 132 |
<div class="section"> |
| 133 |
<h1><a class="toc-backref" href="#id12" id="references" name="references">References</a></h1> |
| 134 |
<table class="docutils footnote" frame="void" id="bugreport" rules="none"> |
| 135 |
<colgroup><col class="label" /><col /></colgroup> |
| 136 |
<tbody valign="top"> |
| 137 |
<tr><td class="label"><a name="bugreport">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>)</em> Bug 52076 (<a class="reference" href="http://bugs.gentoo.org/show_bug.cgi?id=52076">http://bugs.gentoo.org/show_bug.cgi?id=52076</a>)</td></tr> |
| 138 |
</tbody> |
| 139 |
</table> |
| 140 |
</div> |
| 141 |
<div class="section"> |
| 142 |
<h1><a class="toc-backref" href="#id13" id="copyright" name="copyright">Copyright</a></h1> |
| 143 |
<p>This document has been placed in the public domain.</p> |
| 144 |
</div> |
| 145 |
|
| 146 |
</div> |
| 147 |
<div class="footer"> |
| 148 |
<hr class="footer" /> |
| 149 |
<a class="reference" href="glep-0032.txt">View document source</a>. |
| 150 |
Generated on: 2007-10-13 13:39 UTC. |
| 151 |
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
| 152 |
|
| 153 |
</div> |
| 154 |
</body> |
| 155 |
</html> |
| 156 |
|
Parent Directory
| 
Revision Log
