Stalwart Mail Alias Creation Script

uv venv && uv pip install pyperclip

import json
import os
import subprocess
import sys

import pyperclip

# --------------------

DOMAIN = "example.de"        # <--- Here your domain ending, like if your mail is 'admin@example.de', then example.de
HOSTNAME = "mail.example.de" # <--- your domain with the .mail prefix usually, where the server is actually running at
TOKEN = "API_AAA...."        # <---- Paste here your API Key
USERNAME = "admin"           # <---- the mailbox you usually use, like if it's admin@example.de, its admin,
                             #       if you use me@example.de as your mailbox, then enter 'me'
ALIAS_POSTFIX = ""           # <---- e.g. "-alias", if you want to have a default ending for every alias, e.g. 'al test' should
                             #       produce the alias 'test-alias@example.de' as alias mail

# --------------------

CACHE_FILE = ".stalwart-alias-cache.json"

# --------------------

# Usage: uv run create_alias.py <alias_prefix>
# or     uv run create_alias.py

# ------------

if not len(sys.argv) > 1:
    new_alias_prefix = input("alias: ")
else:
    new_alias_prefix = sys.argv[1]


user_id_cached = None
domain_id_cached = None

if os.path.isfile(CACHE_FILE):
    with open(CACHE_FILE, "r") as f:
        cache = json.load(f)
        if "users" in cache and USERNAME in cache["users"]:
            user_id_cached = cache["users"][USERNAME]

        if "domains" in cache and DOMAIN in cache["domains"]:
            domain_id_cached = cache["domains"][DOMAIN]


def run_stalwart_cmd(cmd, nojson=False):
    env = os.environ.copy()
    env["STALWART_URL"] = f"https://{HOSTNAME}"
    env["STALWART_TOKEN"] = TOKEN

    cmd = "stalwart-cli " + cmd

    if not nojson:
        cmd += " --json"

    # print(cmd)

    result = subprocess.check_output(
        cmd,
        env=env,
        shell=True,
        text=True,
    )

    if nojson:
        return result
    else:
        return json.loads(result)


if not user_id_cached:
    user_account = run_stalwart_cmd(
        f"query Account --where name={USERNAME} --fields id,name,emailAddress"
    )

    user_id = user_account["id"]
    print(f"[+] obtained user id: {user_id}")
else:
    user_id = user_id_cached
    print(f"[+] loaded user id from cache: {user_id}")


if not domain_id_cached:
    domain_id = run_stalwart_cmd(
        f"query Domain --fields id,name --where name={DOMAIN}"
    )["id"]
    print(f"[+] obtained domain id: {domain_id}")
else:
    domain_id = domain_id_cached
    print(f"[+] loaded domain id from cache: {domain_id}")

user_aliases = run_stalwart_cmd(f"get Account {user_id} --fields aliases")["aliases"]


if len(list(map(int, list(user_aliases)))) == 0:
    new_alias_id = "0"
else:
    new_alias_id = str(max(list(map(int, list(user_aliases)))) + 1)
alias_list = [user_aliases[a]["name"] for a in user_aliases]


print(f"[+] obtained next alias id: {new_alias_id}")

new_alias = f"{new_alias_prefix}{ALIAS_POSTFIX}"

if new_alias in alias_list:
    print("[-] FAILURE: alias already exists! - exiting")
    exit()

print(f"[+] alias can be created: {new_alias}@{DOMAIN}")

alias_patch = {
    f"aliases/{new_alias_id}": {
        "enabled": True,
        "name": new_alias,
        "domainId": domain_id,
        "description": None,
    }
}

result = run_stalwart_cmd(
    "update Account " + user_id + " --json '" + json.dumps(alias_patch) + "'",
    nojson=True,
)

if result.startswith("Updated"):
    print("[+] created alias - copying to clipboard")

    cache = {"users": {USERNAME: user_id}, "domains": {DOMAIN: domain_id}}

    with open(CACHE_FILE, "w") as f:
        json.dump(cache, f, indent=4)

    pyperclip.copy(f"{new_alias}@{DOMAIN}")

else:
    print(f"[-] FAILURE: {result}")

# ...
alias al="uv run create_alias.py"