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

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: mailbox-org-api
-Version: 2.2
-Summary: A library to access the mailbox.org Business API.
+Version: 2.3
+Summary: A library to access the mailbox Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>
 Project-URL: Homepage, https://github.com/heshsum/mailbox-org-api

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

@@ -2,15 +2,18 @@
 Module for the mailbox Business API client
 """
 import json
+from typing import Any
+
 import requests
+import typing_extensions
 from requests.adapters import HTTPAdapter
-from urllib3.util.retry import Retry
 from requests.exceptions import RequestException
-import typing_extensions
+from urllib3.util.retry import Retry
+
 from mailbox_org_api.APIError import APIError
 from mailbox_org_api.Account import Account
-from mailbox_org_api.Mail import Mail
 from mailbox_org_api.Invoice import Invoice
+from mailbox_org_api.Mail import Mail
 
 headers = {'content-type': 'application/json'}
 
@@ -62,7 +65,7 @@ class APIClient:
         self.jsonrpc_id += 1
         return str(self.jsonrpc_id)
 
-    def api_request(self, method: str, params: dict) -> dict:
+    def api_request(self, method: str, params: dict) -> dict | Any:
         """
         Function to send API calls
         :param method: the method to call
@@ -365,7 +368,7 @@ class APIClient:
         # Take the Base64 encoded data (response['bin']), decode the Base 64, decompress the gz and return the bytes
         return zlib.decompress(base64.b64decode(response['bin']))
 
-    def domain_list(self, account: str, search_filter:str = None) -> dict:
+    def domain_list(self, account:str, search_filter:str | None = None) -> dict:
         """
         Function to list all domains
         :param account: the account to list domains for
@@ -373,8 +376,8 @@ class APIClient:
         :return: the API response
         """
         params = {'account':account}
-        if filter:
-            params.update({'filter':search_filter})
+        if isinstance(search_filter, str):
+            params.update({'filter':str(search_filter)})
         return self.api_request('domain.list',params)
 
     def domain_add(self, account: str, domain: str, password: str, **kwargs) -> dict:
@@ -452,8 +455,8 @@ class APIClient:
         """
         return self.api_request('domain.validate.spf', {'domain':domain})
 
-    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:
+    def mail_list(self, domain: str, details: bool = False, page_size: int  | None= None, page: int | None = None,
+                  sort_field: str | None = None, sort_order: str | None = None) -> dict:
         """
         Function to list all mailboxes
         :param domain: the domain to list
@@ -488,7 +491,7 @@ class APIClient:
         return self.api_request('mail.list', params)
 
     def mail_add(self, mail:str, password: str, plan: str, first_name: str, last_name: str, inboxsave: bool = True,
-                 forwards: list = None, **kwargs) -> dict:
+                 forwards: list | None= None, **kwargs) -> dict:
         """
         Function to add a mail
         :param mail: the mail to add
@@ -818,7 +821,7 @@ class APIClient:
         return self.api_request('mail.vacation.get', {'mail':mail})
 
     def mail_vacation_set(self, mail: str, subject: str, body: str, start_date: str, end_date: str,
-                          additional_mail_addresses: list = None) -> dict:
+                          additional_mail_addresses: list | None = None) -> dict:
         """
         Function to set the vacation notice for a given mail
         :param mail: the mail to get the vacation notice for
@@ -838,57 +841,75 @@ class APIClient:
 
         return self.api_request('mail.vacation.set', params)
 
-    def group_list(self) -> dict:
+    def group_list(self, account:str | None = None) -> dict:
         """
         Function to list all groups for an account
+        :param account: optional parameter for the account to list the groups for
         :return: mailbox API response - the list of groups
         """
-        return self.api_request('group.list', {})
+        params = {}
+        if account:
+            params['account'] = account
+        return self.api_request('group.list', params)
 
-    def group_get(self, group_id: int) -> dict:
+    def group_get(self, group_id: int, account: str | None = None) -> dict:
         """
         Function to get a group from the account by the group id
         :param group_id: the id of the group to get
+        :param account: optional parameter for the account to get the group for
         :return: mailbox API response - the list of groups of the account
         """
-        return self.api_request('group.get', {'group_id':group_id})
+        params = {'group_id': group_id}
+        if account:
+            params['account'] = account
+        return self.api_request('group.get', params)
 
-    def group_del(self, group_id: int) -> dict:
+    def group_del(self, group_id: int, account: str | None = None) -> dict:
         """
         Function to delete a group
         :param group_id: the group's id of the group to delete
+        :param account: optional parameter for the account to delete the group for
         :return: mailbox API response - True if the group was deleted, False otherwise
         """
-        return self.api_request('group.del', {'group_id':group_id})
+        params = {'group_id': group_id}
+        if account:
+            params['account'] = account
+        return self.api_request('group.del', params)
 
-    def group_add(self, name: str, display_name: str, mail_addresses_to_add: list) -> dict:
+    def group_add(self, name: str, display_name: str, mail_addresses_to_add: list, account: str | None = None) -> dict:
         """
         Function to add a group
         :param name: the group name
         :param display_name: the group's display name
         :param mail_addresses_to_add: a list of mail addresses to add
+        :param account: optional parameter for the account to add the group for
         :return: mailbox API response - True if the group was added, False otherwise
         """
-        return self.api_request('group.add', {'name':name, 'display_name':display_name,
-                                              'mail_addresses_to_add':mail_addresses_to_add})
+        params = {'name':name, 'display_name':display_name, 'mail_addresses_to_add':mail_addresses_to_add}
+        if account:
+            params['account'] = account
+        return self.api_request('group.add', params)
 
-    def group_set(self, group_id: int, display_name: str, mail_addresses_to_add: list = None,
-                  mail_addresses_to_remove: list = None) -> dict:
+    def group_set(self, group_id: int, display_name: str, mail_addresses_to_add: list | None = None,
+                  mail_addresses_to_remove: list | None = None, account: str | None= None) -> dict:
         """
         Function to modify a group. Either mail_addresses_to_add or mail_addresses_to_remove have to be specified.
         :param group_id: the group's id of the group to modify
         :param display_name: the group's display name
         :param mail_addresses_to_add: a list of mail addresses to add. Defaults to None
         :param mail_addresses_to_remove: a list of mail addresses to remove. Defaults to None
+        :param account: optional parameter for the account to set the group for
         :return: mailbox API response - True if the group was edited, False otherwise
         """
         # If mail_addresses_to_add and mail_addresses_to_remove are both empty, raise error
         if mail_addresses_to_add is None and mail_addresses_to_remove is None:
             raise ValueError('mail_addresses_to_add or mail_addresses_to_remove are required')
 
-        return self.api_request('group.set', {'group_id':group_id, 'display_name':display_name,
-                                              'mail_addresses_to_add':mail_addresses_to_add,
-                                              'mail_addresses_to_remove':mail_addresses_to_remove})
+        params = {'group_id':group_id, 'display_name':display_name, 'mail_addresses_to_add':mail_addresses_to_add,
+                  'mail_addresses_to_remove':mail_addresses_to_remove}
+        if account:
+            params['account'] = account
+        return self.api_request('group.set', params)
 
     def mail_passwordreset_listmethods(self, mail: str) -> dict:
         """
@@ -945,7 +966,7 @@ class APIClient:
         """
         return self.api_request('mailinglist.list', {'account':account})
 
-    def mailinglist_add(self, mailinglist: str, password: str, account: str, adminmail: str = None) -> dict:
+    def mailinglist_add(self, mailinglist: str, password: str, account: str, adminmail: str | None = None) -> dict:
         """
         Function to add a mailing list
         :param mailinglist: the mailing list to add
@@ -966,7 +987,8 @@ class APIClient:
         """
         return self.api_request('mailinglist.get', {'mailinglist':mailinglist, 'account':account})
 
-    def mailinglist_set(self, mailinglist: str, account: str, password: str = None, adminmail: str = None) -> dict:
+    def mailinglist_set(self, mailinglist: str, account: str, password: str | None = None,
+                        adminmail: str | None = None) -> dict:
         """
         Function to change a mailing list
         :param mailinglist: the mailing list to change
@@ -996,7 +1018,7 @@ class APIClient:
         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',
+                                  primary_address: str | None = None, mail_server: str = 'imap.mailbox.org',
                                   mail_port: int = 993, mail_secure: bool = True, mail_starttls: bool = False,
                                   transport_server: str = 'smtp.mailbox.org', transport_port: int = 465,
                                   transport_secure: bool = True, transport_starttls: bool = False,

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: mailbox-org-api
-Version: 2.2
-Summary: A library to access the mailbox.org Business API.
+Version: 2.3
+Summary: A library to access the mailbox Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>
 Project-URL: Homepage, https://github.com/heshsum/mailbox-org-api

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

@@ -1,10 +1,10 @@
 [project]
 name = "mailbox-org-api"
-version = "2.2"
+version = "2.3"
 authors = [
   { name="Hendrik Schlange", email="mail@heshsum.de" },
 ]
-description = "A library to access the mailbox.org Business API."
+description = "A library to access the mailbox Business API."
 readme = "README.md"
 requires-python = ">=3.11"
 classifiers = [

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

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