malias/README.md

2.7 KiB

malias

malias is a helper for mailcow instances. You can create, delete, search and list aliases.

Installation

Download the latest release from https://gitlab.pm/rune/malias/releases. Unzip and move to a folder in you path (ease of use). I also recommend rename the file malias.py to just malias and make the file executable with chmod +x malias. To install required python modules run pip3 install -r requirements.txt

Usage

For instructions run

malias -h

Documentation

usage: malias [-h] [-c] [-s server APIKey] [-a alias@domain.com to@domain.com] [-f alias@domain.com] [-d alias@domain.com] [-t user@domain.com domain.com] [-w alias@domain.com] [-l] [-o] [-e] [-v]

Malias is an application for adding, creating, and deleting aliases on a Mailcow instance.

Use the issues section in the git repo for any problems or suggestions. https://gitlab.pm/rune/malias

options:
  -h, --help            show this help message and exit
  -c, --copy            Copy alias data from mailcow server to local DB.

  -s, --set server APIKey
                        Set connection information.

  -a, --add alias@domain.com to@domain.com
                        Add new alias.

  -f, --find alias@domain.com
                        Search for alias.

  -d, --delete alias@domain.com
                        Delete alias.

  -t, --timed user@domain.com domain.com
                        Add new time limited alias for user on domain.
                        The user@domain.com is where you want the alias to be delivered to.
                        The domain.com is which domain to use when creating the timed-alias.
                        One year validity

  -w alias@domain.com, --alias alias@domain.com
                        List timed (temprary) aliases connected toone account.

  -l, --list            List all aliases on the Mailcow instance.

  -o, --domains         List all mail domains on the Mailcow instance.

  -e, --export          List all mail domains on the Mailcow instance.

  -v, --version         Show current version and information


Making mailcow easier...

Plans

I'm also working on functionality for exporting and importing aliases. As of version 0.4 there is an export and an import fucntion that is not active in the app. Hopefully they will be finnished some day...

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Support

If you found a bug or you have suggestion for new features create an issue.

License