commands/vdeliver.pod
changeset 0 6f7a81934006
child 2 b3afb9f1e801
equal deleted inserted replaced
-1:000000000000 0:6f7a81934006
       
     1 =head1 NAME
       
     2 
       
     3 vdeliver - VMailMgr delivery agent
       
     4 
       
     5 =head1 SYNOPSIS
       
     6 
       
     7 B<vdeliver>
       
     8 [B<-D>]
       
     9 [B<-F>]
       
    10 [B<-R>]
       
    11 [B<-d>]
       
    12 [B<-f>]
       
    13 [B<--quiet>]
       
    14 [B<-r>]
       
    15 
       
    16 
       
    17 =head1 DESCRIPTION
       
    18 
       
    19 vdeliver is the unified e-mail message delivery agent for virtual
       
    20 domains managed by vmailmgr.
       
    21 It is run from the F<.qmail-default> file, and automatically handles
       
    22 delivery to any user within a virtual domain.
       
    23 
       
    24 
       
    25 =head1 OPTIONS
       
    26 
       
    27 =over 8
       
    28 
       
    29 =item B<-D>
       
    30 
       
    31 Add the C<Return-Path:> line to the top of the message. (default)
       
    32 
       
    33 =item B<-F>
       
    34 
       
    35 Add a "C<From >" mailbox line.
       
    36 
       
    37 =item B<-R>
       
    38 
       
    39 Add a "C<Return-Path:>" line (default).
       
    40 
       
    41 =item B<-d>
       
    42 
       
    43 Do not add the C<Delivered-To:> line to the top of the message.
       
    44 
       
    45 =item B<-f>
       
    46 
       
    47 Do not add the C<From> mailbox line to the top of the message. Note that this line is never added when the message is being re-injected into the mail stream. (default)
       
    48 
       
    49 =item B<--quiet>
       
    50 
       
    51 Suppress all status messages.
       
    52 
       
    53 =item B<-r>
       
    54 
       
    55 Do not add the C<Return-Path:> line to the top of the message.
       
    56 
       
    57 =back
       
    58 
       
    59 =head1 RETURN VALUE
       
    60 
       
    61 
       
    62 Returns 0 if delivery was successful,
       
    63 100 if a fatal error occurred,
       
    64 or 111 if a temporary error occurred.
       
    65 
       
    66 
       
    67 
       
    68 =head1 ENVIRONMENT
       
    69 
       
    70 
       
    71 F<vdeliver> expects to be run by F<qmail-local> as it requires several
       
    72 of the environment variables that it sets.
       
    73 See the I<qmail-command>(8) manual page for full details on these
       
    74 variables.
       
    75 In particular, it requires C<DTLINE>, C<EXT>, C<HOST>, C<RPLINE>,
       
    76 C<SENDER>, C<UFLINE>, and C<USER>.
       
    77 
       
    78 
       
    79 
       
    80 =head1 SEE ALSO
       
    81 
       
    82 
       
    83 checkvpw(1), I<qmail-command>(8)
       
    84 
       
    85 
       
    86 
       
    87 =head1 AUTHORS
       
    88 
       
    89 Bruce Guenter <bruceg@em.ca>
       
    90