[Web][Postfix] Add mail policies: per-recipient send/receive rules for mailboxes and groups

This commit is contained in:
FreddleSpl0it committed 2026-11-07 15:55:43 +01:00
1 parent 329bca1d46
commit 4484cfcd42
36 files changed
+2677 -42

No files matched your search

@@ -0,0 +1,91 @@
<?php
declare(strict_types=1);
namespace Mailcow\MailPolicy\Repository;
use Mailcow\Core\Repository;
use Mailcow\MailPolicy\Model\Policy;
/**
* Read-only lookups of the policy check: mailboxes, alias domains, groups and the active policies of a mailbox
* or group. Addresses are passed in lower case.
*/
class LookupRepository extends Repository
{
/** @return array{username: string, domain: string}|null a regular mailbox that is not disabled */
public function mailbox(string $username): ?array
{
$row = $this->query("SELECT `username`, `domain` FROM `mailbox` WHERE `username` = :username AND `kind` = '' AND `active` != '0'",
['username' => $username])->fetch();
return is_array($row) ? ['username' => strtolower((string)$row['username']), 'domain' => strtolower((string)$row['domain'])] : null;
}
/** Target domain of an active alias domain */
public function aliasDomainTarget(string $domain): ?string
{
$target = $this->query("SELECT `target_domain` FROM `alias_domain` WHERE `alias_domain` = :domain AND `active` = '1'",
['domain' => $domain])->fetchColumn();
return is_string($target) ? strtolower($target) : null;
}
/** A domain or alias domain of this mailcow */
public function isLocalDomain(string $domain): bool
{
return (bool)$this->query("SELECT 1 FROM `domain` WHERE `domain` = :d1 UNION SELECT 1 FROM `alias_domain` WHERE `alias_domain` = :d2",
['d1' => $domain, 'd2' => $domain])->fetchColumn();
}
/** Active group with this distribution address */
public function groupByAddress(string $address): ?int
{
$id = $this->query("SELECT `id` FROM `mailbox_group` WHERE `address` = :address AND `active` = '1'", ['address' => $address])->fetchColumn();
return ($id === false) ? null : (int)$id;
}
public function groupAddress(int $id): ?string
{
$address = $this->query("SELECT `address` FROM `mailbox_group` WHERE `id` = :id AND `active` = '1'", ['id' => $id])->fetchColumn();
return is_string($address) && $address !== '' ? strtolower($address) : null;
}
public function isGroupMember(int $groupId, string $username): bool
{
return (bool)$this->query("SELECT 1 FROM `mailbox_group_member` WHERE `group_id` = :id AND `username` = :username",
['id' => $groupId, 'username' => $username])->fetchColumn();
}
/** Domain of an active alias that only accepts mail from its own domain (alias and group flag `internal`) */
public function internalAlias(string $address): ?string
{
$domain = $this->query("SELECT `domain` FROM `alias` WHERE `address` = :address AND `internal` = '1' AND `active` = '1'",
['address' => $address])->fetchColumn();
return is_string($domain) ? strtolower($domain) : null;
}
/** @return Policy[] active policies of the mailbox: assigned to it or to an active group it is a member of */
public function policiesForMailbox(string $username): array
{
return $this->policies("SELECT DISTINCT `p`.* FROM `mail_policy` `p`
JOIN `mail_policy_member` `pm` ON `pm`.`policy_id` = `p`.`id`
WHERE `p`.`active` = '1' AND (`pm`.`username` = :u1 OR `pm`.`group_id` IN (
SELECT `gm`.`group_id` FROM `mailbox_group_member` `gm` JOIN `mailbox_group` `g` ON `g`.`id` = `gm`.`group_id`
WHERE `gm`.`username` = :u2 AND `g`.`active` = '1'))
ORDER BY `p`.`id`", ['u1' => $username, 'u2' => $username]);
}
/** @return Policy[] active policies assigned to the group */
public function policiesForGroup(int $groupId): array
{
return $this->policies("SELECT DISTINCT `p`.* FROM `mail_policy` `p`
JOIN `mail_policy_member` `pm` ON `pm`.`policy_id` = `p`.`id`
WHERE `p`.`active` = '1' AND `pm`.`group_id` = :id
ORDER BY `p`.`id`", ['id' => $groupId]);
}
/** @return Policy[] */
private function policies(string $sql, array $params): array
{
return array_map(fn(array $row): Policy => Policy::fromRow($row), $this->query($sql, $params)->fetchAll());
}
}
@@ -0,0 +1,128 @@
<?php
declare(strict_types=1);
namespace Mailcow\MailPolicy\Repository;
use Mailcow\Core\Context;
use Mailcow\Core\Repository;
use Mailcow\MailPolicy\Model\Policy;
use PDO;
/**
* Tables `mail_policy` and `mail_policy_member` (the mailboxes and groups a policy is assigned to), plus the
* lookups the editing needs. Assignments go with their mailbox, group or domain (foreign keys, ON DELETE CASCADE).
*/
class PolicyRepository extends Repository
{
public function find(int $id): ?Policy
{
$row = $this->query("SELECT * FROM `mail_policy` WHERE `id` = :id", ['id' => $id])->fetch();
return is_array($row) ? $this->withMembers(Policy::fromRow($row)) : null;
}
/**
* @param string[] $domains limit to these domains, [] = all visible
* @return int[] ids of the policies visible to the caller, ordered by domain and name
*/
public function visibleIds(Context $context, array $domains = []): array
{
if ($context->hasAdminRights()) {
[$visible, $params] = ['1=1', []];
} elseif ($context->isDomainAdmin()) {
[$visible, $params] = ["`domain` IN (SELECT `domain` FROM `domain_admins` WHERE `active` = '1' AND `username` = :vis_da)",
['vis_da' => $context->username]];
} else {
return [];
}
$sql = "SELECT `id` FROM `mail_policy` WHERE $visible";
if (!empty($domains)) {
$names = [];
foreach (array_values($domains) as $i => $domain) {
$names[] = ':dom' . $i;
$params['dom' . $i] = $domain;
}
$sql .= " AND `domain` IN (" . implode(', ', $names) . ")";
}
return array_map('intval', $this->query($sql . " ORDER BY `domain`, `name`", $params)->fetchAll(PDO::FETCH_COLUMN));
}
public function nameExists(string $domain, string $name, ?int $exceptId = null): bool
{
return (bool)$this->query("SELECT 1 FROM `mail_policy` WHERE `domain` = :domain AND `name` = :name AND `id` != :id",
['domain' => $domain, 'name' => $name, 'id' => $exceptId ?? 0])->fetchColumn();
}
/** Inserts or updates the policy with its assignments; returns its id */
public function save(Policy $policy): int
{
return $this->transaction(function () use ($policy): int {
if ($policy->id === null) {
$policy->id = $this->insertRow('mail_policy', $policy->toRow());
} else {
$this->updateRow('mail_policy', $policy->id, $policy->toRow());
$this->query("DELETE FROM `mail_policy_member` WHERE `policy_id` = :id", ['id' => $policy->id]);
}
foreach ($policy->mailboxes as $username) {
$this->insertRow('mail_policy_member', ['policy_id' => $policy->id, 'username' => $username]);
}
foreach ($policy->groups as $groupId) {
$this->insertRow('mail_policy_member', ['policy_id' => $policy->id, 'group_id' => $groupId]);
}
return $policy->id;
});
}
public function delete(int $id): void
{
$this->query("DELETE FROM `mail_policy` WHERE `id` = :id", ['id' => $id]);
}
/** A primary domain (policies never belong to alias domains) */
public function isDomain(string $domain): bool
{
return (bool)$this->query("SELECT 1 FROM `domain` WHERE `domain` = :domain", ['domain' => $domain])->fetchColumn();
}
/** Domain of a regular mailbox, null if there is none */
public function mailboxDomain(string $username): ?string
{
$domain = $this->query("SELECT `domain` FROM `mailbox` WHERE `username` = :username AND `kind` = ''", ['username' => $username])->fetchColumn();
return is_string($domain) ? $domain : null;
}
public function groupDomain(int $id): ?string
{
$domain = $this->query("SELECT `domain` FROM `mailbox_group` WHERE `id` = :id", ['id' => $id])->fetchColumn();
return is_string($domain) ? $domain : null;
}
/** @return array[] id, name, domain, address of the groups in these domains (choices of the forms) */
public function groupsIn(array $domains): array
{
if (empty($domains)) {
return [];
}
$names = [];
$params = [];
foreach (array_values($domains) as $i => $domain) {
$names[] = ':dom' . $i;
$params['dom' . $i] = $domain;
}
return $this->query("SELECT `id`, `name`, `domain`, `address` FROM `mailbox_group` WHERE `domain` IN (" . implode(', ', $names) . ")
ORDER BY `domain`, `name`", $params)->fetchAll();
}
private function withMembers(Policy $policy): Policy
{
foreach ($this->query("SELECT `username`, `group_id` FROM `mail_policy_member` WHERE `policy_id` = :id ORDER BY `username`, `group_id`",
['id' => $policy->id])->fetchAll() as $row) {
if ($row['username'] !== null) {
$policy->mailboxes[] = (string)$row['username'];
} elseif ($row['group_id'] !== null) {
$policy->groups[] = (int)$row['group_id'];
}
}
return $policy;
}
}