Python API Wrapper Tutorial - Revision history

Ltalaschus: /* Installation */

2025-10-01T12:38:35Z

Installation

Ltalaschus: /* Instantiating the API Client */

2025-06-17T13:08:05Z

Instantiating the API Client

Ltalaschus: /* Instantiating the API Client */

2025-06-17T13:05:19Z

Instantiating the API Client

Ltalaschus: /* Instantiating the API Client */

2024-04-10T15:38:06Z

Instantiating the API Client

Ltalaschus: /* Installation */

2024-04-10T15:35:51Z

Installation

Ltalaschus: /* Installation */

2024-04-10T09:50:42Z

Installation

Ltalaschus: /* Installation */

2024-04-10T08:57:58Z

Installation

Chansen at 09:31, 22 February 2024

2024-02-22T09:31:36Z

Chansen at 09:31, 22 February 2024

2024-02-22T09:31:24Z

Ltalaschus at 11:28, 15 November 2022

2022-11-15T11:28:10Z

@@ Line 5: / Line 5: @@
 == Installation ==
-The API wrapper library is tested against Python 3.6 and newer and is compatible with 32bit and 64bit versions of Python.
+The API wrapper library is tested against Python 3.7 and newer and is compatible with 32bit and 64bit versions of Python.
 Python binaries for various operating systems can be downloaded from the [http://www.python.org/download/ Python download page] or installed using the package manager of most Linux distributions.

@@ Line 33: / Line 33: @@
 <source lang="python" smart-tabs="true" toolbar="false" gutter="false">
-# get your credentials from a secure location
+# get your credentials from a secure location, e.g. from keyring
 username = "yourusername"
 password = "yourpassword"

@@ Line 33: / Line 33: @@
 <source lang="python" smart-tabs="true" toolbar="false" gutter="false">
-serverClient = mailstore.mgmt.ServerClient(username="admin", password="admin", host="127.0.0.1", port=8463)
+# get your credentials from a secure location
 </source>

@@ Line 77: / Line 77: @@
 | <tt>ignoreInvalidSSLCerts</tt>
 | False
-| Has to be set to ''True'' or ''False''. Has to be enabled if untrusted certificates are used, otherwise an error occurs when using recent Python versions (>= 3.4.3).
+| Has to be set to ''True'' or ''False''. Has to be enabled if untrusted certificates are used, otherwise an error occurs.
 |}

@@ Line 5: / Line 5: @@
 == Installation ==
-The API wrapper library is tested against Python 3.4 and newer and is compatible with 32bit and 64bit versions of Python.
+The API wrapper library is tested against Python 3.6 and newer and is compatible with 32bit and 64bit versions of Python.
 Python binaries for various operating systems can be downloaded from the [http://www.python.org/download/ Python download page] or installed using the package manager of most Linux distributions.

@@ Line 14: / Line 14: @@
 <source lang="python" smart-tabs="true" toolbar="false" gutter="false">
-python3 -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"
+python3 -c "import site; print(site.getsitepackages())"
 </source>
@@ Line 20: / Line 20: @@
 <source lang="python" smart-tabs="true" toolbar="false" gutter="false">
-python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"
+python -c "import site; print(site.getsitepackages())"
 </source>

@@ Line 1: / Line 1: @@
 __NOTOC__
-<p class=msnote>'''Important notice:''' Thee Python API wrapper for the MailStore Server Administration API provided on this website, represents an example implementation of an API client. This wrapper should help system administrators and developers to quickly understand how the Administration API of MailStore Server works and how to use it in own scripts. Please understand that beyond this documentation no further support for the Python API wrapper is provided. Unless stated otherwise, the Python API wrapper as well as all related example scripts are released under the terms an conditions of the [[wikipedia:MIT_License|MIT License]].</p>
+<p class=msnote>'''Important notice:''' The Python API wrapper for the MailStore Server Administration API provided on this website, represents an example implementation of an API client. This wrapper should help system administrators and developers to quickly understand how the Administration API of MailStore Server works and how to use it in own scripts. Please understand that beyond this documentation no further support for the Python API wrapper is provided. Unless stated otherwise, the Python API wrapper as well as all related example scripts are released under the terms an conditions of the [[wikipedia:MIT_License|MIT License]].</p>
 This document explains the installation and usage of the Python API wrapper for the MailStore Server Administration API. In order to prevent loss of data, service interruption or other problems, it is highly recommended to use a non-productive test environment for this tutorial as well as for script development in general. The 30-day-trial version of MailStore Server is perfectly suited for this.

@@ Line 9: / Line 9: @@
 Python binaries for various operating systems can be downloaded from the [http://www.python.org/download/ Python download page] or installed using the package manager of most Linux distributions.
-Additionally create a folder "mailstore" in the Python's site-packages directory and extract the files from the [https://help.mailstore.com/en/server/images/c/cc/Python-api-wrapper.zip Python API wrapper library] into this folder.
+Additionally create a folder "mailstore" in the Python's site-packages directory and extract the files from the [[Media:Python-api-wrapper.zip|Python API Wrapper]] into this folder.
 In a UNIX like operating system the location of the site-packages directory can be found by executing the following command in a shell: