vmail-manager 0.1

Handy cli interface to manage an vmail-sql-db.

vmail-manager

DISCLAIMER: THIS APPLICATION IS STILL IN ALPHA/BETA STATE. DO NOT USE IT IN PRODUCTIVE ENVIRONMENTS IF YOU DON'T WHAT YOU'RE DOING!

vmail-manager is a command line to for managing a mail-server database based on the great HowTo (german version) from Thomas Leister written in Python3.

Features

• manage the tables domains, accounts and aliases (tlspolicies support will maybe be added one day)
• supports multiple database backends (if your setup differs from the HowTo, i used postgresql instead of mariadb)

Installation

via pip

Install it with pip3 install vmail-manager

manually

Clone this git on your local machine and go into the directory.

Optional: Create a venv and activate it.

Install all requirements with pip3 install -r requirements.txt

Run the tool with ./vmail-manager.py (or add the folder to your path and create an alias to vmail-manager)

Usage

Use the command help to get started:

vmail-manager --help

Configuration

All config values stored in the config file can be overwritten with command line options.

Config files are formatted in YAML and loaded via confuse The paths for the config file are (dependent on the OS):

• macOS: ~/.config/vmail-manager/config.yaml and ~/Library/Application Support/vmail-manager/config.yaml
• Other Unix (Linux, BSD...): $XDG_CONFIG_HOME/vmail-manager/config.yaml and ~/.config/vmail-manager/config.yaml
• Windows: %APPDATA%\vmail-manager\config.yaml where the APPDATA environment variable falls back to %HOME%\AppData\Roaming if undefined

Some more paths are checked, if you wan't to store your config elsewhere look in the confuse documentation section about config paths.