View source for Scripting

__NOTOC__

Starting with version 7, MailStore Server provides powerful interfaces, such as the [[MailStore Server Management Shell]] and the [[MailStore Server Administration API]], that can be used to automate many tasks through scripts. This makes it possible to realize scenarios that would be difficult or impossible to implement through the GUI. Furthermore, scripting allows to integrate MailStore Server in existing workflows or business processes.

This article exemplifies the usage of the MailStore Server Administration API in several scripting languages. In our scripting section we assorted various scripts that make use of the demonstrated techniques and solve frequently posed problems. These scripts can be used freely and may be adapted to a specific environment or serve as a basis for further solutions.

<p class=msnote>'''Important Notice:''' The scripting code published in this section must be considered as reference and example implementations. Please refer to the licensing terms in the respective script files for details.</p>

== API Wrapper ==
As an HTTPS-based interface it is possible to use the [[MailStore Server Administration API]] with basically any programming or scripting language that supports web requests. To simplify script development, an API wrapper should be used that encapsulates API communication. Using such a wrapper, script developers can concentrate on the desired script functionality and profit from easier debugging as well as from somewhat standardized scripts.

The Python and PowerShell scripts offered by MailStore use implementations of such API wrappers that can be used as a reference. These wrappers are themselves written in the respective scripting language (Python 3.x or Powershell 3.0) and contain comments and in-line help for better comprehension. The corresponding articles offer more details on their functionality.

== Using Window Batch Scripts ==
For simple tasks, such as bulk import or export of PST files, Window batch scripts may also be used. Usually, these scripts do not control MailStore Server through the [[MailStore Server Administration API]] but through the [[MailStore_Server_Management_Shell|command line interpreter]].

Before you are able to execute [https://ftp.mailstore.com/pub/Scripts/Batch/v9/scripts.zip Windows batch scripts] on the command line ''cmd.exe'', you need to open the script file in a text editor such as ''Notepad''. Adjust the configuration variables above the ''DON'T CHANGE ANYTHING BEYOND THIS LINE'' line to your local environment. Please take care not to change any single or double quotes.

* [https://ftp.mailstore.com/pub/Scripts/Batch/v9/scripts.zip Windows Batch Scripts]

=== Available Windows Batch Scripts ===
{| class="wikitable"
! scope="col" | File Name
! scope="col" | Description
|-
| <tt>bulkImportPST.bat</tt>
| Import multiple PST files from a given directory into the archive of a the given MailStore user.
|-
| <tt>bulkImportMBOX.bat</tt>
| Import multiple MBOX files from a given directory into the archive of a the given MailStore user.
|-
| <tt>bulkExportPST.bat</tt>
| Export of all archives into multiple PST files seperated by MailStore users.
|-
| <tt>bulkDeleteUsers.bat</tt>
|  Delete all MailStore users except the default admin user 'admin'.
|}

== Using Python Scripts ==
Complex processes can more easily be automated with a higher level scripting language than simple Windows batch scripts. As a widely used, platform independent and easy to learn but powerful scripting language, Python is well suited to control MailStore Server through the [[MailStore Server Administration API]].

To be able to execute Python scripts you need to install the Python runtime. The Windows installer of the Python runtime can be downloaded from [http://www.python.org Python.org]. For Linux operating systems, please follow the instructions of your distributor's package manager to install the Python runtime. 

For executing our scripts, a version of the [https://ftp.mailstore.com/pub/Scripts/Python/v9/python-api-wrapper.zip  Python API Wrapper] is required. Installation instructions for the wrapper are available in the corresponding section of the [[Python API Wrapper Tutorial]].

In order to execute Python scripts, you have to open the script file you want to execute with IDLE (shipped with Python's Windows installer) and adjust the configuration section above the line stating ''DON'T CHANGE ANYTHING BEYOND THIS LINE''. Please take care not to change any double or single quotes.

To execute the script, click on ''Run'' > ''Run Module'' or press the F5-key in IDLE. A new window pops up where you can follow the standard output of the script and see possible execution errors.

If you are planning to write your own scripts in Python to automate MailStore Server tasks, the [[Python API Wrapper Tutorial]] offers a good starting point. Otherwise, if you just want to make use of the provided [[Python Scripts]], you can download them from [[Python Scripts|here]].

* [[Python API Wrapper Tutorial]]
* [[Python Scripts]]

=== Available Python Scripts ===

{| class="wikitable"
! scope="col" | File Name
! scope="col" | Description
|-
| <tt>mergeFolders.py</tt>
| Merge sub folder branches. Often needed after archiving from multiple PSTs for one user.
|-
| <tt>createUserFolders.py</tt>
| Create folders in file system based on MailStore user names. Can be used in preparation of bulk imports of EML, MSG or PST files.
|-
| <tt>check_mailstorelicense.py</tt>
| Nagios/Icinga plugin for monitoring available licenses. See [[Monitoring]] for further details.
|-
| <tt>check_mailstore.py</tt>
| Nagios/Icinga plugin for monitoring recent results. See [[Monitoring]] for further details. 
|}

== Using PowerShell Scripts ==
As the standard shell that is shipped with every newer version of Windows, the .NET framework based Windows PowerShell is also well suited to control MailStore Server through the MailStore Server Administration API.

The MailStore PowerShell API Wrapper and the scripts are compatible with Windows PowerShell 3.0 and higher. Depending on the version of Windows, the Windows PowerShell has to be installed separately; it can be downloaded at the [https://www.microsoft.com/en-us/download/default.aspx Microsoft Download Center] free of charge.

If you want to implement your own scripts to automate MailStore Server tasks, the PowerShell API Wrapper Tutorial is ideal to start with. If you just want to use the scripts offered by MailStore, you can simply navigate to that section directly.

* [[PowerShell API Wrapper Tutorial]]

[[de:Scripting]]
[[en:Scripting]]