Difference between revisions of "PowerShell API Wrapper Tutorial"

Jump to: navigation, search
[unchecked revision][unchecked revision]
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<p class=msnote>'''Important notice:''' The PowerShell 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 PowerShellAPI wrapper is provided. Unless stated otherwise, the PowerShell 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 tutorial aims to explain the usage of the [[Management_API_-_Using_the_API|MailStore Service Provider Edition Management API]] through simple Windows PowerShell example scripts. Basic knowledge of MailStore Server, Windows and PowerShell is a necessary precondition. 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.
+
<div class=msnote>'''Important notice:''' The PowerShell API wrapper for the MailStore Server Administration API provided on this website is to be regarded as an example implementation of an API client. This wrapper should help system administrators and developers to quickly understand how MailStore Server Administration API calls work and how to use them in their own scripts.<br/>
 +
Please understand that beyond this documentation no further support for the Powershell API wrapper is provided. Unless stated otherwise, the PowerShell API wrapper as well as all related example scripts are released under the terms and conditions of the [[wikipedia:MIT_License|MIT License]].</div>
 +
 
 +
 
 +
This tutorial aims to explain the usage of the [[Management_API_-_Using_the_API|MailStore Service Provider Edition Management API]] through simple Windows PowerShell example scripts. Basic knowledge of MailStore Server, Windows and PowerShell is a necessary precondition. 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.
  
 
== Installation of Necessary Components ==
 
== Installation of Necessary Components ==
Line 60: Line 63:
 
   $MSApiClient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
 
   $MSApiClient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
 
   $return = Invoke-MSApiCall $MSApiClient "GetEnvironmentInfo"
 
   $return = Invoke-MSApiCall $MSApiClient "GetEnvironmentInfo"
   $return.Data.result | fl
+
   $return | fl
 
</source>
 
</source>
  
 
The function ''New-MSApiClient'' creates a new API client object, which is used by the ''Invoke-MSApiCall'' function for API calls. The values for ''-Username'' and ''-Password'' have to be supplied, while ''-ManagementServer'' defaults to "localhost" and  ''-Port'' defaults to "8474". The switch ''-IgnoreInvalidSSLCerts'' has to be set if untrusted certificates are used; otherwise an error occurs.
 
The function ''New-MSApiClient'' creates a new API client object, which is used by the ''Invoke-MSApiCall'' function for API calls. The values for ''-Username'' and ''-Password'' have to be supplied, while ''-ManagementServer'' defaults to "localhost" and  ''-Port'' defaults to "8474". The switch ''-IgnoreInvalidSSLCerts'' has to be set if untrusted certificates are used; otherwise an error occurs.
  
Apart from the API client object, ''Invoke-MSApiCall'' needs an [[Management_API_-_Function_Reference|API command]] and its parameters if applicable. The command ''[[Management_API_-_Function_Reference#GetEnvironmentInfo|GetEnvironmentInfo]]'' in the script does not have any parameters and returns an object as follows:
+
Apart from the API client object, ''Invoke-MSApiCall'' needs an [[Management_API_-_Function_Reference|API command]] and its parameters if applicable. The command ''[[Management_API_-_Function_Reference#GetEnvironmentInfo|GetEnvironmentInfo]]'' in the script does not have any parameters and returns a JSON object as follows:
 
 
  Type  : JSON
 
  Token :
 
  Data  : @{error=; token=; statusVersion=2; statusCode=succeeded; percentProgress=; statusText=; result=; logOutput=}
 
 
 
The object's ''Type'' property has the value "JSON" for synchronous API commands or "JOB" for asynchronous API commands (see below); it characterizes the type of the object contained in the ''Data'' property. The ''Token'' property is only relevant for asynchronous API commands.
 
 
 
The ''Data'' property contains a JSON status object returned by MailStore SPE:
 
  
 
   error          :  
 
   error          :  
Line 81: Line 76:
 
   percentProgress :  
 
   percentProgress :  
 
   statusText      :  
 
   statusText      :  
   result          : @{version=9.0.3.9845; copyright=Copyright (c) 2005-2014 MailStore Software GmbH; licenseeName=MailStore; licenseeID=23634; serverName=tutorial.mailstore.test; userName=admin; systemProperties=}
+
   result          : @{version=9.1.0.10241; copyright=Copyright (c) 2005-2014 MailStore Software GmbH; licenseeName=MailStore; licenseeID=23634; serverName=tutorial.mailstore.test; userName=admin; systemProperties=}
 
   logOutput      :   
 
   logOutput      :   
  
 
The ''result'' property of that object has the actual return value if the request succeeded as indicated by the ''statusCode'':
 
The ''result'' property of that object has the actual return value if the request succeeded as indicated by the ''statusCode'':
  
   version          : 9.0.3.9845
+
   version          : 9.1.0.10241
 
   copyright        : Copyright (c) 2005-2014 MailStore Software GmbH
 
   copyright        : Copyright (c) 2005-2014 MailStore Software GmbH
 
   licenseeName    : MailStore Software GmbH
 
   licenseeName    : MailStore Software GmbH
Line 100: Line 95:
 
   Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
 
   Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
 
   $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
 
   $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
   $return = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"})
+
   $instances = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"}).result
  if ($return.Type -eq "JOB") {
 
      Wait-Job $return.Data
 
      $instances = (Receive-Job $return.Data).Data.result
 
  } else {
 
      $instances = $return.Data.result
 
  }
 
 
   foreach ($instance in $instances) {
 
   foreach ($instance in $instances) {
       $users = (Invoke-MSApiCall $MSapiclient "GetUsers" @{instanceID = $instance.instanceID}).Data.result
+
       $users = (Invoke-MSApiCall $MSapiclient "GetUsers" @{instanceID = $instance.instanceID}).result
 
       foreach ($user in $users) {
 
       foreach ($user in $users) {
           (Invoke-MSApiCall $MSapiclient "GetUserInfo" @{instanceID = $instance.instanceID; userName = $user.userName}).Data.result | fl
+
           (Invoke-MSApiCall $MSapiclient "GetUserInfo" @{instanceID = $instance.instanceID; userName = $user.userName}).result | fl
 
       }
 
       }
 
   }
 
   }
 
</source>
 
</source>
  
The scripts lists details about the users created in a MailStore SPE instance. Because the MailStore PowerShell API Wrapper converts API responses into objects, their properties can be used directly in the script's workflow. The function ''Invoke-MSApiCall'' expects parameters as a hashtable, e.g. ''@{parametername1 = value1; parametername2 = value2;...}''. Parameter names are case sensitive.
+
The scripts lists details about the users created in the MailStore SPE instances. Because the MailStore PowerShell API Wrapper converts API responses into objects, their properties can be used directly in the script's workflow. The function ''Invoke-MSApiCall'' expects parameters as a hashtable, e.g. ''@{parametername1 = value1; parametername2 = value2;...}''. Parameter names are case sensitive.
  
First, a list of all MailStore SPE instances is requested with the API command ''[[Management_API_-_Function_Reference#GetInstances|GetInstances]]''. In case of many instances this command could be executed asynchronously by the server and return a job object (see below) otherwise an array of instances as follows is returned:
+
First, a list of all MailStore SPE instances is requested with the API command ''[[Management_API_-_Function_Reference#GetInstances|GetInstances]]''. This command returns an array of instances as follows:
 
    
 
    
 
   instanceID    : test01
 
   instanceID    : test01
Line 128: Line 117:
 
   startStopError :  
 
   startStopError :  
  
The script now iterates over this array using the ''instanceID'' property of each entry as a parameter for the API command ''[[Management_API_-_Function_Reference#GetUsers|GetUsers]]''. The list of users of each instance is then also iterated over and each user's properties are requested via ''[[Management_API_-_Function_Reference#GetUserInfo|GetUserInfo]]'':
+
The script now iterates over this array using the ''instanceID'' property of each entry as a parameter for the API command ''[[Management_API_-_Function_Reference#GetUsers|GetUsers]]''. The list of users of each instance is then also iterated over and each user's properties are requested via ''[[Management_API_-_Function_Reference#GetUserInfo|GetUserInfo]]''.
  
 
For the entry listed above the result could be as follows:
 
For the entry listed above the result could be as follows:
Line 144: Line 133:
  
 
=== Handling Asynchronous API Calls ===
 
=== Handling Asynchronous API Calls ===
The server may decide to execute Management API commands asynchronously if their execution may take more time. The MailStore PowerShell API Wrapper identifies calls of such [[Management_API_-_Using_the_API#Long_Running_Processes|asynchronously executed API commands]] and executes them as [http://technet.microsoft.com/en-us/library/hh847783%28v=wps.620%29.aspx PowerShell Jobs] in the background.
+
The server may decide to execute Management API commands asynchronously if their execution takes more time. The MailStore PowerShell API Wrapper identifies calls of such [[Management_API_-_Using_the_API#Long_Running_Processes|asynchronously executed API commands]] and executes them as [http://technet.microsoft.com/en-us/library/hh847783%28v=wps.620%29.aspx PowerShell Jobs] in the background.
  
==== Processing API Wrapper PowerShell Jobs Synchronously ====
+
==== Waiting for Asynchronous API Calls to Complete ====
 
A script's execution can be interrupted until a PowerShell Job created by the API wrapper terminates as demonstrated by the following script (''Example3.ps1'' in the tutorial package):
 
A script's execution can be interrupted until a PowerShell Job created by the API wrapper terminates as demonstrated by the following script (''Example3.ps1'' in the tutorial package):
  
Line 152: Line 141:
 
   Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
 
   Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
 
   $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
 
   $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
   $return = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"})
+
   $instances = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"}).result
  if ($return.Type -eq "JOB") {
 
      Wait-Job $return.Data
 
      $instances = (Receive-Job $return.Data).Data.result
 
  } else {
 
      $instances = $return.Data.result
 
  }
 
 
   $return = Invoke-MSApiCall $MSApiclient "VerifyStore" @{instanceID = $instances[0].instanceID; id = "1"}
 
   $return = Invoke-MSApiCall $MSApiclient "VerifyStore" @{instanceID = $instances[0].instanceID; id = "1"}
   if ($return.Type -eq "JOB") {
+
   $return | fl
      Wait-Job $return.Data
 
      Receive-Job $return.Data
 
  } else {
 
      $return.Data
 
  }
 
 
</source>
 
</source>
  
The API commands ''[[Management_API_-_Function_Reference#GetInstances|GetInstances]]'' and ''[[Management_API_-_Function_Reference#VerifyStore|VerifyStore]]'' called in the script regularly return objects with the ''Type'' property "JOB".
+
The API commands ''[[Management_API_-_Function_Reference#GetInstances|GetInstances]]'' and ''[[Management_API_-_Function_Reference#VerifyStore|VerifyStore]]'' called in the script are regularly run asynchronously by the server. By using ''Invoke-MSApiCall'' the API wrapper waits for an API command that is executed asynchronously and simply returns its final result:
  
   Type  : JOB
+
   error          :  
   Token : sa90edf0029de319e62e856aeb47678325
+
   token          : sa4c1dd3dcf56da32e44b29215b4d60b2b
   Data  : System.Management.Automation.PSRemotingJob
+
   statusVersion  : 152
 
+
  statusCode      : succeeded
The ''Token'' property now contains a unique ID returned by the server that identifies the server process; it is important for event handling (see below). The ''Data'' property contains the PowerShell Job which processes the status objects returned by the server in the background.
+
  percentProgress : 100
 +
  statusText      :
 +
  result          :
 +
  logOutput      :
  
This PowerShell Job monitors the status of its corresponding server process and is terminated when that process is finished. Through the PowerShell cmdlet [http://technet.microsoft.com/en-us/library/hh849735.aspx Wait-Job] the scripts waits until the job has been completed, getting the job's results through [http://technet.microsoft.com/en-us/library/hh849718.aspx Receive-Job]:
+
==== Subscribing to Events Triggered by Asynchronous API Calls ====
 
+
Instead of interrupting a script's execution, the PowerShell Jobs created by the API wrapper can be reacted to while they are running in the background. These jobs trigger a PowerShell EngineEvent with each status request that the script can subscribe to in order to execute further code on each occurrence. To demonstrate this, the previous script needs to be adapted only a bit (''Example4.ps1'' in the tutorial package):
  Type      : JSON
 
  Token      :
 
  Data      : @{error=; token=sa90edf0029de319e62e856aeb47678325; statusVersion=32; statusCode=succeeded; percentProgress=100; statusText=; result=; logOutput=}
 
  RunspaceId : 451b5d8b-dcc3-4eec-820e-3dbd2bcb4c5f
 
 
 
<p class=msnote>'''Please note:''' The ''RunspaceId'' is generated by the PowerShell automatically and can be ignored here.</p>
 
 
 
==== Processing API Wrapper PowerShell Jobs Asynchronously ====
 
Instead of interrupting a script's execution, the PowerShell Jobs created by the API wrapper can be reacted to while they are running in the background. These jobs trigger a PowerShell EngineEvent with each status request that the script can subscribe to execute further code on each occurrence. To demonstrate this, the previous script needs to be adapted only a bit (''Example4.ps1'' in the tutorial package):
 
  
 
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
 
   Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
 
   Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
 
   $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
 
   $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
   $return = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"})
+
   $instances = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"}).result
   if ($return.Type -eq "JOB") {
+
  $return = Start-MSApiCall $MSApiclient "VerifyStore" @{instanceID = $instances[0].instanceID; id = "1"}
       Wait-Job $return.Data
+
   if ($return.statusCode -eq "running") {
      $instances = (Receive-Job $return.Data).Data.result
+
       $mssevent = Register-EngineEvent -SourceIdentifier $return.Token -Action {write-host $event.MessageData}
 
   } else {
 
   } else {
       $instances = $return.Data.result
+
       $return | fl
  }
 
  $return = Invoke-MSApiCall $MSApiclient "VerifyStore" @{instanceID = $instances[0].instanceID; id = "1"}
 
  if ($return.Type -eq "JOB") {
 
      $mssevent = Register-EngineEvent -SourceIdentifier $return.Token -Action {write-host $event.MessageData.Data}
 
  } else {
 
      $return.Data
 
 
   }
 
   }
 
</source>
 
</source>
 
+
By using ''Start-MSApiCall'' the API wrapper runs an API command that is executed asynchronously by the server in the background and returns its first result. The script subscribes to the event that is triggered by the background job via [http://technet.microsoft.com/en-us/library/hh849967.aspx Register-EngineEvent], using the return object's ''Token'' property as ''SourceIdentifier''. By that property the event relates to the triggering PowerShell Job and thus to the server process. The ''Action'' script block is itself created as a PowerShell Job that is executed with each triggering of the event. Through the ''MessageData'' property of the ''$event'' [http://technet.microsoft.com/en-us/library/hh847768.aspx automatic variable] the script block can access the JSON object provided by the background job. That object contains the status of the server process:
Here the script subscribes to the event that is triggered by the background job via [http://technet.microsoft.com/en-us/library/hh849967.aspx Register-EngineEvent], using the return object's ''Token'' property as ''SourceIdentifier''. By that property the event relates to the triggering PowerShell Job and thus to the server process. The ''Action'' script block is itself created as a PowerShell Job that is executed with each triggering of the event. Through the ''MessageData'' property of the ''$event'' [http://technet.microsoft.com/en-us/library/hh847768.aspx automatic variable] the script block can access the return object provided by the background job. That object's ''Data'' property contains the status of the server process:
 
  
 
   @{error=; token=sae8b8eaa3f645d11ee0207797cebbc0b1; statusVersion=8;
 
   @{error=; token=sae8b8eaa3f645d11ee0207797cebbc0b1; statusVersion=8;
Line 216: Line 181:
  
 
==== Cancelling Asynchronous API Wrapper PowerShell Jobs ====
 
==== Cancelling Asynchronous API Wrapper PowerShell Jobs ====
To cancel the execution of an asynchronous API command, use ''Stop-MSApiCall'' with either the token or the "JOB" return object. For the example above the call would be:
+
To cancel the execution of an asynchronous API command, use ''Stop-MSApiCall'' with either the token or the JSON object. For the example above the call would be:
  
 
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
 
   Stop-MSApiCall $MSApiclient -AsyncReturnObject $return
 
   Stop-MSApiCall $MSApiclient -AsyncReturnObject $return
 
</source>
 
</source>

Revision as of 10:20, 20 January 2015


Important notice: The PowerShell API wrapper for the MailStore Server Administration API provided on this website is to be regarded as an example implementation of an API client. This wrapper should help system administrators and developers to quickly understand how MailStore Server Administration API calls work and how to use them in their own scripts.
Please understand that beyond this documentation no further support for the Powershell API wrapper is provided. Unless stated otherwise, the PowerShell API wrapper as well as all related example scripts are released under the terms and conditions of the MIT License.


This tutorial aims to explain the usage of the MailStore Service Provider Edition Management API through simple Windows PowerShell example scripts. Basic knowledge of MailStore Server, Windows and PowerShell is a necessary precondition. 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.

Installation of Necessary Components

The examples demonstrated here use the MailStore PowerShell API Wrapper and are compatible with Windows PowerShell 3.0 and higher. Depending on your version of Windows it might be necessary to download and install a compatible version of PowerShell first. You can find the components necessary for this tutorial here:

Please take note of the system requirements and further notices for the respective version of the Windows Management Framework.

Important Notice: Installation of a Windows Management Framework on systems that require a specific version of Windows PowerShell, such as Microsoft Exchange Servers, is not supported and may lead to massive system failures and data loss.

After downloading and installing Windows PowerShell (if necessary) please unzip the MailStore PowerShell API Wrapper and the example scripts (to C:\MailStore SPE Scripting Tutorial\PowerShell\ by default).

Neither the MailStore PowerShell API Wrapper nor the example scripts are digitally signed, therefore execution of such scripts has to be enabled in an administrative PowerShell session using

  Set-ExecutionPolicy -ExecutionPolicy Unrestricted

Importing the MailStore PowerShell API Wrapper

The MailStore PowerShell API Wrapper is implemented as a PowerShell Script Module (MS.PS.Lib.psm1) and can thus be imported in a PowerShell session via its manifest (MS.PS.Lib.psd1) by using Import-Module.

Please open a PowerShell session and import the API wrapper module using this command:

  Import-Module "C:\MailStore SPE Scripting Tutorial\PowerShell\API-Wrapper\MS.PS.Lib.psd1"

Getting Information about the MailStore PowerShell API Wrapper

The MailStore PowerShell API Wrapper provides several functions to access the MailStore SPE Management API, following PowerShell conventions. Enter the following command to get information about these features:

  Get-Module MS.PS.Lib | fl

More detailed information is available via the module's properties. For example,

  (Get-Module MS.PS.Lib).ExportedFunctions

returns the functions provided by the module. Via

  Get-Help *MSApi*

the MailStore PowerShell API Wrapper returns inline help for all its functions.

Calling API Wrapper Functions

The following example script (Example1.ps1 in the tutorial package) explains the basic usage of MailStore PowerShell API Wrapper functions.

  Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
  $MSApiClient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
  $return = Invoke-MSApiCall $MSApiClient "GetEnvironmentInfo"
  $return | fl

The function New-MSApiClient creates a new API client object, which is used by the Invoke-MSApiCall function for API calls. The values for -Username and -Password have to be supplied, while -ManagementServer defaults to "localhost" and -Port defaults to "8474". The switch -IgnoreInvalidSSLCerts has to be set if untrusted certificates are used; otherwise an error occurs.

Apart from the API client object, Invoke-MSApiCall needs an API command and its parameters if applicable. The command GetEnvironmentInfo in the script does not have any parameters and returns a JSON object as follows:

 error           : 
 token           : 
 statusVersion   : 2
 statusCode      : succeeded
 percentProgress : 
 statusText      : 
 result          : @{version=9.1.0.10241; copyright=Copyright (c) 2005-2014 MailStore Software GmbH; licenseeName=MailStore; licenseeID=23634; serverName=tutorial.mailstore.test; userName=admin; systemProperties=}
 logOutput       :  

The result property of that object has the actual return value if the request succeeded as indicated by the statusCode:

 version          : 9.1.0.10241
 copyright        : Copyright (c) 2005-2014 MailStore Software GmbH
 licenseeName     : MailStore Software GmbH
 licenseeID       : 23634
 serverName       : tutorial.mailstore.test
 userName         : admin
 systemProperties : @{processors=System.Object[]; totalPhysicalMemory=2146947072; operatingSystem=Microsoft Windows Server 2012 Standard}
 

Calling API Wrapper Functions with Parameters

For most MailStore SPE Management API commands you need to provide parameters. Of course, the MailStore PowerShell API Wrapper's Invoke-MSApiCall function can submit these parameters, as demonstrated by the following script (Example2.ps1 in the tutorial package):

  Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
  $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
  $instances = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"}).result
  foreach ($instance in $instances) {
      $users = (Invoke-MSApiCall $MSapiclient "GetUsers" @{instanceID = $instance.instanceID}).result
      foreach ($user in $users) {
          (Invoke-MSApiCall $MSapiclient "GetUserInfo" @{instanceID = $instance.instanceID; userName = $user.userName}).result | fl
      }
  }

The scripts lists details about the users created in the MailStore SPE instances. Because the MailStore PowerShell API Wrapper converts API responses into objects, their properties can be used directly in the script's workflow. The function Invoke-MSApiCall expects parameters as a hashtable, e.g. @{parametername1 = value1; parametername2 = value2;...}. Parameter names are case sensitive.

First, a list of all MailStore SPE instances is requested with the API command GetInstances. This command returns an array of instances as follows:

 instanceID     : test01
 alias          : tutorial
 displayName    : Tutorial Test Instance
 instanceHost   : tutorial.mailstore.test
 startMode      : automatic
 processID      : 3140
 status         : running
 startStopError : 

The script now iterates over this array using the instanceID property of each entry as a parameter for the API command GetUsers. The list of users of each instance is then also iterated over and each user's properties are requested via GetUserInfo.

For the entry listed above the result could be as follows:

 userName            : johndoe
 fullName            : John Doe
 distinguishedName   : 
 authentication      : integrated
 emailAddresses      : {}
 pop3UserNames       : {}
 privileges          : {login, changePassword}
 privilegesOnFolders : {@{folder=johndoe; privileges=System.Object[]}}

As can be seen in the privilegesOnFolders property, returned objects may be nested and may also contain further objects.

Handling Asynchronous API Calls

The server may decide to execute Management API commands asynchronously if their execution takes more time. The MailStore PowerShell API Wrapper identifies calls of such asynchronously executed API commands and executes them as PowerShell Jobs in the background.

Waiting for Asynchronous API Calls to Complete

A script's execution can be interrupted until a PowerShell Job created by the API wrapper terminates as demonstrated by the following script (Example3.ps1 in the tutorial package):

  Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
  $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
  $instances = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"}).result
  $return = Invoke-MSApiCall $MSApiclient "VerifyStore" @{instanceID = $instances[0].instanceID; id = "1"}
  $return | fl

The API commands GetInstances and VerifyStore called in the script are regularly run asynchronously by the server. By using Invoke-MSApiCall the API wrapper waits for an API command that is executed asynchronously and simply returns its final result:

 error           : 
 token           : sa4c1dd3dcf56da32e44b29215b4d60b2b
 statusVersion   : 152
 statusCode      : succeeded
 percentProgress : 100
 statusText      : 
 result          : 
 logOutput       : 

Subscribing to Events Triggered by Asynchronous API Calls

Instead of interrupting a script's execution, the PowerShell Jobs created by the API wrapper can be reacted to while they are running in the background. These jobs trigger a PowerShell EngineEvent with each status request that the script can subscribe to in order to execute further code on each occurrence. To demonstrate this, the previous script needs to be adapted only a bit (Example4.ps1 in the tutorial package):

  Import-Module '..\API-Wrapper\MS.PS.Lib.psd1'
  $MSApiclient = New-MSApiClient -Username "admin" -Password "admin" -ManagementServer "localhost" -Port 8474 -IgnoreInvalidSSLCerts
  $instances = (Invoke-MSApiCall $MSApiclient "GetInstances" @{instanceFilter = "*"}).result
  $return = Start-MSApiCall $MSApiclient "VerifyStore" @{instanceID = $instances[0].instanceID; id = "1"}
  if ($return.statusCode -eq "running") {
      $mssevent = Register-EngineEvent -SourceIdentifier $return.Token -Action {write-host $event.MessageData}
  } else {
      $return | fl
  }

By using Start-MSApiCall the API wrapper runs an API command that is executed asynchronously by the server in the background and returns its first result. The script subscribes to the event that is triggered by the background job via Register-EngineEvent, using the return object's Token property as SourceIdentifier. By that property the event relates to the triggering PowerShell Job and thus to the server process. The Action script block is itself created as a PowerShell Job that is executed with each triggering of the event. Through the MessageData property of the $event automatic variable the script block can access the JSON object provided by the background job. That object contains the status of the server process:

 @{error=; token=sae8b8eaa3f645d11ee0207797cebbc0b1; statusVersion=8;
   statusCode=running; percentProgress=1; statusText=; result=;
   logOutput=  300 messages verified...
  }

Via these mechanisms the script can execute further tasks while monitoring the server process in the background. Execution and handling of multiple asynchronous API commands is also possible this way.

Cancelling Asynchronous API Wrapper PowerShell Jobs

To cancel the execution of an asynchronous API command, use Stop-MSApiCall with either the token or the JSON object. For the example above the call would be:

  Stop-MSApiCall $MSApiclient -AsyncReturnObject $return