repository·master·Indexed 22 days ago
https://github.com/postfixadmin/postfixadminA web-based management interface for Postfix mail servers that allows administrators and users to manage domains, mailboxes, aliases, and quotas via SQLite, MySQL, or PostgreSQL backends. Features include support for DKIM storage, TOTP challenges, Application Specific Passwords, and integration with Dovecot, Courier, and Cyrus IMAP. Includes documentation on post-action hooks, Rspamd DKIM hooks, and a SquirrelMail plugin using the XMLRPC protocol.
The PostfixAdmin SquirrelMail plugin allows users to manage their email settings directly from within the SquirrelMail webmail interface. Users can perform the following tasks:
PostfixAdmin provides several administrative and user-facing features:
Virtual Vacation (an 'out of office' automated response) operates as a service within Postfix's master.cf configuration.
Workflow:
user#domain.com@autoreply.domain.com).@autoreply.domain.com domain is intercepted by the vacation.pl script.To prevent collisions with future PostfixAdmin updates, follow these naming conventions:
Extra fields in existing tables:
x_.x_ (or tablename_x_ on PostgreSQL).Extra tables:
x_.x_ (e.g., x_tablename_) because they are scoped to the schema.created, modified, and active columns to match core tables.You can add, modify, or remove fields from PostfixAdmin's built-in entities (domains, mailboxes, aliases, etc.) without modifying the core source code. This is achieved by using *_struct_hook configuration callbacks.
When a Handler is constructed, it looks for a configuration key named after its database table plus _struct_hook. If a valid function name is provided, the Handler passes its $struct array through that function. The Handler then automatically builds the SQL queries and the web UI (add, edit, and list forms) based on the modified $struct.
// Example of how the internal logic works
$struct_hook = Config::read($this->db_table . '_struct_hook');
if (!empty($struct_hook) && is_string($struct_hook) && $struct_hook != 'NO' && function_exists($struct_hook)) {
$this->struct = $struct_hook($this->struct);
}If PostfixAdmin does not natively support a specific format, you can use the dovecot:METHOD syntax. This instructs PostfixAdmin to use the doveadm system binary to generate the hash.
Pros:
Cons:
proc_open() to be enabled in PHP.doveadm to be installed and accessible by the web server.Example:
If in doubt, try dovecot:SHA512.
PostfixAdmin uses PHP files for translations, located in the languages/ directory with a .lang extension (e.g., languages/en.lang). The file languages/en.lang serves as the canonical English source.
Each translation file must start with <?php and contains an array of $PALANG assignments. Files must be UTF-8 encoded and may use htmlentities for special characters.
<?php
$PALANG['key'] = 'text';The plugin does not require direct access to the PostfixAdmin database. Instead, it communicates with PostfixAdmin using the XMLRPC protocol.
Security Requirement: Because the plugin uses XMLRPC, all traffic to the XMLRPC interface must be encrypted (e.g., via HTTPS). This encryption must be configured by the server administrator.
Handler classes extend PFAHandler and provide a standardized way to manage database entities. Creating a Handler automatically enables support for:
list.php: List and search views.edit.php: Create and edit forms.delete.php: Deletion logic.editactive.php: Toggling active status.postfixadmin-cli: Command-line interface access.list.php or edit.php creates the instance: new FooHandler($new, $username, $is_admin).initStruct() and initMsg(), and sets up $allowed_domains.init($id) loads the data. When saving, set($values) validates input, and save() writes to the database.save() executes preSave(), performs the SQL INSERT/UPDATE, and then executes postSave().getList($condition) triggers build_select_query() $\rightarrow$ read_from_db() $\rightarrow$ read_from_db_postprocess().PostfixAdmin is designed to work within a standard mail stack. It integrates with:
SQLite, MySQL, or PostgreSQL.Create a database for PostfixAdmin. Below are the command-line instructions for common database types:
MySQL/MariaDB
CREATE DATABASE postfix;
CREATE USER 'postfix'@'localhost' IDENTIFIED BY 'choose_a_password';
GRANT ALL PRIVILEGES ON `postfix` . * TO 'postfix'@'localhost';
FLUSH PRIVILEGES;PostgreSQL
CREATE USER postfix WITH PASSWORD 'whatever';
CREATE DATABASE postfix OWNER postfix ENCODING 'unicode';SQLite
Create a directory and a database file, ensuring the web server user (e.g., www-data) has write permissions to both:
mkdir /srv/postfixadmin/database
touch /srv/postfixadmin/database/postfixadmin.db
sudo chown -R www-data:www-data /srv/postfixadmin/database