mailbox-org-api 0.2__tar.gz → 0.2.2__tar.gz

{mailbox_org_api-0.2 → mailbox_org_api-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mailbox-org-api
-Version: 0.2
+Version: 0.2.2
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>

{mailbox_org_api-0.2 → mailbox_org_api-0.2.2}/mailbox_org_api/APIClient.py

@@ -118,30 +118,30 @@ class APIClient:
         """
         return self.api_request('hello.innerworld', {})
 
-    def account_add(self, account_name: str) -> dict:
+    def account_add(self, account: str) -> dict:
         """
         Function to create a new account
-        :param account_name: the account name to create
+        :param account: the account name to create
         :return: the response from the mailbox.org Business API
         """
-        return self.api_request('account.add', {'account_name':account_name})
+        return self.api_request('account.add', {'account':account})
 
-    def account_get(self, account_name: str) -> dict:
+    def account_get(self, account: str) -> dict:
         """
         Function to get a specific account
-        :param account_name: the account name to get
+        :param account: the account name to get
         :return: the response from the mailbox.org Business API
         """
-        return self.api_request('account.get', {'account_name':account_name})
+        return self.api_request('account.get', {'account':account})
 
-    def account_set(self, account_name: str, attributes: dict) -> dict:
+    def account_set(self, account: str, attributes: dict) -> dict:
         """
         Function to update a specific account
-        :param account_name: the account name to update
+        :param account: the account name to update
         :param attributes: the attributes to update
         :return: the response from the mailbox.org Business API
         """
-        params = {'account':account_name}
+        params = {'account':account}
         for attribute in attributes:
             print('Attribute:', attribute)
             if attribute not in account_set_arguments:
@@ -153,13 +153,13 @@ class APIClient:
             params.update({attribute: attributes[attribute]})
         return self.api_request('account.set', params)
 
-    def account_del(self, account_name: str) -> dict:
+    def account_del(self, account: str) -> dict:
         """
         Function to delete a specific account
-        :param account_name: the account name to delete
+        :param account: the account name to delete
         :return: the response from the mailbox.org Business API
         """
-        return self.api_request('account.del', {'account_name':account_name})
+        return self.api_request('account.del', {'account':account})
 
     def domain_list(self, account: str) -> dict:
         """
@@ -255,13 +255,14 @@ class APIClient:
                                                     'inboxsave':inboxsave, 'forwards':forwards, 'memo':memo,
                                                     'language':language, 'uid_extern':uid_extern})
 
-    def mail_get(self, mail: str):
+    def mail_get(self, mail: str, include_quota_usage: bool = False) -> dict:
         """
         Function to retrieve a mail address
         :param mail: the mail to retrieve
+        :param include_quota_usage: True if the quota usage should be included in the request
         :return the response for the request
         """
-        return self.api_request('mail.get', {'mail':mail})
+        return self.api_request('mail.get', {'mail':mail, 'include_quota_usage':include_quota_usage})
 
     def mail_set(self, mail: str, attributes: dict):
         """
@@ -282,6 +283,60 @@ class APIClient:
             params.update({attribute: attributes[attribute]})
         return self.api_request('mail.set', params)
 
+    def mail_set_password(self, mail: str, password: str) -> dict:
+        """
+        Function to set a new password for a mail
+        :param mail: the mail to set the password for
+        :param password: the password to set
+        :return: the response for the request
+        """
+        return self.api_request('mail.set', {'mail':mail, 'password':password})
+
+    def mail_set_password_require_reset(self, mail: str, password: str) -> dict:
+        """
+        Function to set a new password for a mail and force the user to set a new password on the next login
+        :param mail: the mail to set the password for
+        :param password: the password to set
+        :return: the response for the request
+        """
+        return self.api_request('mail.set', {'mail': mail, 'password': password, 'require_reset': True})
+
+    def mail_set_plan(self, mail: str, plan: str) -> dict:
+        """
+        Function to set a new plan for a mail
+        :param mail: the mail to set the plan for
+        :param plan: the plan to set
+        :return: the response for the request
+        """
+        return self.api_request('mail.set', {'mail':mail, 'plan':plan})
+
+    def mail_set_forwards(self, mail: str, forwards: list) -> dict:
+        """
+        Function to set mail forwards
+        :param mail: the mail to set the forwards for
+        :param forwards: a list of addresses to forwards mails to
+        :return: the response for the request
+        """
+        return self.api_request('mail.set', {'mail':mail, 'forwards':forwards})
+
+    def mail_set_aliases(self, mail: str, aliases: list) -> dict:
+        """
+        Function to set mail aliases
+        :param mail: the mail to set the aliases for
+        :param aliases: a list of aliases to set
+        :return: the response for the request
+        """
+        return self.api_request('mail.set', {'mail':mail, 'aliases':aliases})
+
+    def mail_set_state(self, mail: str, active: bool) -> dict:
+        """
+        Function to activate or deactivate a mail
+        :param mail: the mail to set the status for
+        :param active: True if the mail should be active, False if it shall be deactivated
+        :return: the response for the request
+        """
+        return self.api_request('mail.set', {'mail':mail, 'active':active})
+
     def mail_capabilities_set(self, mail: str, capabilties: dict) -> dict:
         """
         Function to set a domain capabilities

{mailbox_org_api-0.2 → mailbox_org_api-0.2.2}/mailbox_org_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mailbox-org-api
-Version: 0.2
+Version: 0.2.2
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>

{mailbox_org_api-0.2 → mailbox_org_api-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mailbox-org-api"
-version = "0.2"
+version = "0.2.2"
 authors = [
   { name="Hendrik Schlange", email="mail@heshsum.de" },
 ]

{mailbox_org_api-0.2 → mailbox_org_api-0.2.2}/setup.py

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