From 21fd17a4500a4feaa02bb75ab1251adac43280bc Mon Sep 17 00:00:00 2001 From: Charles D Date: Tue, 21 Apr 2026 16:20:35 -0400 Subject: [PATCH] Initialize README with mailalias tool information Add documentation for mailalias tool usage and alias model. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c7d7db5 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# mailalias - simple alias / catch-all management tool for iRedMail (MySQL/MariaDB) + +## Alias model used: +- alias table contains alias addresses +- forwardings contains destination rows for aliases with is_list=1 +- catch-all entries are stored in forwardings where address == domain + +### Examples: +```sh +mailalias alias-add contact@charlesdanesi.com charles@charlesdanesi.com +mailalias alias-remove admin@beyemir.com charles@beyemir.com +mailalias alias-lookup admin@charlesdanesi.com +mailalias alias-list +mailalias alias-list-user charles@danesisolutions.com + +mailalias catchall-add beyemir.com charles@beyemir.com +mailalias catchall-remove beyemir.com charles@beyemir.com +mailalias catchall-list +```