0.0
There's a lot of open issues
A long-lived project that still receives updates
Command Line Tools for Postfix Admin
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 6.3.0
~> 13.2.1
~> 3.13.0
>= 0

Runtime

~> 6.1.7
~> 0.5
~> 1.3.1
 Project Readme

Gem Version

postfix_admin

Command Line Tools for Postfix Admin

Description

Requirements

  • Ruby 2.6 or higher
  • MySQL/MariaDB
  • Dovecot (required for setting passwords using the doveadm pw subcommand)

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