File: cvm-qmail.html

package info (click to toggle)
cvm 0.97-0.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,036 kB
  • sloc: ansic: 4,065; sh: 2,758; makefile: 235; sql: 15
file content (77 lines) | stat: -rw-r--r-- 3,234 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<html>
<body>

<h2><a href="cvm.html">CVM</a></h2>

<h1>The cvm-qmail Module</h1>

<h2>Synopsis:</h2> <p>qmail configuration lookup module</p>

<h2>Credentials:</h2>

<p>None, only operates as a lookup module.</p>

<h2>Description:</h2>

<p>This module uses the standard qmail configuration files to determine
if an address is valid, using the same lookups that qmail would.  It
first checks <tt>control/locals</tt> and then
<tt>control/virtualdomains</tt> to determine if the domain is valid, and
to determine the prefix to add to virtual domain usernames.  If the
domain is not found, it fails with <a href="facts.html">OUTOFSCOPE</a>
set to true.  It then looks up the resulting username
in <tt>users/cdb</tt> (or the system password table if the CDB does not
exist) to determine the correct home directory.  If the address would
require a <tt>.qmail-something</tt> file, it ensures that that file
exists as well, doing <tt>-default</tt> checks as necessary.  If the
address is not deliverable based on these checks, it fails
with <a href="facts.html">OUTOFSCOPE</a> set to false.</p>

<h2>Configuration Variables:</h2>

<dl>

<dt><tt>$CVM_QMAIL_ASSUME_LOCAL</tt> (optional)</dt> <dd>If set, all
domains not found in <tt>control/virtualdomains</tt> are assumed to be
local domains.</dd>

<dt><tt>$CVM_QMAIL_CHECK_PERMS</tt> (optional)</dt> <dd>If set, the CVM
will check that the <tt>.qmail</tt> file is accessible by temporarily
switching to the target user ID.  If <tt>$CVM_QMAIL_CHECK_PERMS</tt>
starts with a "<tt>-</tt>" and the lookup fails because access was
denied, then the lookup is rejected with a permanent error, otherwise a
temporary I/O error is returned.</dd>

<dt><tt>$CVM_QMAIL_LOOKASIDE</tt> (optional)</dt> <dd>This variable
contains a list of program names, separated by spaces.  If one of these
program names is found as a program delivery in the <tt>.qmail</tt>
file, cvm-qmail will fail the lookup with
<a href="facts.html">OUTOFSCOPE</a> set to true.  This is useful for
chaining lookups to <a href="cvm-vmailmgr.html">cvm-vmailmgr</a> or
other modules that correspond to programs that are executed
from <tt>.qmail-default</tt> files.</dd>

<dt><tt>$CVM_QMAIL_MISSINGDOMAIN</tt> (optional)</dt> <dd>If this is set
and the domain name is not a local or virtual qmail domain, this domain
name is substituted and the lookup succeeds.  This allows for setups
where domains listed in <tt>control/rcpthosts</tt> and
<tt>control/morercpthosts.cdb</tt> (which are accepted by the SMTP
receiver) are not listed as local or virtual domains.  If this is set to
an empty value, "<tt>localhost</tt>" is substituted.  This has no effect
if <tt>$CVM_QMAIL_ASSUME_LOCAL</tt> is set.</dd>

<dt><tt>$CVM_QMAIL_MISSINGUSER</tt> (optional)</dt> <dd>When missing
domain substitution is being done, the value of this variable is used to
replace the username.  The value must exist as a valid system user.
Defaults to "<tt>alias</tt>" which will normally exist on all qmail
systems.</dd>

<dt><tt>$QMAIL_ROOT</tt> (optional)</dt> <dd>The root directory under
which all the qmail configuration files are expected to be found.
Defaults to "<tt>/var/qmail</tt>", which is the normal qmail install
path.</dd>

</dl>

</body>
</html>