Update release date.
[aox:aox.git] / doc / deliver.man
1 .\" Copyright 2009 The Archiveopteryx Developers <info@aox.org>
2 .TH deliver 8 2009-07-13 aox.org "Archiveopteryx Documentation"
3 .SH NAME
4 deliver - deliver mail into Archiveopteryx.
5 .SH SYNOPSIS
6 .B $BINDIR/deliver [-f sender] [-t mailbox] [-v] destination [filename]
7 .SH DESCRIPTION
8 .nh
9 .PP
10 The
11 .B deliver
12 program injects a single mail message in RFC-822 format into
13 Archiveopteryx.
14 It connects to Archiveopteryx's backend ddatabase injects the message
15 into the correct mailbox.
16 .PP
17 .B deliver
18 is meant as a compatibility shim for use with e.g.
19 .BR formail (1)
20 and with MTAs that want to deliver to a program.
21 Note that you will generally get better performance by using LMTP.
22 .PP
23 .B deliver
24 bypasses Sieve and always stores mail directly into the target mailbox.
25 .SH OPTIONS
26 .IP "-f sender"
27 specifies the fully qualified address of the message sender. This is
28 the same as the SMTP envelope sender.
29 .IP
30 Starting with version 2.01, the
31 .I -f
32 argument is ignored. It is still accepted to keep old scripts working.
33 .IP "-t mailbox"
34 directs
35 .B deliver
36 to store the message into the named mailbox. The "p" right on the
37 mailbox must be granted to "anyone". ("p" controls who is permitted to
38 send mail to the mailbox, see RFC 4314 for more details.)
39 .IP "-v"
40 requests more verbosity during delivery. May be specified twice.
41 .SH EXAMPLES
42 To deliver an entire berkeley mbox into the inbox of user nirmala@example.com:
43 .IP
44 formail -s deliver nirmala@example.com < mbox
45 .PP
46 To deliver each message in the MH folder +blah into the
47 inbox of user raj@example.net:
48 .IP
49 folder +blah
50 .br
51 seq all | xargs -n1 deliver raj@example.net
52 .PP
53 To deliver each message in the MH folder +ramble into folder stumble
54 of user raj@example.net:
55 .IP
56 folder +blah
57 .br
58 seq all | xargs -n1 deliver -t stumble raj@example.net
59 .PP
60 If raj has not granted "anyone" the "p" right ("p"ost mail to
61 mailbox), this example fails.
62 .SH DIAGNOSTICS
63 The normal exit status of
64 .B deliver
65 is 0. In case of errors,
66 .B deliver
67 returns an error code from sysexits.h, such as EX_TEMPFAIL, EX_NOUSER, etc.
68 .SH BUGS
69 Delivering multiple messages would also be good, for those big mailbox
70 migrations. In that case,
71 .B
72 deliver
73 should report which messages could be delivered and which could not.
74 .PP
75 There is no command-line option to set the configuration file.
76 .SH AUTHOR
77 The Archiveopteryx Developers, info@aox.org.
78 .SH VERSION
79 This man page covers Archiveopteryx version 3.1.2, released 2009-07-13,
80 http://www.archiveopteryx.org/3.1.2
81 .SH SEE ALSO
82 .BR archiveopteryx (8),
83 .BR archiveopteryx.conf (5),
84 .BR logd (8),
85 .BR tlsproxy (8),
86 http://www.archiveopteryx.org