https://github.com/zion-networks/mailcow-tools
Manage Mailcow instances via CLI
https://github.com/zion-networks/mailcow-tools
administration cli mailcow mailcow-dockerized mailserver tools
Last synced: over 1 year ago
JSON representation
Manage Mailcow instances via CLI
- Host: GitHub
- URL: https://github.com/zion-networks/mailcow-tools
- Owner: zion-networks
- License: mit
- Created: 2024-12-23T16:08:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-10T11:32:55.000Z (over 1 year ago)
- Last Synced: 2025-02-10T12:32:03.236Z (over 1 year ago)
- Topics: administration, cli, mailcow, mailcow-dockerized, mailserver, tools
- Language: Python
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailcow Tools
> [!NOTE]
> Mailcow Tools is still in very early development. A lot of features are still missing and the code structure is not final at all.
[Mailcow]([https://](https://mailcow.email/)) is a great option to run your very own mailserver. It comes with tons of features and one of them is the [REST API](https://mailcow.docs.apiary.io). The API is the counterpart of this tool.
Mailcow Tools allows you to manage any Mailcow instance right from the terminal. But it does not just map the REST routes to commands - it also comes with some handy additions, like batch creation of mailboxes.
### Getting started
1. Clone this repository: `git clone git@github.com:zion-networks/mailcow-tools.git`
2. Move to the directory: `cd mailcow-tools`
3. Make it a venv: `python3 -m venv .`
4. Activate the venv: `source bin/activate`
5. Install the required packages `pip install -r requirements.txt`
6. (Optional) Enable bash autocompletion: `source bash_autocomplete.sh`
7. Use it: `./mailcow-tools.sh help`
### Environment Variables
You can either create a `.env` file or use global environment variables. Currently, Mailcow Tools knows these environment variables:
- MAILCOW_TOOLS_MAILCOW_API_KEY=place-your-api-key-here (you can get your API key from your Mailcow web interface: https://mail.mymailcowhost.tld/admin)
- MAILCOW_TOOLS_MAILCOW_HOST=mail.mymailcowhost.tld
- MAILCOW_TOOLS_VALIDATE_CERTIFICATE=true (only use `false` if you really know, what you do)
- MAILCOW_TOOLS_LOG_LEVEL=INFO (Supported: `DEBUG`, `INFO`, `WARNING`, `ERROR`)
The `help` command will list you all available modules. Using `./mailcow-tools.sh help ` you can also see the help for a specific module.