nightmaremail

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs

qmail-local.8 (2541B)

      1 .Dt qmail-local 8
      2 .Dd Oct 19, 2022
      3 .Sh NAME
      4 qmail-local \- deliver or forward a mail message
      5 .Sh SYNOPSIS
      6 .Nm qmail-local
      7 .Op Fl nN
      8 .Ar user
      9 .Ar homedir
     10 .Ar local
     11 .Ar dash
     12 .Ar ext
     13 .Ar domain
     14 .Ar sender
     15 .Ar defaultdelivery
     16 .Sh DESCRIPTION
     17 .Nm
     18 reads a mail message
     19 and delivers it to
     20 .Ar user
     21 by the procedure described in
     22 .Xr dot-qmail 5
     23 \fR.
     24 The message's envelope recipient is
     25 .IR local@domain .
     26 .Nm
     27 records
     28 .Ar local@domain
     29 in a new
     30 \fBDelivered-To\fR
     31 header field.
     32 If exactly the same
     33 \fBDelivered-To: \fIlocal@domain\fR
     34 already appears in the header,
     35 .Nm
     36 bounces the message,
     37 to prevent mail forwarding loops.
     38 
     39 The message's envelope sender is
     40 .Ar sender
     41 \fR.
     42 .Nm
     43 records
     44 .Ar sender
     45 in a new
     46 \fBReturn-Path\fR
     47 header field.
     48 
     49 .Ar homedir
     50 is the user's home directory.
     51 It must be an absolute directory name.
     52 
     53 .Ar dash
     54 and
     55 .Ar ext
     56 identify the
     57 \fB.qmail\fIdashext\fR
     58 file used by
     59 .Nm qmail-local
     60 ;
     61 see
     62 .Xr dot-qmail 5
     63 Normally
     64 .Ar dash
     65 is either empty or a lone hyphen.
     66 If it is empty,
     67 .Nm
     68 treats a nonexistent
     69 \fB.qmail\fIext\fR
     70 the same way as an empty
     71 \fB.qmail\fIext\fR:
     72 namely, following the delivery instructions in
     73 \fIdefaultdelivery\fR.
     74 
     75 The standard input for
     76 .Nm
     77 must be a seekable file,
     78 so that
     79 .Nm
     80 can read it more than once.
     81 .Sh "OPTIONS"
     82 .Bl -tag -width "-w size"
     83 .It -n
     84 Instead of reading and delivering the message,
     85 print a description of the delivery instructions.
     86 .It -N
     87 (Default.) Read and deliver the message.
     88 .It -T
     89 (Not implemented yet.) Used by SMTPDs. Requires the target user to have a home directory that is executable by the SMTPD user, and for the relevant .qmail file to be readable by qmail-local. Exit 99 if delivery WILL succeed, exit 0 if delivery MAY succeed, exit 111 if delivery will temporarily fail, exit with any other status if delivery will permanently fail. Output is not to be relied upon, but must be possible; pass the first line through to the sender and the rest to some logging mechanism.
     90 .El
     91 .Sh "EXIT CODES"
     92 0 if the delivery is completely successful;
     93 nonzero if any delivery instruction failed.
     94 Exit code 111
     95 indicates temporary failure.
     96 .Sh "SEE ALSO"
     97 .Bl -tag -width "-w size"
     98 .It Xr dot-qmail 5
     99 .It Xr envelopes 5
    100 .It Xr qmail-command 8
    101 .It Xr qmail-queue 8
    102 .It Xr qmail-send 8
    103 .It Xr qmail-lspawn 8
    104 .It Lk http://www.courier-mta.org/dot-courier.html dot-courier(5)
    105 to compare and contrast with the methodology used by the Courier MTA for its .qmail file support. In the coming years, Nightmare Mail's developers intend to conform Nightmare Mail to Courier's .qmail file interface.
    106 .El