]> git.ipfire.org Git - people/ms/dma.git/blob - dbounce-simple-safecat.1
Invoke dma-migrate if present before flushing the queue.
[people/ms/dma.git] / dbounce-simple-safecat.1
1 .\" Copyright (c) 2009 Peter Pentchev
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .Dd March 12, 2009
26 .Dt DBOUNCE-SIMPLE-SAFECAT 1
27 .Os
28 .Sh NAME
29 .Nm dbounce-simple-safecat
30 .Nd store double-bounced email messages into a Maildir
31 .Sh SYNOPSIS
32 .Nm
33 .Op Fl a Ar addr
34 .Op Fl d Ar dir
35 .Op Fl i Ar queueid
36 .Op Fl t Ar type
37 .Fl f Ar msg
38 .Sh DESCRIPTION
39 The
40 .Nm
41 utility reads an email message file from the local MTA's queue directory and
42 invokes the
43 .Xr safecat 1
44 utility to store it into a Maildir-format directory for the administrator's
45 perusal.
46 It is intended to be used as a double-bounce handler by mail transfer agents
47 such as
48 .Xr dma 8
49 (when dma's
50 .Va DBOUNCEPROG
51 configuration setting is specified).
52 .Pp
53 The
54 .Nm
55 utility accepts the following command-line options; only
56 .Fl f
57 is mandatory:
58 .Pp
59 .Bl -tag -width "-i queueid"
60 .It Fl a Ar addr
61 The recipient of the bounce message.
62 .It Fl d Ar dir
63 The bounce directory,
64 .Pa /var/spool/mail/dma-bounces
65 by default.
66 .It Fl f Ar msg
67 The full path to the bounced message to process.
68 .It Fl i Ar queueid
69 The ID of the bounce message in the local MTA's queue.
70 .It Fl t Ar type
71 The MTA type, currently unused.
72 .El
73 .Sh EXAMPLES
74 Copy a message from the local
75 .Xr dma 8
76 queue into the default double-bounce Maildir:
77 .Pp
78 .Dl dbounce-simple-safecat -a roam@ringlet.net -i 40c1b8.882e250 -t dma -f /var/spool/dma/40c1b8.882e250
79 .Pp
80 A minimal execution with only the mandatory parameters:
81 .Pp
82 .Dl dbounce-simple-safecat -f /var/spool/dma/40c1b8.882e250
83 .Pp
84 Explicitly specify the destination directory:
85 .Pp
86 .Dl dbounce-simple-safecat -d /root/bounces -f /var/spool/dma/40c1b8.882e250
87 .Sh EXIT STATUS
88 .Ex -std
89 .Sh SEE ALSO
90 .Xr safecat 1 ,
91 .Xr dma 8
92 .Sh HISTORY
93 The
94 .Nm
95 utility was written by Peter Pentchev in 2009.
96 .Sh AUTHORS
97 .An Peter Pentchev
98 .Aq roam@ringlet.net
99 .Sh BUGS
100 No, thank you :)
101 But if you should actually find any, please report them
102 to the author.