postfix_admin

Command Line Tool for PostfixAdmin

Description

• PostfixAdmin (Official Web-based Application)

  • GitHub https://github.com/postfixadmin/postfixadmin
  • Note: This CLI tool is a third-party implementation

• Supports PostfixAdmin 3.2

• Supports MySQL/MariaDB

• Other database engines are not supported

Requirements

• Ruby 3.2 - 3.4
• MySQL/MariaDB
• Dovecot (required for setting passwords using the doveadm pw subcommand)

Version Notes

• Version 0.7.x: Based on Active Record 8.0
• Version 0.6.x: Based on Active Record 7.2
• Version 0.5.x: Based on Active Record 7.1
• Version 0.4.x: Based on Active Record 7.0
• Version 0.3.3: Based on Active Record 6.1

Installation

Install postfix_admin using:

$ gem install postfix_admin

Execute the postfix_admin command to generate your config file at ~/.postfix_admin.conf:

$ postfix_admin

Edit the file for your environment:

$ vi ~/.postfix_admin.conf
---
database: mysql2://postfix:password@localhost/postfix
aliases: 30
mailboxes: 30
maxquota: 100
scheme: CRAM-MD5

The configuration file format is as follows:

database: mysql2://<username>:<password>@<host>/<database>
aliases: Default maximum number of aliases allowed per domain
mailboxes: Default maximum number of mailboxes allowed per domain
maxquota: Default maximum quota (in MB) allowed per mailbox for a domain
scheme: Default password scheme

You can see the domains on your host if the database parameter is set properly:

$ postfix_admin show

Usage

List the postfix_admin subcommands with:

$ postfix_admin

Commands:
  postfix_admin account_passwd user@example.com new_password               # Change the password of an account
  postfix_admin accounts                                                   # List all accounts
  postfix_admin add_account user@example.com password                      # Add a new account
  postfix_admin add_admin admin@example.com password                       # Add a new admin user
  postfix_admin add_admin_domain admin@example.com example.com             # Grant an admin user access to a specific domain
  postfix_admin add_alias alias@example.com goto@example.net               # Add a new alias
  postfix_admin add_domain example.com                                     # Add a new domain
  postfix_admin admin_passwd admin@example.com new_password                # Change the password of an admin user
  postfix_admin admins                                                     # List all admin users
  postfix_admin aliases                                                    # List all aliases
  postfix_admin delete_account user@example.com                            # Delete an account
  postfix_admin delete_admin admin@example.com                             # Delete an admin user
  postfix_admin delete_admin_domain admin@example.com example.com          # Revoke an admin user's access to a specific domain
  postfix_admin delete_alias alias@example.com                             # Delete an alias
  postfix_admin delete_domain example.com                                  # Delete a domain
  postfix_admin domains                                                    # List all domains
  postfix_admin dump                                                       # Dump all data
  postfix_admin edit_account user@example.com                              # Edit an account
  postfix_admin edit_admin admin@example.com                               # Edit an admin user
  postfix_admin edit_alias alias@example.com                               # Edit an alias
  postfix_admin edit_domain example.com                                    # Edit a domain
  postfix_admin forwards                                                   # List all forwards
  postfix_admin help [COMMAND]                                             # Describe available commands or one specific command
  postfix_admin log                                                        # Display action logs
  postfix_admin schemes                                                    # List all supported password schemes
  postfix_admin setup example.com password                                 # Set up a domain (add a domain and an admin user for it)
  postfix_admin show [example.com | admin@example.com | user@example.com]  # Display details about domains, admins, or accounts
  postfix_admin summary [example.com]                                      # Summarize the usage of PostfixAdmin
  postfix_admin teardown example.com                                       # Tear down a domain (delete a domain and an admin user for it)
  postfix_admin version                                                    # Display the version of postfix_admin