Postfixadmin-cli modified by Christian Boltz

Christian Boltz — Sat, 25 Oct 2014 21:21:25 -0000

Postfixadmin-CLI can be used to create mailbox users or aliases by command line. This offers the option to create mass creation scripts.

Postfixadmin-CLI only exists in the 3.0 (including 3.0 beta aka 2.9x) release. It is not part of the 2.3.x release.

Installation

Require right installed and configured Postfixadmin.

Installed by source

 chmod +x <path/to/postfixadmin/root>/scripts/postfixadmin-cli
 ln -s <path/to/postfixadmin/root>/scripts/postfixadmin-cli /usr/bin/postfixadmin-cli
 Call postfixadmin-cli

Installed by deb package

Simply call postfixadmin-cli

Commands

WARNING: This section is outdated.
Run "postfixadmin-cli help" for usage information.

Mailbox

Mailbox manages the users/mailboxes in Postfixadmin.

Command	Description	Notes
mailbox add --password <password> [--quota <quota>] [--name <name>] [...]	Adds a new user with mailbox.	See "mailbox add help" for all available options
		Note: if --password is not given, you'll get a autogenerated password (if enabled in the config)
mailbox update [same parameters as "add"]	Updates a mailbox. Only the specified parameters (for example --password) will be changed
[-qvp] => quiet mode/verbose mode/print mode
mailbox delete [-qvp]	Deletes a mailbox.
[-qvp] => quiet mode/verbose mode/print mode
Dev. question: for security add accept switch(-a)?

Alias

Alias manages the aliases in Postfixadmin

Command	Description	Notes
alias add <alias address=""> <forward to=""> [-qvp]	Adds a new alias.	[-qvp] => quiet mode/verbose mode/print mode
forward to can be a comma separated list
alias update [-qvp] !Not implemented yet!	Updates a alias.	[-qvp] => quiet mode/verbose mode/print mode
alias delete [-qvp] !Not implemented yet! Need Work	Deletes a alias.	[-qvp] => quiet mode/verbose mode/print mode

Domain

Domain manages the domains in Postfixadmin.

Command	Description	Notes
domain view <domain>	View an existing domain.
domain add <domain> <number of="" aliases=""> <number of="" mailboxes=""> <max. quota=""> <transport> [<description>] [-qvp] [-b] [-d]	Adds a domain.	[-qvp] => quiet mode/verbose mode/print mode
		[-b] => backup MX
		[-d] => create default aliases
domain update !Not implemented yet!	Updates an domain.	[-qvp] => quiet mode/verbose mode/print mode
domain delete <domain> [-qvp]	Deletes a domain.	[-qvp] => quiet mode/verbose mode/print mode

version prints the version of Postfixadmin and Postfixadmin-CLI

Modes

Postfixadmin-CLI offers 3 different kind of modes.
These are:

Quiet Mode
Verbose Mode
Print Mode

Quiet Mode

Quiet mode is simply what the name says quiet. This means postfixadmin-cli prints no error messages.

Verbose Mode

Verbose mode prints some more status messages, etc.

Print Mode

In print mode Postfixadmin-CLI prints, if the command was successful, a user friendly message for usage emails or something different.

Recent changes to Postfixadmin-cli