1 name: list-remote-forwards
4 author: Michael Orlitzky
5 maintainer: Michael Orlitzky <michael@orlitzky.com>
7 license-file: doc/LICENSE
8 bug-reports: mailto:michael@orlitzky.com
12 doc/list-remote-forwards.example
13 doc/man1/list-remote-forwards.1
14 test/fixtures/postfixadmin.sqlite3
16 List all remote forwards for mail accounts stored in a SQL database.
21 list-remote-forwards [OPTIONS]
24 List all remote forwards for mail accounts stored in a SQL database.
26 A list of local domains is supplied to the program (more or less)
27 through the @--domain-query@ option. Any addresses which
28 forward to another address not contained in this list of local domains
29 is considered a remote forward. Remote forwards can cause problems for
30 a number of reasons, the most common of which are,
32 * If the sender has an SPF record authorizing his mail server to send
33 mail on his behalf, then when his message is forwarded by the
34 recipient's mail server, it will fail any subsequent SPF checks. This
35 will likely cause the message to be rejected, and the original
36 recipient's server will generate backscatter.
38 * If any spam makes it through the filter on the recipient's mail
39 server, that spam will then be forwarded to a remote destination. The
40 remote destination will blame the forwarding server for the spam, and
41 that can impact its reputation and potentially lead to a blacklisting
42 even though the spam did not originate on the recipient's server.
44 Whether or not these are an issue depends on the circumstances, but in
45 any case it is useful to know who is forwarding mail off-site.
53 A list of addresses that are forwarded to remote domains.
61 The name of the database (or file, if SQLite) to which we should
64 Default: The name of the current user (Postgres only).
69 SQL query used to produce a list of local domains. This should return
70 the set of all domains (i.e one column) that are local to the
71 server. See the default value for an example.
73 Default: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\"
79 SQL query used to produce a list of all forwards on the mail
80 system. This query should return the set of all (address, goto)
81 triples, where \"goto\" is the destination address; i.e. to where
82 the \"address\" forwards. The \"goto\" field may contain more
83 than one email address, separated by commas.
85 Default: \"SELECT address,goto FROM alias ORDER BY address;\"
91 Hostname where the database is located (Postgres-only).
93 Default: None, a UNIX domain socket connection is attempted (Postgres only)
99 Password used to connect to the database (Postgres-only).
101 Default: None (assumes passwordless authentication)
106 Port number used to connect to the database (Postgres-only).
108 Default: None, a UNIX domain socket connection is attempted (Postgres only)
114 Username used to connect to the database (Postgres-only).
116 Default: The current user
121 $ list-remote-forwards --database=postfixadmin.sqlite3
122 user1@example.com -> user1@example.net
123 user2@example.com -> user1@example.org
124 user2@example.com -> user2@example.org
125 user2@example.com -> user3@example.org
128 executable list-remote-forwards
139 HDBC-postgresql >= 2.3,
144 tasty-quickcheck >= 0.8
155 OptionalConfiguration
162 -fwarn-missing-signatures
163 -fwarn-name-shadowing
167 -fwarn-incomplete-record-updates
168 -fwarn-monomorphism-restriction
169 -fwarn-unused-do-bind
177 type: exitcode-stdio-1.0
178 hs-source-dirs: src test
179 main-is: TestSuite.hs
190 HDBC-postgresql >= 2.3,
195 tasty-quickcheck >= 0.8
197 -- It's not entirely clear to me why I have to reproduce all of this.
201 -fwarn-missing-signatures
202 -fwarn-name-shadowing
206 -fwarn-incomplete-record-updates
207 -fwarn-monomorphism-restriction
208 -fwarn-unused-do-bind
213 type: exitcode-stdio-1.0
218 -- Additional test dependencies.
222 -- It's not entirely clear to me why I have to reproduce all of this.
226 -fwarn-missing-signatures
227 -fwarn-name-shadowing
231 -fwarn-incomplete-record-updates
232 -fwarn-monomorphism-restriction
233 -fwarn-unused-do-bind
240 source-repository head
242 location: http://michael.orlitzky.com/git/list-remote-forwards.git