Refactor and bumped to version 2.0

This commit is contained in:
2025-03-03 13:57:02 +01:00
parent d65a127c6d
commit 59cdf3c856
3 changed files with 415 additions and 530 deletions

View File

@@ -17,51 +17,49 @@ malias -h
## Documentation
```bash
usage: malias [-h] [-k APIkey] [-s alias@domain.com] [-m mailcow-server.tld]
[-a alias@domain.com to@domain.com]
[-t user@domain.com domain.com] [-d alias@domain.com]
[-i alias.json] [-v] [-c] [-l] [-o]
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] [-l] [-o] [-e] [-v]
This is a simple application to help you create and delete aliases on a mailcow instance.
If you find any issues or would like to submit a PR - please head over to https://gitlab.pm/rune/malias.
Malias is an application for adding, creating, and deleting aliases on a Mailcow instance.
I hope this makes your mailcow life a bit easier!
Use the issues section in the git repo for any problems or suggestions. https://gitlab.pm/rune/malias
optional arguments:
options:
-h, --help show this help message and exit
-k APIkey, --api APIkey
Add/Change API key.
-s alias@domain.com, --search alias@domain.com
Search for alias.
-m mailcow-server.tld, --server mailcow-server.tld
Add/Uppdate mailcow instance.
-a alias@domain.com to@domain.com, --add alias@domain.com to@domain.com
Add new alias.
-t user@domain.com domain.com, --timed user@domain.com domain.com
Add new time limited alias for user on domain. One year validity
-d alias@domain.com, --delete alias@domain.com
Delete alias.
-v, --version Show current version and information
-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
-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...
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