mailbox-org-api 2.0.1__tar.gz → 2.2__tar.gz

{mailbox_org_api-2.0.1 → mailbox_org_api-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mailbox-org-api
-Version: 2.0.1
+Version: 2.2
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>
@@ -9,7 +9,7 @@ Project-URL: Issues, https://github.com/heshsum/mailbox-org-api/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: author

{mailbox_org_api-2.0.1 → mailbox_org_api-2.2}/mailbox_org_api/APIClient.py

@@ -3,9 +3,10 @@ Module for the mailbox Business API client
 """
 import json
 import requests
+from requests.adapters import HTTPAdapter
+from urllib3.util.retry import Retry
+from requests.exceptions import RequestException
 import typing_extensions
-from requests import RequestException
-
 from mailbox_org_api.APIError import APIError
 from mailbox_org_api.Account import Account
 from mailbox_org_api.Mail import Mail
@@ -19,8 +20,7 @@ class APIClient:
     """
     Object for API Client
     """
-
-    def __init__(self, debug_output=False):
+    def __init__(self, debug_output=False, max_retries=5):
         # URL of the API
         self.url = "https://api.mailbox.org/v1/"
 
@@ -35,6 +35,27 @@ class APIClient:
 
         self.debug_output = debug_output
 
+        # Initialize the session
+        self.session = requests.Session()
+
+        # Set default headers for the session
+        self.session.headers.update({
+            'Content-Type': 'application/json',
+        })
+
+        # Retry strategy
+        retry_strategy = Retry(
+            total=max_retries,
+            backoff_factor=0.5,
+            # Retry on these specific HTTP status codes
+            status_forcelist=[429, 500, 502, 503, 504],
+            # Allow retries for POST requests
+            allowed_methods=["HEAD", "GET", "OPTIONS", "POST"]
+        )
+
+        adapter = HTTPAdapter(max_retries=retry_strategy)
+        self.session.mount('https://', adapter)
+
     # Increment the request ID
     def get_jsonrpc_id(self):
         """Method to create the JSON RPC request ID. """
@@ -73,8 +94,7 @@ class APIClient:
             # Print the clean version of the request
             print('API full request:\t', print_request)
 
-        api_response = requests.post(
-            self.url, data=json.dumps(request), headers=headers)
+        api_response = self.session.post(self.url, data=json.dumps(request))
         try:
             api_response = api_response.json()
         except RequestException as error:
@@ -115,7 +135,7 @@ class APIClient:
             self.auth_id = str(api_response["session"])
             print('Auth ID:', self.auth_id)
             # The auth-header is added to the list of headers, as it has to be provided with each call
-            headers.update({"HPLS-AUTH": self.auth_id})
+            self.session.headers.update({"HPLS-AUTH": self.auth_id})
         return api_response
 
     def deauth(self) -> dict:
@@ -126,8 +146,9 @@ class APIClient:
         api_response = self.api_request('deauth',{})
         if api_response:
             # The auth header is stripped
-            del headers["HPLS-AUTH"]
+            self.session.headers.pop("HPLS-AUTH")
             self.auth_id = None
+            self.session.close()
         return api_response
 
     def hello_world(self):
@@ -431,7 +452,7 @@ class APIClient:
         """
         return self.api_request('domain.validate.spf', {'domain':domain})
 
-    def mail_list(self, domain, details: bool = False, page_size: int = None, page: int = None, sort_field: str = None,
+    def mail_list(self, domain: str, details: bool = False, page_size: int = None, page: int = None, sort_field: str = None,
                   sort_order: str = None) -> dict:
         """
         Function to list all mailboxes
@@ -543,7 +564,10 @@ class APIClient:
 
         if 'password' in kwargs and 'password_hash' in kwargs:
           raise KeyError('''Simultaneous usage of 'password' and 'password_hash' not allowed.''')
-        
+
+        if 'additional_mail_quota' in kwargs or 'additional_cloud_quota' in kwargs and 'plan' not in kwargs:
+            raise KeyError('''If setting additional quota, 'plan' must be given.''')
+
         # Check for each argument in kwargs if it is a valid function parameter.
         # Check key and type of value. Raise errors if a check fails.
 
@@ -613,6 +637,27 @@ class APIClient:
         """
         return self.api_request('mail.set', {'mail':mail, 'active':active})
 
+    def mail_set_additional_mail_quota(self, mail: str, quota: int) -> dict:
+        """
+        Function to set additional mail quota for a given mail
+        :param mail: the mail to set the quota for
+        :param quota: the quota to set
+        :return: the response for the request
+        """
+        plan = self.mail_get(mail)['plan']
+        return self.api_request('mail.set', {'mail': mail, 'plan':plan, 'additional_mail_quota':quota})
+
+    def mail_set_additional_cloud_quota(self, mail: str, quota: int) -> dict:
+        """
+        Function to set additional cloud quota for a given mail
+        :param mail: the mail to set the quota for
+        :param quota: the quota to set
+        :return: the response for the request
+        """
+        plan = self.mail_get(mail)['plan']
+        return self.api_request('mail.set', {'mail': mail, 'plan': plan,
+                                             'additional_cloud_quota': quota})
+
     def mail_set_deletion_date(self, mail: str, deletion_date: str) -> dict:
         """
         Function to delete an inbox at a given date.
@@ -933,14 +978,22 @@ class APIClient:
         return self.api_request('mailinglist.set', {'mailinglist':mailinglist, 'account':account,
                                                 'password':password, 'adminmail':adminmail})
 
-    def mailinglist_delete(self, mailinglist: str, account: str) -> dict:
+    def mailinglist_del(self, mailinglist: str, account: str) -> dict:
         """
         Function to delete a mailing list
         :param mailinglist: the mailing list to delete
         :param account: the account of the mailing list
         :return: the mailbox API response for the request - True if the mailing list was deleted, error code otherwise
         """
-        return self.api_request('mailinglist.delete', {'mailinglist':mailinglist, 'account':account})
+        return self.api_request('mailinglist.del', {'mailinglist':mailinglist, 'account':account})
+
+    def additionalmailaccount_list(self, parent_mail: str) -> dict:
+        """
+        Function to list all additional mail accounts for a given parent mail
+        :param parent_mail: the parent mail to list additional mail accounts for
+        :return: a dict containing the parent mail account and a list of additional mail accounts
+        """
+        return self.api_request('additionalmailaccount.list', {'parent_mail':parent_mail})
 
     def additionalmailaccount_add(self, parent_mail: str, new_account_mail: str, new_account_password: str,
                                   primary_address: str = None, mail_server: str = 'imap.mailbox.org',

{mailbox_org_api-2.0.1 → mailbox_org_api-2.2}/mailbox_org_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mailbox-org-api
-Version: 2.0.1
+Version: 2.2
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>
@@ -9,7 +9,7 @@ Project-URL: Issues, https://github.com/heshsum/mailbox-org-api/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: author

{mailbox_org_api-2.0.1 → mailbox_org_api-2.2}/pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "mailbox-org-api"
-version = "2.0.1"
+version = "2.2"
 authors = [
   { name="Hendrik Schlange", email="mail@heshsum.de" },
 ]
 description = "A library to access the mailbox.org Business API."
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.11"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
@@ -18,7 +18,7 @@ Homepage = "https://github.com/heshsum/mailbox-org-api"
 Issues = "https://github.com/heshsum/mailbox-org-api/issues"
 
 [build-system]
-requires = ["setuptools>=61.0"]
+requires = ["setuptools>=70.0"]
 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]

{mailbox_org_api-2.0.1 → mailbox_org_api-2.2}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages, setup
 setup(
     name='mailbox_org_api',
     packages=find_packages(),
-    version='2.0.1',
+    version='2.2',
     description='A library to access the mailbox.org Business API',
     author='Hendrik Schlange',
     install_requires=['requests'],

{mailbox_org_api-2.0.1 → mailbox_org_api-2.2}/tests/TestAPIClient.py

@@ -15,9 +15,26 @@ def generate_id():
     return str(int(time.time()))
 
 def generate_pw():
-    alphabet = string.ascii_letters + string.digits
-    password = ''.join(secrets.choice(alphabet) for i in range(42))
-    return password
+    # Length of password
+    length = 42
+    # Required character sets
+    upper = string.ascii_uppercase
+    lower = string.ascii_lowercase
+    digits = string.digits
+    special = '!$"%%&/()'
+
+    # Combine all allowed characters
+    all_chars = upper + lower + digits + special
+    while True:
+        # Generate a random string of the specified length
+        pw = ''.join(secrets.choice(all_chars) for _ in range(length))
+
+        # Ensure the password meets all criteria
+        if (any(c in upper for c in pw) and
+                any(c in lower for c in pw) and
+                any(c in digits for c in pw) and
+                any(c in special for c in pw)):
+            return pw
 
 def get_domain():
     api = APIClient.APIClient()
@@ -63,6 +80,14 @@ class TestAPIClient:
         assert api.jsonrpc_id == 1
         api.deauth()
 
+    def test_deauth(self):
+        api = APIClient.APIClient()
+        assert api.session.headers.get('HPLS-AUTH') is None
+        api.auth(api_test_user, api_test_pass)
+        assert api.session.headers.get('HPLS-AUTH') is not None
+        api.deauth()
+        assert api.session.headers.get('HPLS-AUTH') is None
+
     def test_account_get(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -281,7 +306,7 @@ class TestAPIClient:
         assert returned_mail['mail'] == mail
         api.deauth()
 
-    @pytest.mark.depends(name=['test_mail_add'])
+    @pytest.mark.depends(name='test_mail_add')
     def test_mail_set(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -294,7 +319,7 @@ class TestAPIClient:
                           'memo': 'memo_string', 'active': True, 'title': 'Title', 'position': 'Job Position',
                           'department': 'Department', 'company': 'Company', 'street': 'Street 1',
                           'postal_code': '12345', 'city': 'City', 'phone':'+492345678', 'fax':'+492345678',
-                          'cell_phone':'+492345678', 'uid_extern': generate_pw(), 'language': 'de_DE'}
+                          'cell_phone':'+492345678', 'uid_extern': 'external_uid_value', 'language': 'de_DE'}
 
         # Adding parameters to call
         params = {}
@@ -303,14 +328,23 @@ class TestAPIClient:
 
         # Getting mail from API to act as the reference
         check_mail = api.mail_get(mail)
-
+        print(check_mail)
         # Compare values sent to values received
         for k, v in mail_set_tests.items():
             assert check_mail[k] == v
 
+        with pytest.raises(KeyError):
+            api.mail_set(mail, additional_mail_quota=5)
+
+        with pytest.raises(KeyError):
+            api.mail_set(mail, additional_cloud_quota=5)
+
+        with pytest.raises(KeyError):
+            api.mail_set(mail, additional_mail_quota = 5, additional_cloud_quota=5)
+
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_capabilities_set(self):
         capabilities = ['MAIL_SPAMPROTECTION', 'MAIL_BLACKLIST', 'MAIL_BACKUPRECOVER', 'MAIL_PASSWORDRESET_SMS']
 
@@ -344,22 +378,20 @@ class TestAPIClient:
         api.auth(api_test_user, api_test_pass)
         mails = api.mail_list(domain)
         mail = mails[0]['mail']
-        plans = ['standard', 'premium']
+        plans = ['premium', 'light', 'standard']
         for plan in plans:
             api.mail_set_plan(mail, plan)
             assert str(api.mail_get(mail)['plan']).lower() == plan
-        with pytest.raises(APIError):
-            api.mail_set_plan(mail, 'light')
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_set_aliases(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
         mail = test_id + '@' + domain
         aliases = []
         api.mail_set_aliases(mail, aliases)
-        for i in range(0, 5):
+        for i in range(0, 2):
             address = test_id + '_alias_' + str(i) + '@' + domain
             aliases.append(address)
         api.mail_set_aliases(mail, aliases)
@@ -368,7 +400,7 @@ class TestAPIClient:
         assert api.mail_get(mail)['aliases'] == []
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_set_forwards(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -382,7 +414,7 @@ class TestAPIClient:
         assert api.mail_get(mail)['forwards'] == forwards
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_set_password(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -392,7 +424,7 @@ class TestAPIClient:
         assert api.mail_set_password(mail, generate_pw()) == api.mail_get(mail)
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_set_password_require_reset(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -402,7 +434,25 @@ class TestAPIClient:
         assert api.mail_set_password_require_reset(mail, generate_pw()) == api.mail_get(mail)
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
+    def test_mail_set_additional_mail_quota(self):
+        api = APIClient.APIClient()
+        api.auth(api_test_user, api_test_pass)
+        mail = test_id + '@' + domain
+        additional_mail_quota = 23
+        api.mail_set_additional_mail_quota(mail, additional_mail_quota)
+        assert additional_mail_quota == api.mail_get(mail)['additional_mail_quota']
+        api.deauth()
+
+    def test_mail_set_additional_cloud_quota(self):
+        api = APIClient.APIClient()
+        api.auth(api_test_user, api_test_pass)
+        mail = test_id + '@' + domain
+        additional_cloud_quota = 42
+        api.mail_set_additional_cloud_quota(mail, additional_cloud_quota)
+        assert additional_cloud_quota == api.mail_get(mail)['additional_cloud_quota']
+        api.deauth()
+
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_apppassword_add(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -412,7 +462,7 @@ class TestAPIClient:
         assert len(api.mail_apppassword_list(mail)) == len_before + 1
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
+    @pytest.mark.depends(name="test_mail_add")
     def test_mail_apppassword_list(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -420,9 +470,9 @@ class TestAPIClient:
         assert len(api.mail_apppassword_list(mail)) > 0
         api.deauth()
 
-    @pytest.mark.depends(name=["test_mail_add"])
-    @pytest.mark.depends(name=['test_mail_apppassword_add'])
-    @pytest.mark.depends(name=['test_mail_apppassword_list'])
+    @pytest.mark.depends(name="test_mail_add")
+    @pytest.mark.depends(name='test_mail_apppassword_add')
+    @pytest.mark.depends(name='test_mail_apppassword_list')
     def test_mail_apppassword_del(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -437,8 +487,9 @@ class TestAPIClient:
 
         # After deleting all app passwords, length should be 0
         assert len(api.mail_apppassword_list(mail)) == 0
+        api.deauth()
 
-    @pytest.mark.depends(name=['test_mail_add'])
+    @pytest.mark.depends(name='test_mail_add')
     def test_mail_set_deletion_date(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -449,7 +500,47 @@ class TestAPIClient:
         assert deletion_date in api.mail_get(mail)['deletion_date']
         api.deauth()
 
-    @pytest.mark.depends(name=['test_mail_add'])
+    def test_additionalmailaccount_list(self):
+        api = APIClient.APIClient()
+        api.auth(api_test_user, api_test_pass)
+        parent = 'parent@testbmboapi.internal'
+        sub = 'sub_mail@testbmboapi.internal'
+        assert sub in api.additionalmailaccount_list(parent)['additional_accounts']
+        api.deauth()
+
+    # Removed test as the API is too unrealiable.
+    # It oftentimes needs too much time to update and reply with the updated data for the test to work reliably
+    # def test_additionalmailaccount_add(self):
+    #     api = APIClient.APIClient()
+    #     api.auth(api_test_user, api_test_pass)
+    #     parent_mail = test_id + '_parent@' + domain
+    #     sub_mail = test_id + '_sub@' + domain
+    #     pw = generate_pw()
+    #     # Creating the accounts
+    #     api.mail_add(parent_mail, pw, 'light', 'test parent', 'test_parent')
+    #     api.mail_add(sub_mail, pw, 'light', 'test sub', 'test_sub' )
+    #     # Adding it to the mail account
+    #     assert api.additionalmailaccount_add(parent_mail, sub_mail, pw) == True
+    #     # Before checking the result, wait for a bit
+    #     # The mailbox API is sometimes slower than the test, resulting in failed tests
+    #     time.sleep(5)
+    #     # Checking that the sub account is listed as an additional account
+    #     assert sub_mail in api.additionalmailaccount_list(parent_mail)['additional_accounts']
+    #     api.deauth()
+
+    # @pytest.mark.depends(name='test_additionalmailaccount_add')
+    # def test_additionalmailaccount_delete(self):
+    #     api = APIClient.APIClient()
+    #     api.auth(api_test_user, api_test_pass)
+    #     parent_mail = test_id + '_parent@' + domain
+    #     sub_mail = test_id + '_sub@' + domain
+    #     assert api.additionalmailaccount_delete(parent_mail, sub_mail) == True
+    #     assert sub_mail not in api.additionalmailaccount_list(parent_mail)
+    #     api.mail_del(parent_mail)
+    #     api.mail_del(sub_mail)
+    #     api.deauth()
+
+    @pytest.mark.depends(name='test_mail_add')
     def test_search(self):
         api = APIClient.APIClient()
         api.auth(api_test_user, api_test_pass)
@@ -457,6 +548,7 @@ class TestAPIClient:
         assert mail in api.search(mail)['emails']
         assert domain in api.search(domain)['domains']
         assert api_test_user in api.search(api_test_user)['accounts']
+        api.deauth()
 
     @pytest.mark.order('last')
     def test_mail_del(self):