Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
7f12bd3743 | |||
8a6eceb9a5 | |||
2bd8ddeb04 | |||
f3ba4f7d67 | |||
37d670b54e | |||
12215074d6 | |||
15e8f8ac90 |
@@ -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. 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,10 @@ For instructions run
|
|||||||
malias -h
|
malias -h
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## 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
|
||||||
|
BIN
malias.png
Normal file
BIN
malias.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 573 KiB |
86
malias.py
Normal file → Executable file
86
malias.py
Normal file → Executable file
@@ -10,12 +10,12 @@ 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
|
||||||
|
|
||||||
# Info pages for dev
|
# Info pages for dev
|
||||||
@@ -29,7 +29,7 @@ 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.2.1'
|
app_version = '0.2.3'
|
||||||
|
|
||||||
|
|
||||||
def connect_database():
|
def connect_database():
|
||||||
@@ -127,6 +127,30 @@ def apikey(key):
|
|||||||
print('Your API key has been updated.')
|
print('Your API key has been updated.')
|
||||||
conn.commit()
|
conn.commit()
|
||||||
|
|
||||||
|
|
||||||
|
def get_mail_domains():
|
||||||
|
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)
|
||||||
|
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)))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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")
|
||||||
@@ -235,6 +259,7 @@ def checklist(alias):
|
|||||||
|
|
||||||
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')
|
||||||
@@ -243,14 +268,23 @@ 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):
|
||||||
apikey = get_api()
|
apikey = get_api()
|
||||||
@@ -333,6 +367,31 @@ def search(alias):
|
|||||||
print('\n\nData from server')
|
print('\n\nData from server')
|
||||||
|
|
||||||
|
|
||||||
|
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)
|
||||||
|
#repo = Repo("https://github.com/mailcow/mailcow-dockerized")
|
||||||
|
# info = repo.git.ls_remote()
|
||||||
|
# tags = repo.tags
|
||||||
|
remote_heads = git.cmd.Git().ls_remote('https://github.com/mailcow/mailcow-dockerized', tags=True)
|
||||||
|
# tags = remote_heads.rstrip('refs/tags/')
|
||||||
|
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()
|
||||||
@@ -346,12 +405,15 @@ def show_current_info():
|
|||||||
|
|
||||||
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.')
|
print('\n[b]malias[/b] - Manage aliases on mailcow Instance.')
|
||||||
print('===================================================')
|
print('===================================================')
|
||||||
print('API key : [b]%s[/b]' % (API))
|
print('API key : [b]%s[/b]' % (API))
|
||||||
print('mailcow Instance : [b]%s[/b]' % (mail_server))
|
print('mailcow Instance : [b]%s[/b]' % (mail_server))
|
||||||
|
print('Mailcow version : [b]%s[/b]' % (mailcow_version))
|
||||||
print('Logfile : [b]%s[/b]' % (logfile))
|
print('Logfile : [b]%s[/b]' % (logfile))
|
||||||
|
print('Databse : [b]%s[b]' % (database))
|
||||||
print('Aliases on server : [b]%s[/b]' % (aliases_server))
|
print('Aliases on server : [b]%s[/b]' % (aliases_server))
|
||||||
print('Aliases in DB : [b]%s[/b]' % (alias_db))
|
print('Aliases in DB : [b]%s[/b]' % (alias_db))
|
||||||
print('')
|
print('')
|
||||||
@@ -384,7 +446,7 @@ 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', '--info', help='Show current version and config info\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',
|
||||||
@@ -393,6 +455,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())
|
||||||
|
|
||||||
@@ -406,13 +471,16 @@ elif args['add']:
|
|||||||
create(args['add'][0][0],args['add'][0][1])
|
create(args['add'][0][0],args['add'][0][1])
|
||||||
elif args['delete']:
|
elif args['delete']:
|
||||||
delete_alias(args['delete'][0][0])
|
delete_alias(args['delete'][0][0])
|
||||||
elif args['version']:
|
elif args['info']:
|
||||||
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()
|
||||||
|
|
||||||
|
|
||||||
else:
|
else:
|
||||||
|
#get_mailcow_version()
|
||||||
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')
|
@@ -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
|
||||||
|
Reference in New Issue
Block a user