X-Git-Url: http://gitweb.michael.orlitzky.com/?p=list-remote-forwards.git;a=blobdiff_plain;f=list-remote-forwards.cabal;h=bbf73d2a9edf1887b8003a771965b470bc5c7434;hp=efd6288e9ad69766e80aa6b987193c3ce9afd654;hb=3162fcab26da67c5b0169e552e7de74aef92101c;hpb=e9bb5fc1ec7d300b2d6f3c70a76bffac51d63a19 diff --git a/list-remote-forwards.cabal b/list-remote-forwards.cabal index efd6288..bbf73d2 100644 --- a/list-remote-forwards.cabal +++ b/list-remote-forwards.cabal @@ -1,9 +1,9 @@ +cabal-version: 3.0 name: list-remote-forwards -version: 0.0.1 -cabal-version: >= 1.8 +version: 0.0.2 author: Michael Orlitzky maintainer: Michael Orlitzky -license: AGPL-3 +license: AGPL-3.0-only license-file: doc/LICENSE bug-reports: mailto:michael@orlitzky.com category: Mail, Utils @@ -16,125 +16,115 @@ synopsis: List all remote forwards for mail accounts stored in a SQL database. description: /Usage/: - . + @ list-remote-forwards [OPTIONS] @ - . + List all remote forwards for mail accounts stored in a SQL database. - . + A list of local domains is supplied to the program (more or less) through the @--domain-query@ option. Any addresses which forward to another address not contained in this list of local domains is considered a remote forward. Remote forwards can cause problems for a number of reasons, the most common of which are, - . + * If the sender has an SPF record authorizing his mail server to send mail on his behalf, then when his message is forwarded by the recipient's mail server, it will fail any subsequent SPF checks. This will likely cause the message to be rejected, and the original recipient's server will generate backscatter. - . + * If any spam makes it through the filter on the recipient's mail server, that spam will then be forwarded to a remote destination. The remote destination will blame the forwarding server for the spam, and that can impact its reputation and potentially lead to a blacklisting even though the spam did not originate on the recipient's server. - . + Whether or not these are an issue depends on the circumstances, but in any case it is useful to know who is forwarding mail off-site. - . + /Input:/ - . + None. - . + /Output:/ - . + A list of addresses that are forwarded to remote domains. - . + /Options/: - . - @ - \--database - @ - . - The name of the database (or file, if SQLite) to which we should - connect. - . - Default: The name of the current user (Postgres only). - . - @ - \--domain-query - @ - SQL query used to produce a list of local domains. This should return - the set of all domains (i.e one column) that are local to the - server. See the default value for an example. - . - Default: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\" - . - @ - \--exclude-mx, -e - @ - . - The name of a mail exchanger, the forwards of whose domains we should - ignore. For example, if one mail exchanger, mx1.example.com, has - strict spam filtering, it may be acceptable to have remote forwarding - for domains that have mx1.example.com as their sole mail exchanger (MX - record). In that case, you might want to exclude those domains from - the report by naming mx1.example.com here. - . - A forward will be excluded from the report only if /all/ of its MX - records are contained in the given exclude list. - . - This option can be repeated to add mail exchangers to the exclude list. - . - Default: [] (empty) - . - @ - \--forward-query, -f - @ - . - SQL query used to produce a list of all forwards on the mail - system. This query should return the set of all (address, goto) - triples, where \"goto\" is the destination address; i.e. to where - the \"address\" forwards. The \"goto\" field may contain more - than one email address, separated by commas. - . - Default: \"SELECT address,goto FROM alias ORDER BY address;\" - . - @ - \--host, -h - @ - . - Hostname where the database is located (Postgres-only). - . - Default: None, a UNIX domain socket connection is attempted (Postgres only) - . - @ - \--password - @ - . - Password used to connect to the database (Postgres-only). - . - Default: None (assumes passwordless authentication) - . - @ - \--port - @ - Port number used to connect to the database (Postgres-only). - . - Default: None, a UNIX domain socket connection is attempted (Postgres only) - . - @ - \--username, -u - @ - . - Username used to connect to the database (Postgres-only). - . - Default: The current user - . + + * \--database + + The name of the database (or file, if SQLite) to which we should + connect. + + Default: The name of the current user (Postgres only). + + * \--domain-query + + SQL query used to produce a list of local domains. This should + return the set of all domains (i.e one column) that are local to the + server. See the default value for an example. + + Default: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY + domain;\" + + * \--exclude-mx, -e + + The name of a mail exchanger, the forwards of whose domains we + should ignore. For example, if one mail exchanger, + mx1.example.com, has strict spam filtering, it may be acceptable + to have remote forwarding for domains that have mx1.example.com + as their sole mail exchanger (MX record). In that case, you + might want to exclude those domains from the report by naming + mx1.example.com here. + + A forward will be excluded from the report only if /all/ of its MX + records are contained in the given exclude list. + + This option can be repeated to add mail exchangers to the exclude list. + + Default: [] (empty) + + * \--forward-query, -f + + SQL query used to produce a list of all forwards on the mail + system. This query should return the set of all (address, goto) + triples, where \"goto\" is the destination address; i.e. to + where the \"address\" forwards. The \"goto\" field may contain + more than one email address, separated by commas. + + Default: \"SELECT address,goto FROM alias ORDER BY address;\" + + * \--host, -h + + Hostname where the database is located (Postgres-only). + + Default: None, a UNIX domain socket connection is attempted + (Postgres only) + + * \--password + + Password used to connect to the database (Postgres-only). + + Default: None (assumes passwordless authentication) + + * \--port + + Port number used to connect to the database (Postgres-only). + + Default: None, a UNIX domain socket connection is attempted + (Postgres only) + + * \--username, -u + + Username used to connect to the database (Postgres-only). + + Default: The current user + /Examples/: - . + @ $ list-remote-forwards --database=test\/fixtures\/postfixadmin.sqlite3 user1@example.com -> user1@example.net @@ -146,7 +136,7 @@ description: executable list-remote-forwards build-depends: - base >= 4.6 && < 5, + base >= 4.15 && < 5, bytestring >= 0.10, cmdargs >= 0.10, configurator >= 0.2, @@ -159,8 +149,11 @@ executable list-remote-forwards HDBC-sqlite3 >= 2.3, MissingH >= 1.2, tasty >= 0.8, - tasty-hunit >= 0.8, - tasty-quickcheck >= 0.8 + tasty-hunit >= 0.8 + + default-language: + Haskell2010 + main-is: Main.hs @@ -172,18 +165,35 @@ executable list-remote-forwards CommandLine DNS Forward - OptionalConfiguration MxList + OptionalConfiguration + Paths_list_remote_forwards Report String + + autogen-modules: Paths_list_remote_forwards test-suite testsuite type: exitcode-stdio-1.0 hs-source-dirs: src test + default-language: Haskell2010 main-is: TestSuite.hs + + other-modules: + Configuration + DNS + Forward + MxList + OptionalConfiguration + Paths_list_remote_forwards + Report + + autogen-modules: + Paths_list_remote_forwards + build-depends: - base >= 4.6 && < 5, + base >= 4.15 && < 5, bytestring >= 0.10, cmdargs >= 0.10, configurator >= 0.2, @@ -192,19 +202,18 @@ test-suite testsuite directory >= 1.2, filepath >= 1.3, HDBC >= 2.4, - HDBC-postgresql >= 2.3, HDBC-sqlite3 >= 2.3, MissingH >= 1.2, tasty >= 0.8, - tasty-hunit >= 0.8, - tasty-quickcheck >= 0.8 + tasty-hunit >= 0.8 test-suite doctests type: exitcode-stdio-1.0 hs-source-dirs: test + default-language: Haskell2010 main-is: Doctests.hs build-depends: - base == 4.*, + base >= 4.15 && < 5, -- Additional test dependencies. doctest >= 0.9, filemanip >= 0.3.6