cabal-version: 3.0
name: mailbox-count
-version: 0.0.5
+version: 0.0.6
author: Michael Orlitzky
-maintainer: Michael Orlitzky <michael@orlitzky.com>
-license: AGPL-3.0-only
+maintainer: Michael Orlitzky <michael@orlitzky.com>
+license: AGPL-3.0-or-later
license-file: doc/LICENSE
+homepage: https://michael.orlitzky.com/code/mailbox-count.xhtml
bug-reports: mailto:michael@orlitzky.com
category: Mail, Utils
build-type: Simple
extra-source-files:
+ doc/COPYING
doc/mailbox-countrc.example
doc/man1/mailbox-count.1
test/fixtures/postfixadmin.sqlite3
synopsis:
- Count mailboxes in a SQL database.
+ Count mailboxes in a SQL database
description:
/Usage/:
Mailbox-count produces a simple count of mailboxes that exist
per-domain in some SQL database. The default queries are compatible
- with the schema used by PostfixAdmin <http://postfixadmin.sourceforge.net/>,
+ with the schema used by PostfixAdmin <https://postfixadmin.sourceforge.net/>,
but it is possible to supply your own queries via the @--summary-query@
and @--detail-query@ options.
/Options/:
- @
- \--database
- @
+ * \--database
- The name of the database (or file, if SQLite) to which we should
- connect.
+ The name of the database (or file, if SQLite) to which we should
+ connect.
- Default: The name of the current user (Postgres only).
+ Default: The name of the current user (Postgres only).
- @
- \--detail
- @
+ * \--detail
- Produce a detailed report listing all mailboxes by domain.
+ Produce a detailed report listing all mailboxes by domain.
- @
- \--detail-query
- @
+ * \--detail-query
- SQL query used to produce the detail report. This should return the
- set of all (domain, username) pairs. See the default value for an
- example.
+ SQL query used to produce the detail report. This should return the
+ set of all (domain, username) pairs. See the default value for an
+ example.
- Default: \"SELECT domain,username FROM mailbox ORDER BY domain;\"
+ Default: \"SELECT domain,username FROM mailbox ORDER BY domain;\"
- @
- \--host
- @
+ * \--host
- Hostname where the database is located (Postgres-only).
+ Hostname where the database is located (Postgres-only).
- Default: None, a UNIX domain socket connection is attempted (Postgres only)
+ Default: None, a UNIX domain socket connection is attempted
+ (Postgres only)
- @
- \--password
- @
+ * \--password
- Password used to connect to the database (Postgres-only).
+ Password used to connect to the database (Postgres-only).
- Default: None (assumes passwordless authentication)
+ Default: None (assumes passwordless authentication)
- @
- \--port
- @
- Port number used to connect to the database (Postgres-only).
+ * \--port
- Default: None, a UNIX domain socket connection is attempted (Postgres only)
+ Port number used to connect to the database (Postgres-only).
- @
- \--summary-query
- @
+ Default: None, a UNIX domain socket connection is attempted
+ (Postgres only)
- SQL query used to produce the summary report. This should return
- (domain, user count) pairs. See the default value for an
- example.
+ * \--summary-query
- Default: \"SELECT domain,COUNT(username) FROM mailbox GROUP BY domain
- ORDER BY domain;\"
+ SQL query used to produce the summary report. This should return
+ (domain, user count) pairs. See the default value for an
+ example.
- @
- \--username
- @
+ Default: \"SELECT domain,COUNT(username) FROM mailbox GROUP BY domain
+ ORDER BY domain;\"
- Username used to connect to the database (Postgres-only).
+ * \--username
- Default: The current user
+ Username used to connect to the database (Postgres-only).
+
+ Default: The current user
/Examples/:
directory >= 1.2,
filepath >= 1.3,
HDBC >= 2.4,
- HDBC-postgresql >= 2.3,
HDBC-sqlite3 >= 2.3,
MissingH >= 1.2,
tasty >= 0.8,
source-repository head
type: git
- location: http://gitweb.michael.orlitzky.com/mailbox-count.git
+ location: https://gitweb.michael.orlitzky.com/mailbox-count.git
branch: master