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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
.TH s/qmail: qmail-command 8
.SH NAME
qmail-command \- user-specified mail delivery program
.SH SYNOPSIS
in
.BR .qmail\fIext :
.B |\fIcommand
.SH DESCRIPTION
.B qmail-local
will, upon your request,
feed each incoming mail message through a program of your choice.
When a mail message arrives,
.B qmail-local
runs
.B sh -c \fIcommand
in your home directory.
It makes the message available on
.IR command 's
standard input.
.B WARNING:
The mail message does not begin with
.BR qmail-local 's
usual
.B Return-Path
and
.B Delivered-To
lines.
Note that
.B qmail-local
uses the same file descriptor for every delivery
in your
.B .qmail
file, so it is not safe for
.I command
to fork a child that
reads the message in the background while the parent exits.
.SH "EXIT CODES"
.IR command 's
exit codes are interpreted as follows:
0 means that the delivery was successful;
99 means that the delivery was successful,
but that
.B qmail-local
should ignore all further delivery instructions;
100 means that the delivery failed permanently (hard error);
111 means that the delivery failed but should be tried again
in a little while (soft error).
Currently 64, 65, 70, 76, 77, 78, and 112 are considered hard errors,
and all other codes are considered soft errors,
but
.I command
should avoid relying on this.
.SH "ENVIRONMENT VARIABLES"
.B qmail-local
supplies several useful environment variables to
.IR command .
.B WARNING:
These environment variables are not quoted.
They may contain special characters.
They are under the control of a possibly malicious remote user.
.B SENDER
is the envelope sender address.
.B NEWSENDER
is the forwarding envelope sender address,
as setup in
.BR dot-qmail(5) .
.B RECIPIENT
is the envelope recipient address,
.IR local@domain .
.B USER
is
.IR user .
.B HOME
is your home directory,
.IR homedir .
.B HOST
is the
.I domain
part of the recipient address.
.B LOCAL
is the
.I local
part.
.B EXT
is the
address extension,
.IR ext .
.B HOST2
is the portion of
.B HOST
preceding the last dot;
.B HOST3
is the portion of
.B HOST
preceding the second-to-last dot;
.B HOST4
is the portion of
.B HOST
preceding the third-to-last dot.
.B EXT2
is the portion of
.B EXT
following the first dash;
.B EXT3
is the portion
following the second dash;
.B EXT4
is the portion
following the third dash.
.B DEFAULT
is the portion
corresponding to the
.B default
part of the
.BR .qmail\- ...
file name;
.B DEFAULT
is not set if
the file name does not end with
.BR default .
.B DTLINE
and
.B RPLINE
are the usual
.B Delivered-To
and
.B Return-Path
lines,
including newlines.
.B UFLINE
is the UUCP-style
.B From_
line that
.B qmail-local
adds to
.IR mbox -format
files.
.SH "SEE ALSO"
dot-qmail(5),
envelopes(5),
qmail-local(8)
|
