chiark - git - mdw - qmail/blob - qmail-local.8

   1 .TH qmail-local 8
   2 .SH NAME
   3 qmail-local \- deliver or forward a mail message
   4 .SH SYNOPSIS
   5 .B qmail-local
   6 [
   7 .B \-nN
   8 ]
   9 .I user
  10 .I homedir
  11 .I local
  12 .I dash
  13 .I ext
  14 .I domain
  15 .I sender
  16 .I defaultdelivery
  17 .SH DESCRIPTION
  18 .B qmail-local
  19 reads a mail message
  20 and delivers it to
  21 .I user
  22 by the procedure described in
  23 .BR dot-qmail(5) .
  24
  25 The message's envelope recipient is
  26 .IR local@domain .
  27 .B qmail-local
  28 records
  29 .I local@domain
  30 in a new
  31 .B Delivered-To
  32 header field.
  33 If exactly the same
  34 .B Delivered-To: \fIlocal@domain
  35 already appears in the header,
  36 .B qmail-local
  37 bounces the message,
  38 to prevent mail forwarding loops.
  39
  40 The message's envelope sender is
  41 .IR sender .
  42 .B qmail-local
  43 records
  44 .I sender
  45 in a new
  46 .B Return-Path
  47 header field.
  48
  49 .I homedir
  50 is the user's home directory.
  51 It must be an absolute directory name.
  52
  53 .I dash
  54 and
  55 .I ext
  56 identify the
  57 .B .qmail\fIdashext
  58 file used by
  59 .BR qmail-local ;
  60 see
  61 .BR dot-qmail(5) .
  62 Normally
  63 .I dash
  64 is either empty or a lone hyphen.
  65 If it is empty,
  66 .B qmail-local
  67 treats a nonexistent
  68 .B .qmail\fIext
  69 the same way as an empty
  70 .BR .qmail\fIext :
  71 namely, following the delivery instructions in
  72 .IR defaultdelivery .
  73
  74 The standard input for
  75 .B qmail-local
  76 must be a seekable file,
  77 so that
  78 .B qmail-local
  79 can read it more than once.
  80 .SH "OPTIONS"
  81 .TP
  82 .B \-n
  83 Instead of reading and delivering the message,
  84 print a description of the delivery instructions.
  85 .TP
  86 .B \-N
  87 (Default.) Read and deliver the message.
  88 .SH "EXIT CODES"
  89 0 if the delivery is completely successful;
  90 nonzero if any delivery instruction failed.
  91 Exit code 111
  92 indicates temporary failure.
  93 .SH "SEE ALSO"
  94 dot-qmail(5),
  95 envelopes(5),
  96 qmail-command(8),
  97 qmail-queue(8),
  98 qmail-send(8),
  99 qmail-lspawn(8)