[qmail] / qmail-command.8

.TH 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 described 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)
Commit	Line	Data
2117e02e MW	1	.TH qmail-command 8
	2	.SH NAME
	3	qmail-command \- user-specified mail delivery program
	4	.SH SYNOPSIS
	5	in
	6	.BR .qmail\fIext :
	7	.B \|\fIcommand
	8	.SH DESCRIPTION
	9	.B qmail-local
	10	will, upon your request,
	11	feed each incoming mail message through a program of your choice.
	12
	13	When a mail message arrives,
	14	.B qmail-local
	15	runs
	16	.B sh -c \fIcommand
	17	in your home directory.
	18	It makes the message available on
	19	.IR command 's
	20	standard input.
	21
	22	.B WARNING:
	23	The mail message does not begin with
	24	.BR qmail-local 's
	25	usual
	26	.B Return-Path
	27	and
	28	.B Delivered-To
	29	lines.
	30
	31	Note that
	32	.B qmail-local
	33	uses the same file descriptor for every delivery
	34	in your
	35	.B .qmail
	36	file, so it is not safe for
	37	.I command
	38	to fork a child that
	39	reads the message in the background while the parent exits.
212b6f5d	40	.SH "EXIT CODES"
2117e02e MW	41	.IR command 's
	42	exit codes are interpreted as follows:
	43	0 means that the delivery was successful;
	44	99 means that the delivery was successful,
	45	but that
	46	.B qmail-local
	47	should ignore all further delivery instructions;
	48	100 means that the delivery failed permanently (hard error);
	49	111 means that the delivery failed but should be tried again
	50	in a little while (soft error).
212b6f5d	51
2117e02e MW	52	Currently 64, 65, 70, 76, 77, 78, and 112 are considered hard errors,
	53	and all other codes are considered soft errors,
	54	but
	55	.I command
	56	should avoid relying on this.
212b6f5d	57	.SH "ENVIRONMENT VARIABLES"
2117e02e MW	58	.B qmail-local
	59	supplies several useful environment variables to
	60	.IR command .
212b6f5d MW	61	.B WARNING:
	62	These environment variables are not quoted.
	63	They may contain special characters.
	64	They are under the control of a possibly malicious remote user.
	65
2117e02e MW	66	.B SENDER
	67	is the envelope sender address.
	68	.B NEWSENDER
	69	is the forwarding envelope sender address,
	70	as described in
	71	.BR dot-qmail(5) .
	72	.B RECIPIENT
	73	is the envelope recipient address,
	74	.IR local@domain .
	75	.B USER
	76	is
	77	.IR user .
	78	.B HOME
	79	is your home directory,
	80	.IR homedir .
	81	.B HOST
	82	is the
	83	.I domain
	84	part of the recipient address.
	85	.B LOCAL
	86	is the
	87	.I local
	88	part.
	89	.B EXT
	90	is the
212b6f5d	91	address extension,
2117e02e	92	.IR ext .
212b6f5d MW	93
	94	.B HOST2
	95	is the portion of
	96	.B HOST
	97	preceding the last dot;
	98	.B HOST3
	99	is the portion of
	100	.B HOST
	101	preceding the second-to-last dot;
	102	.B HOST4
	103	is the portion of
	104	.B HOST
	105	preceding the third-to-last dot.
	106
2117e02e MW	107	.B EXT2
	108	is the portion of
	109	.B EXT
	110	following the first dash;
	111	.B EXT3
	112	is the portion
	113	following the second dash;
	114	.B EXT4
	115	is the portion
	116	following the third dash.
212b6f5d MW	117	.B DEFAULT
	118	is the portion
	119	corresponding to the
	120	.B default
	121	part of the
	122	.BR .qmail\- ...
	123	file name;
	124	.B DEFAULT
	125	is not set if
	126	the file name does not end with
	127	.BR default .
	128
2117e02e MW	129	.B DTLINE
	130	and
	131	.B RPLINE
	132	are the usual
	133	.B Delivered-To
	134	and
	135	.B Return-Path
	136	lines,
	137	including newlines.
	138	.B UFLINE
	139	is the UUCP-style
	140	.B From_
	141	line that
	142	.B qmail-local
	143	adds to
	144	.IR mbox -format
	145	files.
2117e02e MW	146	.SH "SEE ALSO"
	147	dot-qmail(5),
	148	envelopes(5),
	149	qmail-local(8)