README.md

vmail-admin

CLI Tool for managing vmail databases

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

Prerequisites

Make sure you have a working setup as described in the tutorial as vmail-admin relies on the described database scheme (MySQL or MariaDB).

Further, as vmail-admin is written in Bash, you should have bash installed.

Installation

• Download vmail-admin.sh from github.

• Make it executable with "chmod +x vmail-admin.sh".

• Run it with "./vmail-admin.sh".

• Copy .creds.example over to .creds file and make your changes

Usage

You can change the parameters for the script under Definitions in the script. Start the script with:

./vmail-admin.sh

Note that you also can initialize the database with this tool.

Menu

Menu items are:

1. User Management
   1. Add user
   2. Delete user
   3. Change user password
   4. Change user quota
   5. Change autosent status #wether or not to auto bcc when sent from. Use this for accounts where emails are sent via smtp and not a IMAP client
   6. Back to main menu
2. Domain Management
   1. Add Domain
   2. Delete Domain
   3. Show users for domain
   4. Show all domains
   5. Back to main menu
3. Aliases Management
   1. Add alias
   2. Delete alias
   3. Show aliases for domain
   4. Show all aliases
   5. Back to main menu
4. Database Management
   1. Export database as sql.gz
   2. Import database from sql.gz
   3. Delete database
   4. Initialize database
   5. Back to main menu
5. Exit

How to contribute

Create new issues if you find bugs or want to add new features. Pull requests are very welcome.

License

Copyright (C) 2018 by Patrick Prugger