mailpot/docs/mailpot.1

4.3 KiB
Raw Blame History

MAILPOT(1)                  General Commands Manual                 MAILPOT(1)

NAME
     mailpot  mini mailing list manager.

SYNOPSIS
     mailpot [--debug] [--config config] [--quiet | --q] [--verbose | --v]
             [--timestamp | --t timestamp]

                   --debug
                         Activate debug mode.

                   --config config
                         Set config file.

                   --quiet | --q
                         Silence all output.

                   --verbose | --v
                         Verbose mode (-v, -vv, -vvv, etc).

                   --timestamp | --t timestamp
                         Timestamp (sec, ms, ns, none).



DESCRIPTION
     This command-line tool allows you to control databases of the mailing
     list manager mailpot.

COMMANDS
           db-location
                   Prints database filesystem location.
           config-location
                   Prints default configuration file filesystem location.
           dump-database
                   Dumps database data to STDOUT.
           list-lists
                   Lists all registered mailing lists.
           list    Mailing list management.
           create-list
                   --name name List name.

                   --id id List ID.

                   --address address List e-mail address.

                   --description description List description.

                   --archive-url archive-url List archive URL.

                   Create new list.
           post    --dry-run

                   Post message from STDIN to list.
           error-queue
                   Mail that has not been handled properly end up in the error
                   queue.
           import-maildir
                   --maildir-path maildir-path

                   Import a maildir folder into an existing list.
           db-location
                   Prints database filesystem location.
           config-location
                   Prints default configuration file filesystem location.
           dump-database
                   Dumps database data to STDOUT.
           list-lists
                   Lists all registered mailing lists.
           list    Mailing list management.
           create-list
                   Create new list.
           post    Post message from STDIN to list.
           error-queue
                   Mail that has not been handled properly end up in the error
                   queue.
           import-maildir
                   Import a maildir folder into an existing list.

   list subcommands
           members
                   List members of list.
           add-member
                   --address address E-mail address.

                   --name name Name.

                   --digest Send messages as digest?.

                   --hide-address Hide message from list when posting?.

                   --receive-confirmation receive-confirmation Hide message
                   from list when posting? Receive confirmation email when
                   posting?.

                   --receive-duplicates receive-duplicates Receive posts from
                   list even if address exists in To or Cc header?.

                   --receive-own-posts receive-own-posts Receive own posts
                   from list?.

                   --enabled enabled Is subscription enabled?.

                   Add member to list.
           remove-member
                   --address address E-mail address.

                   Remove member from list.
           update-membership
                   Update membership info.
           add-policy
                   --announce-only

                   --subscriber-only

                   --approval-needed

                   Add policy to list.
           remove-policy
                   --pk pk

           add-list-owner
                   --address address

                   --name name

                   Add list owner to list.
           remove-list-owner
                   --pk pk

           enable-membership
                   Alias for update-membership --enabled true.
           disable-membership
                   Alias for update-membership --enabled false.
           update  Update mailing list details.
           health  Show mailing list health status.
           info    Show mailing list info.
           members
                   List members of list.
           add-member
                   Add member to list.
           remove-member
                   Remove member from list.
           update-membership
                   Update membership info.
           add-policy
                   Add policy to list.
           remove-policy
           add-list-owner
                   Add list owner to list.
           remove-list-owner
           enable-membership
                   Alias for update-membership --enabled true.
           disable-membership
                   Alias for update-membership --enabled false.
           update  Update mailing list details.
           health  Show mailing list health status.
           info    Show mailing list info.

   error-queue subcommands
           list    List.
           print   --index index ... index of entry.

                   --json JSON format.

                   Print entry in RFC5322 or JSON format.
           delete  --index index ... index of entry.

                   --quiet Do not print in stdout.

                   Delete entry and print it in stdout.
           list    List.
           print   Print entry in RFC5322 or JSON format.
           delete  Delete entry and print it in stdout.

AUTHORS
     Manos Pitsidianakis <epilys@nessuent.xyz>

Debian                          April 19, 2024                          Debian