mirrors/postfixadmin
1
0
Fork 0
mirror of https://github.com/postfixadmin/postfixadmin.git synced 2026-01-27 02:31:21 +00:00
Code Issues Projects Releases Packages Wiki Activity
PostfixAdmin - web based virtual user administration interface for Postfix mail servers https://postfixadmin.github.io/postfixadmin
3,338 commits 12 branches 66 tags 19 MiB
  • PHP 76.5%
  • Smarty 11.2%
  • Perl 7.1%
  • Shell 3.8%
  • Python 0.7%
  • Other 0.7%
Find a file
Exact
David Goodwin 2af9f9b829
 Merge pull request #977 from csware/domain-new-alias 
Include domain in link to create new alias
2026-01-26 19:08:01 +00:00
.github/workflows move to use ubuntu 24.04 for github actions 2025-08-30 10:34:09 +01:00
ADDITIONS mailbox_remover.pl: whitespace fix 2025-10-09 21:57:13 +02:00
configs manaul merge in of verdigado:master (see #753) (MFA/TOTP support) 2023-12-23 17:05:52 +00:00
debian remove more references to sourceforge 2025-07-13 18:29:37 +01:00
DOCUMENTS Update HASHING.md 2025-05-28 09:41:22 +01:00
languages see #949 - possible bulgarian translation fix, thanks @Saentist 2025-11-12 16:26:52 +00:00
model Check for address validity before checking domain existence 2026-01-25 16:29:58 +01:00
public fix issues from merging #958 - no longer provide smtp_password to smtp_mail(..) call, as it does it internally now 2026-01-01 13:40:17 +00:00
scripts scripts/postfixadmin-cli.php : see #385 - add to the current error reporting level, not trample all over it 2025-08-27 08:51:03 +01:00
templates use $fDomain variable, if present, for the domain= links for Add Forward/Domain etc 2026-01-26 11:45:07 +00:00
tests remove reference to _pacrypt_crypt (deadcode) 2025-06-01 15:57:58 +01:00
VIRTUAL_VACATION Move noreply to conf definable variable 2025-08-19 18:33:46 +01:00
.gitignore Add Domain Key handling 2022-06-23 20:40:06 +02:00
.php-cs-fixer.dist.php PSR2 -> PSR12 formatting 2022-06-28 13:46:11 +01:00
CHANGELOG.TXT update changelog 2025-09-12 21:04:58 +01:00
common.php allow the TOTP qr code to render (relax Content Security Policy to allow img-src: self data) 2025-06-11 21:24:25 +01:00
composer-update.sh I know people say not to add vendor/ to git, but this is the --no-dev variant, and it should handle autoloading too ... 2021-10-22 22:29:26 +01:00
composer.json zf1 should be a required library, given it is required for the xmlrpc functionality 2025-09-13 20:05:32 +01:00
config.inc.php Add smtp_username to email configuration 2025-12-19 17:23:01 -03:00
functions.inc.php No need to specify charset in connection string and then set it explicitly using "SET NAMES" again 2026-01-25 11:20:57 +01:00
GPL-LICENSE.TXT Initial Import in SourceForge 2007-03-24 07:27:00 +00:00
index.php Add a index.php showing a note about the "public" directory 2018-04-26 21:33:11 +02:00
install.sh beautify 2025-05-31 13:53:27 +01:00
INSTALL.TXT docs(install): fix a typo for unarchived dir (#828) 2024-05-12 10:00:58 +01:00
LICENSE.TXT LICENSE.TXT: 2011-04-24 16:15:21 +00:00
password_expiration.sql rename sql fields to just have mailbox.password_expiry and domain.password_expiry 2018-08-28 21:19:56 +01:00
phpunit.xml fix path 2021-06-11 22:18:20 +01:00
postfixadmin.my.cnf Better (aka safer) way to deal with authentication 2018-08-17 22:15:02 +02:00
psalm.xml manaul merge in of verdigado:master (see #753) (MFA/TOTP support) 2023-12-23 17:05:52 +00:00
README.md capitalisation 2025-09-13 20:12:50 +01:00
SECURITY.md Create SECURITY.md 2021-08-02 20:27:17 +01:00

README.md

GitHubBuild Coverage Status GitHub repo size IRC Chat - #postfixadmin

PostfixAdmin

An open source, web based interface for managing domains/mailboxes/aliases etc on a Postfix based mail server.

Integrates with :

  • Postfix
  • IMAP/POP3 server (e.g. Dovecot or Courier)
  • Database backend (choose one of: SQLite, MySQL or PostgreSQL)
  • Fetchmail (optional)

Features

  • Unlimited domains/aliases/mailboxes
  • Optional storage quota support
  • Optional password expiry (beta)
  • Multiple password hashing formats
  • Supports PostgreSQL, MySQL, MariaDB, SQLite database backends (choose one)
  • Supports retrieval of mail from a remote POP3 server (via fetchmail)
  • Vacation / Autoresponder / Out Of Office support
  • Users can login, change their password and/or setup a vacation (out of office) auto responder.
  • Integration with Squirrelmail or Roundcube (via plugins)
  • Optional XMLRPC based API
  • Supports TOTP challenges (and optional IP address based exemptions) for login
  • Supports Application Specific Passwords (where you can have multiple passwords for a mailbox - e.g. one for your mobile device, and a different one for your desktop)
  • Supports Domain Key (DKIM) storage

Some screenshots of Postfixadmin in action (as admin and user)

Hosting Requirements

  • Requires PHP 7.4+
  • Database (MySQL, PostgreSQL or Sqlite)
  • Requires Apache / Nginx webserver (that's capable of integration with PHP)

Releases

  • While you can install PostfixAdmin from 'git' using the 'master' branch, 'master' is our main development version. It may work. It may contain funky new exciting stuff. It may "eat your data".
  • If you want an easy life, use a published release - see: https://github.com/postfixadmin/postfixadmin/releases or its branch (e.g. postfixadmin_3.3)
  • Latest significant changes should be listed in the appropriate CHANGELOG.TXT file.
  • From 2025/06 we should be using SemVer releases (e.g. 4.0.1-beta1, and not postfixadmin-4.0.1-beta1 for tags etc)
  • Before a new release, try to remember to edit config.inc.php and change the version variable. Also update db_min_version in functions.inc.php if there were changes in upgrade.php.

Development Notes

Github actions is configured to run unit tests, once something is appropriately pushed, or * run vendor/bin/phpunit tests (but this will not test against different PHP versions).

You should be able to use ACT (https://github.com/nektos/act) to run the tests locally, this will require docker etc.

  • composer format - should fix styling issues (spaces etc in the code)
  • composer psalm - should detect some obvious errors (e.g. a typo in a function name, referencing an invalid class etc)

Useful Links

Related Projects

  • https://github.com/aqeltech/Dockerised-GUI-Mailserver
  • https://github.com/mailserver2/mailserver mailserver2/mailserver is a simple and full-featured mail server build as a set of multiple docker images. Features: Postfix, PostfixAdmin, Dovecot, Rspamd, Clamav, Zeyple, Sieve, Fetchmail, Rainloop, Unbound/NSD, Træfik, {Let's Encrypt,custom,Self-signed Certificate} SSL, Supports PostgeSQL, MySQL, (beta) LDAP backends. Automated builds on DockerHub and Integration tests with Travis CI