Compare commits

..

25 Commits
0.1 ... main

Author SHA1 Message Date
2e85eb7b8b Work In Progress (WIP) 2024-05-21 12:37:11 +02:00
390f1c8aeb Work In Progress (WIP) 2024-05-06 11:31:25 +02:00
30a37cd0c3 Removed outdated screenshot 2024-04-20 14:39:52 +02:00
948d19ebf3 README.md 2024-04-10 13:45:43 +02:00
9cc931c585 Added timed aliases and edited README.md 2024-04-10 13:40:00 +02:00
1c7dd7e44d Refind check for existing alias on server and in db 2023-11-09 12:02:11 +01:00
967390ddfa Update README.md 2023-10-03 10:24:33 +02:00
53ecb4302a Update README.md 2023-10-03 10:20:13 +02:00
e8d45fc477 Code cleanup, changed version check and updated search function 2023-10-03 10:15:50 +02:00
8000779fe8 Added app version checks. 2023-09-06 12:29:32 +02:00
8814127cf8 Added some functionality 2023-09-05 11:36:39 +02:00
f653a20d35 Added function updating local DB from aliases on Mailcow instance 2023-09-04 15:12:57 +02:00
7f12bd3743 Added function for listing mail domains 2023-09-01 11:22:54 +02:00
8a6eceb9a5 Added some small fixes and some pepper 2023-08-20 15:53:43 +02:00
2bd8ddeb04 Update README.md 2023-08-13 18:32:35 +02:00
f3ba4f7d67 Update README.md 2023-08-13 18:31:49 +02:00
37d670b54e Added screenshot 2023-08-13 18:30:16 +02:00
12215074d6 Changes in list function 2023-04-19 08:49:22 +02:00
15e8f8ac90 Changes in list function 2023-04-19 08:04:44 +02:00
0e1a5d7314 Fixed error in a function 2023-04-18 14:41:11 +02:00
5d1c11d42d remove .DS_Store 2023-04-17 14:04:53 +02:00
d461290730 remove .DS_Store 2023-04-17 14:04:24 +02:00
38261bb0a2 Better search function 2023-04-17 14:02:58 +02:00
01c158db6d Merge branch 'main' of https://gitlab.pm/rune/malias 2023-04-16 19:07:35 +02:00
7f7c562455 Refined search function 2023-04-16 19:07:01 +02:00
4 changed files with 406 additions and 68 deletions

6
.gitignore vendored
View File

@ -1 +1,5 @@
list_alias.py list_alias.py
malias.zip
malias_local.py
*.json
.DS_Store

View File

@ -4,7 +4,7 @@ _malias_ is a helper for mailcow instances. You can create, delete, search and l
## Installation ## Installation
Download the latest relase from https://gitlab.pm/rune/malias/releases. Unzip and move to a folder in you path (ease of use). You can also 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``` Download the latest release from [https://gitlab.pm/rune/malias/releases](https://iurl.no/release). 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 ## Usage
@ -14,6 +14,55 @@ For instructions run
malias -h 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]
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.
I hope this makes your mailcow life a bit easier!
optional arguments:
-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.
-l, --list List all aliases on the Mailcow instance.
-o, --domains List all mail domains on the Mailcow instance.
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 ## Contributing
Pull requests are welcome. For major changes, please open an issue first Pull requests are welcome. For major changes, please open an issue first

412
malias.py
View File

@ -10,13 +10,14 @@ import requests
import os import os
import time import time
import sys import sys
import git
from types import SimpleNamespace from types import SimpleNamespace
from datetime import datetime from datetime import datetime
from string import ascii_letters, digits from string import ascii_letters, digits
from rich import print from rich import print
from argparse import RawTextHelpFormatter from argparse import RawTextHelpFormatter
#from urllib import Request, urlopen
from urllib.request import urlopen from urllib.request import urlopen
from operator import itemgetter
# Info pages for dev # Info pages for dev
# https://mailcow.docs.apiary.io/#reference/aliases/get-aliases/get-aliases # https://mailcow.docs.apiary.io/#reference/aliases/get-aliases/get-aliases
@ -29,7 +30,25 @@ database = filepath.joinpath('malias.db')
logfile = filepath.joinpath('malias.log') logfile = filepath.joinpath('malias.log')
Path(filepath).mkdir(parents=True, exist_ok=True) Path(filepath).mkdir(parents=True, exist_ok=True)
logging.basicConfig(filename=logfile,level=logging.INFO,format='%(message)s') logging.basicConfig(filename=logfile,level=logging.INFO,format='%(message)s')
app_version = '0.1' app_version = '0.4'
db_version = '0.2'
def get_latest_release():
req = urllib.request.Request('https://gitlab.pm/api/v1/repos/rune/malias/releases/latest')
req.add_header('Content-Type', 'application/json')
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
return remoteData['tag_name']
def release_check():
latest_release = get_latest_release()
if app_version != latest_release:
print('[b]New version available @ [i]https://iurl.no/malias[/b][/i]')
else:
print ('You have the the latest version. Version: %s' %(app_version))
def connect_database(): def connect_database():
@ -57,13 +76,18 @@ def connect_database():
alias text NOT NULL, alias text NOT NULL,
goto text NOT NULL, goto text NOT NULL,
created text NOT NULL)''') created text NOT NULL)''')
c.execute('''CREATE TABLE IF NOT EXISTS timedaliases
(id integer NOT NULL PRIMARY KEY,
alias text NOT NULL,
goto text NOT NULL,
validity text NOT NULL)''')
conn.commit() conn.commit()
first_run(conn) first_run(conn)
return conn return conn
def first_run(conn): def first_run(conn):
now = datetime.now().strftime("%m-%d-%Y %H:%M") now = datetime.now().strftime("%m-%d-%Y %H:%M")
cursor = conn.cursor() cursor = conn.cursor()
@ -76,12 +100,12 @@ def first_run(conn):
conn.commit() conn.commit()
return None return None
def get_settings(kind): def get_settings(kind):
cursor = conn.cursor() cursor = conn.cursor()
cursor.execute('SELECT * FROM settings') cursor.execute('SELECT * FROM settings')
data = cursor.fetchall() data = cursor.fetchall()
first_run_status = data[0][1] first_run_status = data[0][1]
mail_server = data[0][2] mail_server = data[0][2]
copy_status = data[0][3] copy_status = data[0][3]
@ -95,10 +119,11 @@ def get_settings(kind):
return first_run_status return first_run_status
if kind == 'copy_status': if kind == 'copy_status':
return copy_status return copy_status
def get_api(): def get_api():
latest_release = get_latest_release()
cursor = conn.cursor() cursor = conn.cursor()
cursor.execute('SELECT api FROM apikey') cursor.execute('SELECT api FROM apikey')
apikey = cursor.fetchone()[0] apikey = cursor.fetchone()[0]
@ -107,27 +132,53 @@ def get_api():
exit(0) exit(0)
else: else:
return apikey return apikey
def set_mailserver(server): def set_mailserver(server):
now = datetime.now().strftime("%m-%d-%Y %H:%M") now = datetime.now().strftime("%m-%d-%Y %H:%M")
cursor = conn.cursor() cursor = conn.cursor()
cursor.execute('UPDATE settings SET server = ? WHERE id = 1',(server,)) cursor.execute('UPDATE settings SET server = ? WHERE id = 1',(server,))
logging.info(now + ' - Info : mailcow server updated') logging.info(now + ' - Info : mailcow server updated')
print('Your mail server has been updated.') print('Your mail server has been updated.')
conn.commit() conn.commit()
def apikey(key): def apikey(key):
now = datetime.now().strftime("%m-%d-%Y %H:%M") now = datetime.now().strftime("%m-%d-%Y %H:%M")
cursor = conn.cursor() cursor = conn.cursor()
cursor.execute('UPDATE apikey SET api = ? WHERE id = 1',(key,)) cursor.execute('UPDATE apikey SET api = ? WHERE id = 1',(key,))
logging.info(now + ' - Info : API key updated') logging.info(now + ' - Info : API key updated')
print('Your API key has been updated.') print('Your API key has been updated.')
conn.commit() conn.commit()
def get_mail_domains(info):
apikey = get_api()
cursor = conn.cursor()
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/domain/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
if info:
total_aliases = 0
i=0
print('\n[b]malias[/b] - All email domains on %s' %(mail_server))
print('==================================================================')
for domains in remoteData:
cursor.execute('SELECT count(*) FROM aliases where alias like ? or goto like ?', ('%'+remoteData[i]['domain_name']+'%','%'+remoteData[i]['domain_name']+'%',))
count = cursor.fetchone()[0]
total_aliases += count
print('%s \t\twith %s aliases' %(remoteData[i]['domain_name'],count))
i+=1
print('\n\nThere is a total of %s domains with %s aliases.' %(str(i),str(total_aliases)))
else:
return(remoteData)
def create(alias,to_address): def create(alias,to_address):
now = datetime.now().strftime("%m-%d-%Y %H:%M") now = datetime.now().strftime("%m-%d-%Y %H:%M")
server = get_settings('mail_server') server = get_settings('mail_server')
@ -140,7 +191,7 @@ def create(alias,to_address):
data = {'address': alias,'goto': to_address,'active': "1"} data = {'address': alias,'goto': to_address,'active': "1"}
headers = {'X-API-Key': apikey, "Content-Type": "application/json"} headers = {'X-API-Key': apikey, "Content-Type": "application/json"}
response = requests.post('https://'+server+'/api/v1/add/alias', response = requests.post('https://'+server+'/api/v1/add/alias',
data=json.dumps(data), headers=headers) data=json.dumps(data), headers=headers)
mail_id = alias_id(alias) mail_id = alias_id(alias)
if mail_id == None: if mail_id == None:
logging.error(now + ' - Error : alias %s not created on the mailcow instance %s ' %(alias,server)) logging.error(now + ' - Error : alias %s not created on the mailcow instance %s ' %(alias,server))
@ -151,8 +202,33 @@ def create(alias,to_address):
conn.commit() conn.commit()
logging.info(now + ' - Info : alias %s created for %s on the mailcow instance %s ' %(alias,to_address,server)) logging.info(now + ' - Info : alias %s created for %s on the mailcow instance %s ' %(alias,to_address,server))
print('\n[b]Info[/b] : alias %s created for %s on the mailcow instance %s \n' %(alias,to_address,server)) print('\n[b]Info[/b] : alias %s created for %s on the mailcow instance %s \n' %(alias,to_address,server))
def create_timed(username,domain):
now = datetime.now().strftime("%m-%d-%Y %H:%M")
server = get_settings('mail_server')
apikey = get_api()
data = {'username': username,'domain': domain}
headers = {'X-API-Key': apikey, "Content-Type": "application/json"}
response = requests.post('https://'+server+'/api/v1/add/time_limited_alias',
data=json.dumps(data), headers=headers)
response_data = response.json()
if response_data[0]['type'] == 'danger':
if response_data[0]['msg'] == 'domain_invalid':
print('\n[b]Error[/b] : the domain %s is invalid for %s \n' %(domain, server))
if response_data[0]['msg'] == 'access_denied':
print('\n[b]Error[/b] : the server %s responded with [red]Access Denied[/red]\n' %(server))
else:
alias = get_last_timed(username)
validity = datetime.utcfromtimestamp(alias['validity']).strftime('%d-%m-%Y %H:%M')
print('The timed alias %s was created. The alias is valid until %s UTC\n' %(alias['address'], validity))
cursor = conn.cursor()
cursor.execute('INSERT INTO timedaliases values(?,?,?,?)', (alias['validity'],alias['address'],username,validity))
conn.commit()
logging.info(now + ' - Info : timed alias %s created for %s and valid too %s UTC on the mailcow instance %s ' %(alias['address'],username,validity,server))
def delete_alias(alias): def delete_alias(alias):
server = get_settings('mail_server') server = get_settings('mail_server')
@ -162,10 +238,8 @@ def delete_alias(alias):
data = {'id': the_alias_id} data = {'id': the_alias_id}
headers = {'X-API-Key': apikey, "Content-Type": "application/json"} headers = {'X-API-Key': apikey, "Content-Type": "application/json"}
response = requests.post('https://'+server+'/api/v1/delete/alias', response = requests.post('https://'+server+'/api/v1/delete/alias',
data=json.dumps(data), headers=headers) data=json.dumps(data), headers=headers)
response_data = response.json() response_data = response.json()
print(response_data)
exit(0)
if response_data[0]['type'] == 'success': if response_data[0]['type'] == 'success':
if check_local_db(the_alias_id) == 1: if check_local_db(the_alias_id) == 1:
now = datetime.now().strftime("%m-%d-%Y %H:%M") now = datetime.now().strftime("%m-%d-%Y %H:%M")
@ -186,6 +260,7 @@ def delete_alias(alias):
def copy_data(): def copy_data():
apikey = get_api() apikey = get_api()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
@ -202,16 +277,50 @@ def copy_data():
for data in remoteData: for data in remoteData:
cursor.execute('INSERT INTO aliases values(?,?,?,?)', (remoteData[i]['id'], remoteData[i]['address'],remoteData[i]['goto'],now)) cursor.execute('INSERT INTO aliases values(?,?,?,?)', (remoteData[i]['id'], remoteData[i]['address'],remoteData[i]['goto'],now))
i=i+1 i=i+1
cursor.execute('UPDATE settings SET data_copy = ? WHERE id = 1',(1,)) cursor.execute('UPDATE settings SET data_copy = ? WHERE id = 1',(1,))
conn.commit() conn.commit()
logging.info(now + ' - Info : aliases imported from the mailcow instance %s to local DB' %(mail_server)) logging.info(now + ' - Info : aliases imported from the mailcow instance %s to local DB' %(mail_server))
print('\n[b]Info[/b] : aliases imported from the mailcow instance %s to local DB\n' %(mail_server)) print('\n[b]Info[/b] : aliases imported from the mailcow instance %s to local DB\n' %(mail_server))
else: else:
print('\n[b]Info[/b] : aliases alreday imported from the mailcow instance %s to local DB\n' %(mail_server)) print('\n[b]Info[/b] : aliases alreday imported from the mailcow instance %s to local DB\n\n[i]Updating with any missing aliases![/i]' %(mail_server))
update_data()
def update_data():
apikey = get_api()
mail_server = get_settings('mail_server')
if get_settings('copy_status') == 1:
now = datetime.now().strftime("%m-%d-%Y %H:%M")
cursor = conn.cursor()
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
i = 0
count_alias = 0
cursor = conn.cursor()
for data in remoteData:
cursor.execute('SELECT count(*) FROM aliases where alias like ? and goto like ?', (remoteData[i]['address'],remoteData[i]['goto'],))
count = cursor.fetchone()[0]
if count >= 1 :
i+=1
else:
cursor.execute('INSERT INTO aliases values(?,?,?,?)', (remoteData[i]['id'], remoteData[i]['address'],remoteData[i]['goto'],now))
count_alias+=1
i+=1
conn.commit()
if count_alias > 0:
logging.info(now + ' - Info : Local DB updated with %s new aliases from %s ' %(str(count_alias),mail_server))
print('\n[b]Info[/b] : Local DB update with %s new aliases from %s \n' %(str(count_alias),mail_server))
else:
print('\n[b]Info[/b] : No missing aliases from local DB \n')
def checklist(alias): def checklist(alias):
alias_exist = None
apikey = get_api() apikey = get_api()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all') req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
@ -222,14 +331,21 @@ def checklist(alias):
remoteData = json.loads(remote) remoteData = json.loads(remote)
i = 0 i = 0
for search in remoteData: for search in remoteData:
if alias in remoteData[i]['address']: if alias == remoteData[i]['address'] || alias in remoteData[i]['goto']:
return True alias_exist = True
i=i+1 i=i+1
return None cursor = conn.cursor()
cursor.execute('SELECT count(*) FROM aliases where alias == ? or goto == ?', (alias,alias,))
count = cursor.fetchone()[0]
if count >= 1 :
alias_exist = True
return alias_exist
def list_alias(): def list_alias():
apikey = get_api() apikey = get_api()
cursor = conn.cursor()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all') req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json') req.add_header('Content-Type', 'application/json')
@ -238,13 +354,21 @@ def list_alias():
remote = current.read().decode('utf-8') remote = current.read().decode('utf-8')
remoteData = json.loads(remote) remoteData = json.loads(remote)
i = 0 i = 0
print('\n[b]malias[/b] - All aliases on %s' %(mail_server)) l = 0
print('===================================================') print('\n[b]malias[/b] - All aliases on %s ([b]*[/b] also in local db)' %(mail_server))
print('==================================================================')
for search in remoteData: for search in remoteData:
the_alias = remoteData[i]['address'].ljust(20,' ') the_alias = remoteData[i]['address'].ljust(20,' ')
print(the_alias + '\tgoes to\t\t' + remoteData[i]['goto']) the_goto = remoteData[i]['goto'].ljust(20,' ')
cursor.execute('SELECT count(*) FROM aliases where alias like ? or goto like ?', (remoteData[i]['address'],remoteData[i]['address'],))
count = cursor.fetchone()[0]
if count >= 1:
print(the_alias + '\tgoes to\t\t' + the_goto + '\t[b]*[/b]')
l=l+1
else:
print(the_alias + '\tgoes to\t\t' + the_goto)
i=i+1 i=i+1
print('\n\nTotal number of aliases %s on instance [b]%s[/b] and %s on [b]local DB[/b].' %(str(i),mail_server,str(l)))
def alias_id(alias): def alias_id(alias):
@ -264,6 +388,19 @@ def alias_id(alias):
return None return None
def get_last_timed(username):
apikey = get_api()
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/time_limited_aliases/%s' %username)
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
remoteData.sort(key = itemgetter('validity'), reverse=True)
return (remoteData[0])
def number_of_aliases_in_db(): def number_of_aliases_in_db():
cursor = conn.cursor() cursor = conn.cursor()
cursor.execute('SELECT count(*) FROM aliases') cursor.execute('SELECT count(*) FROM aliases')
@ -283,77 +420,213 @@ def number_of_aliases_on_server():
remoteData = json.loads(remote) remoteData = json.loads(remote)
return len(remoteData) return len(remoteData)
def check_local_db(alias_id): def check_local_db(alias_id):
cursor = conn.cursor() cursor = conn.cursor()
cursor.execute('SELECT count(*) FROM aliases where id = ?',(alias_id,)) cursor.execute('SELECT count(*) FROM aliases where id = ?',(alias_id,))
count = cursor.fetchone()[0] count = cursor.fetchone()[0]
return count return count
def search(alias): def search(alias):
results = checklist(alias) apikey = get_api()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
if results == True: alias_server = number_of_aliases_on_server()
print('\n\nThe mail address %s exists. Using the mailcow instance : %s\n\n'%(alias,mail_server)) alias_db = number_of_aliases_in_db()
else: cursor = conn.cursor()
print('\n\nThe mail address %s [b]does not[/b] exists. Using the mailcow instance : %s\n\n'%(alias,mail_server)) cursor.execute('SELECT data_copy FROM settings where id = 1')
result = cursor.fetchone()[0]
if result == 1:
search_term = '%'+alias+'%'
cursor.execute('SELECT * from aliases where alias like ? or goto like ?',(search_term,search_term,))
remoteData = cursor.fetchall()
i = 0
print('\nAliases on %s that contains [b]%s[/b]' %(mail_server,alias))
print('=================================================================')
for search in remoteData:
the_alias = remoteData[i][1].ljust(20,' ')
print(the_alias + '\tgoes to\t\t' + remoteData[i][2])
i=i+1
print('\n\nData from local DB')
else:
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
i = 0
print('\nAliases on %s that contains [b]%s[/b]' %(mail_server,alias))
print('=================================================')
for search in remoteData:
if alias in remoteData[i]['address'] or alias in remoteData[i]['goto']:
print(remoteData[i]['address'] + '\tgoes to\t\t' + remoteData[i]['goto'])
i=i+1
print('\n\nData from server')
if alias_server != alias_db:
print('\n\nThere are %s aliases on the server and %s aliases in local DB' %(str(alias_server),str(alias_db)))
print('Run [i]malias -c[/i] to update local DB')
def get_mailcow_version():
apikey = get_api()
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/status/version')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
remote_heads = git.cmd.Git().ls_remote('https://github.com/mailcow/mailcow-dockerized', tags=True)
tags = remote_heads.splitlines()
for x in tags:
string = x.rsplit('/',2)
if remoteData['version'] != string[2]:
versionInfo = 'Your Mailcow version is %s and the latest is %s' %(remoteData['version'], string[2])
else:
versionInfo = 'You have the latest Mailcow version %s' %remoteData['version']
return (versionInfo)
def show_current_info(): def show_current_info():
API = get_api() API = get_api()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
latest_release = get_latest_release()
if API == 'DUMMY_KEY': if API == 'DUMMY_KEY':
API = 'Missing API Key!' API = 'Missing API Key!'
if mail_server == 'dummy.server': if mail_server == 'dummy.server':
mail_server = 'Missing address to mailcow instance!' mail_server = 'Missing address to mailcow instance!'
aliases_server = number_of_aliases_on_server() aliases_server = number_of_aliases_on_server()
alias_db = number_of_aliases_in_db() alias_db = number_of_aliases_in_db()
mailcow_version = get_mailcow_version()
print('\n[b]malias[/b] - Manage aliases on mailcow Instance.') mail_domains = get_mail_domains(False)
domain = ""
i=0
for domains in mail_domains:
if i!=0:
domain = domain + ', ' + str(mail_domains[i]['domain_name'])
else:
domain = domain + str(mail_domains[i]['domain_name'])
i+=1
print('\n[b]malias[/b] - Manage aliases on Mailcow instance.')
print('===================================================') print('===================================================')
print('API key : [b]%s[/b]' % (API)) print("API key\t\t\t: [b]%s[/b]" % (API))
print('mailcow Instance : [b]%s[/b]' % (mail_server)) print("Mailcow Instance\t: [b]%s[/b]" % (mail_server))
print('Logfile : [b]%s[/b]' % (logfile)) print("Active domains\t\t: [b]%s[/b]" % (domain))
print('Aliases on server : [b]%s[/b]' % (aliases_server)) print("Mailcow version\t\t: [b]%s[/b]" % (mailcow_version))
print('Aliases in DB : [b]%s[/b]' % (alias_db)) print("Logfile\t\t\t: [b]%s[/b]" % (logfile))
print("Databse\t\t\t: [b]%s[b]" % (database))
print("Aliases on server\t: [b]%s[/b]" % (aliases_server))
print("Aliases in DB\t\t: [b]%s[/b]" % (alias_db))
print("")
if app_version[:3] != latest_release:
print(
"App version\t\t\t\t: [b]%s[/b] a new version (%s) is available @ https://iurl.no/malias"
% (app_version, latest_release)
)
else:
print("App version\t\t: [b]%s[/b]" % (app_version))
print('') print('')
print('App version : [b]%s[/b] (https://gitlab.pm/rune/malias)' % (app_version))
print('')
conn = connect_database()
def export_data():
apikey = get_api()
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.dumps(json.loads(remote),indent=4)
with open("alias.json", "w") as outfile:
outfile.write(remoteData)
def import_data(file):
apikey=get_api()
mailserver = get_settings('mail_server')
active_domains = get_mail_domains(False)
with open(file,'r') as mail_alias:
json_object = json.load(mail_alias)
domain_list = []
active_domain_list = []
for data in json_object:
domain = data['domain']
if domain not in domain_list:
domain_list.append(domain)
for data in active_domains:
active_domain_list.append(data['domain_name'])
diff = list(set(domain_list) - set(active_domain_list))
if len(diff) != 0:
missing = ', '.join(diff)
print ('Please add the domains %s to your mailcow instance' % (missing))
sys.exit(1)
else:
print('OK')
def updatedb():
# Function for updatimg DB when we have to
# 09.04.24
# Added DB tempalias table
# Added DB version table
cursor = conn.cursor()
cursor.execute('''CREATE TABLE IF NOT EXISTS dbversion
(version integer NOT NULL DEFAULT 0)''')
cursor.execute('SELECT COUNT(version) FROM dbversion')
count = cursor.fetchone()[0]
if count == 0:
cursor.execute('INSERT INTO dbversion values(?)', (db_version,))
conn.execute('''CREATE TABLE IF NOT EXISTS timedaliases
(id integer NOT NULL PRIMARY KEY,
alias text NOT NULL,
goto text NOT NULL,
validity text NOT NULL)''')
conn.commit()
conn = connect_database()
updatedb() # Check if db needs updating and do the updating.
parser = argparse.ArgumentParser(prog='malias', parser = argparse.ArgumentParser(prog='malias',
description='This is a simple application to help you create and delete aliases on a mailcow instance.\nIf you find any issues or would like to submit a PR - please head over to https://gitlab.pm/rune/malias. \n\nI hope this makes your mailcow life a bit easier!', description='This is a simple application to help you create and delete aliases on a mailcow instance.\nIf you find any issues or would like to submit a PR - please head over to https://gitlab.pm/rune/malias. \n\nI hope this makes your mailcow life a bit easier!',
formatter_class=RawTextHelpFormatter, formatter_class=RawTextHelpFormatter,
epilog='Making mailcow easier...') epilog='Making mailcow easier...')
parser.add_argument('-k', '--api', help='Add/Change API key.\n\n', parser.add_argument('-k', '--api', help='Add/Change API key.\n\n',
nargs=1, metavar=('APIkey'), required=False, action="append") nargs=1, metavar=('APIkey'), required=False, action="append")
parser.add_argument('-s', '--search', help='Search for alias.\n\n', parser.add_argument('-s', '--search', help='Search for alias.\n\n',
nargs=1, metavar=('alias@domain.com'), required=False, action="append") nargs=1, metavar=('alias@domain.com'), required=False, action="append")
parser.add_argument('-m', '--server', help='Add/Uppdate mailcow instance.\n\n', parser.add_argument('-m', '--server', help='Add/Uppdate mailcow instance.\n\n',
nargs=1, metavar=('mailcow-server.tld'), required=False, action="append") nargs=1, metavar=('mailcow-server.tld'), required=False, action="append")
parser.add_argument('-a', '--add', help='Add new alias.\n\n', parser.add_argument('-a', '--add', help='Add new alias.\n\n',
nargs=2, metavar=('alias@domain.com', 'to@domain.com'), required=False, action="append") nargs=2, metavar=('alias@domain.com', 'to@domain.com'), required=False, action="append")
parser.add_argument('-d', '--delete', help='Delete alias.\n\n', parser.add_argument('-t', '--timed', help='Add new time limited alias for user on domain. One year validity\n\n',
nargs=2, metavar=('user@domain.com', 'domain.com'), required=False, action="append")
parser.add_argument('-d', '--delete', help='Delete alias.\n\n',
nargs=1, metavar=('alias@domain.com'), required=False, action="append") nargs=1, metavar=('alias@domain.com'), required=False, action="append")
parser.add_argument('-v', '--version', help='Show current version and config info\n\n', # parser.add_argument('-i', '--import', help='Show current config and appliacation info\n\n',
# nargs=1, metavar=('alias.json'), required=False, action="append")
parser.add_argument('-v', '--version', help='Show current version and information\n\n',
required=False, action='store_true') required=False, action='store_true')
parser.add_argument('-c', '--copy', help='Copy alias data from mailcow server to local DB.\n\n', parser.add_argument('-c', '--copy', help='Copy alias data from mailcow server to local DB.\n\n',
@ -362,6 +635,9 @@ parser.add_argument('-c', '--copy', help='Copy alias data from mailcow server to
parser.add_argument('-l', '--list', help='List all aliases on the Mailcow instance.\n\n', parser.add_argument('-l', '--list', help='List all aliases on the Mailcow instance.\n\n',
required=False, action='store_true') required=False, action='store_true')
parser.add_argument('-o', '--domains', help='List all mail domains on the Mailcow instance.\n\n',
required=False, action='store_true')
args = vars(parser.parse_args()) args = vars(parser.parse_args())
@ -373,15 +649,21 @@ elif args['server']:
set_mailserver(args['server'][0][0]) set_mailserver(args['server'][0][0])
elif args['add']: elif args['add']:
create(args['add'][0][0],args['add'][0][1]) create(args['add'][0][0],args['add'][0][1])
elif args['timed']:
create_timed(args['timed'][0][0],args['timed'][0][1])
elif args['delete']: elif args['delete']:
delete_alias(args['delete'][0][0]) delete_alias(args['delete'][0][0])
elif args['import']:
import_data(args['import'][0][0])
elif args['version']: elif args['version']:
show_current_info() show_current_info()
elif args['copy']: elif args['copy']:
copy_data() copy_data()
elif args['list']: elif args['list']:
list_alias() list_alias()
elif args['domains']:
get_mail_domains(True)
else: else:
print('\n\nEh, sorry! I need something more to help you! If you write [b]malias -h[/b] I\'ll show a help screen to get you going!!!\n\n\n') print('\n\nEh, sorry! I need something more to help you! If you write [b]malias -h[/b] I\'ll show a help screen to get you going!!!\n\n\n')

View File

@ -11,7 +11,9 @@ click==8.1.3
docopt==0.6.2 docopt==0.6.2
docutils==0.19 docutils==0.19
frozenlist==1.3.3 frozenlist==1.3.3
gpg==1.19.0 gitdb==4.0.10
GitPython==3.1.32
gpg==1.21.0
idna==3.4 idna==3.4
importlib-metadata==6.1.0 importlib-metadata==6.1.0
jaraco.classes==3.2.3 jaraco.classes==3.2.3
@ -36,6 +38,7 @@ requests-toolbelt==0.10.1
rfc3986==2.0.0 rfc3986==2.0.0
rich==13.3.1 rich==13.3.1
six==1.16.0 six==1.16.0
smmap==5.0.0
tqdm==4.65.0 tqdm==4.65.0
twine==4.0.2 twine==4.0.2
urllib3==1.26.14 urllib3==1.26.14