PowerShell API Wrapper Tutorial - Revision history

Ltalaschus: /* Handling Asynchronous API Calls */

2025-01-22T16:03:11Z

Handling Asynchronous API Calls

2022-06-15T09:31:38Z

2022-06-15T09:30:52Z

Reverted edits by Bmeyn (talk) to last revision by Dweuthen

2022-06-15T09:29:32Z

Installation of Necessary Components

2019-09-18T12:56:06Z

2019-03-05T08:36:36Z

SecurityProtocal example added

2018-01-15T10:57:59Z

Installation of Necessary Components

2018-01-15T10:56:44Z

Installation of Necessary Components

2018-01-10T13:36:38Z

2017-04-19T08:43:34Z

@@ Line 119: / Line 119: @@
 === Handling Asynchronous API Calls ===
-The server may decide to execute Administration API commands asynchronously if their execution takes more time. The MailStore PowerShell API Wrapper can either wait for such [[Administration API - Using the API#Long Running Processes|asynchronously executed API commands]] to complete or run 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 Administration API commands asynchronously if their execution takes more time. The MailStore PowerShell API Wrapper can either wait for such [[Administration API - Using the API#Long Running Processes|asynchronously executed API commands]] to complete or run them as [https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs PowerShell Jobs] in the background.
 ==== Waiting for Asynchronous API Calls to Complete ====
@@ Line 159: / Line 159: @@
    Stop-MSApiCall $MSApiclient -AsyncReturnObject $return
 </source>
 === Pinning the TLS version ===

@@ Line 11: / Line 11: @@
 * [[Media:MailStore_Server_Scripting_Tutorial.zip|MailStore PowerShell API Wrapper and tutorial example scripts]]
-* [https://docs.microsoft.com/en-us/powershell/wmf Windows Management Framework] for your Operating System which includes the PowerShell
+* [https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/wmf/overview?view=powershell-5.1 Windows Management Framework] for your Operating System which includes the PowerShell
 Please take note of the system requirements and further notices for the respective version of the Windows Management Framework.

@@ Line 11: / Line 11: @@
 * [[Media:MailStore_Server_Scripting_Tutorial.zip|MailStore PowerShell API Wrapper and tutorial example scripts]]
-* [https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/wmf/overview?view=powershell-5.1] for your Operating System which includes the PowerShell
+* [https://docs.microsoft.com/en-us/powershell/wmf Windows Management Framework] for your Operating System which includes the PowerShell
 Please take note of the system requirements and further notices for the respective version of the Windows Management Framework.

@@ Line 11: / Line 11: @@
 * [[Media:MailStore_Server_Scripting_Tutorial.zip|MailStore PowerShell API Wrapper and tutorial example scripts]]
-* [https://docs.microsoft.com/en-us/powershell/wmf Windows Management Framework] for your Operating System which includes the PowerShell
+* [https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/wmf/overview?view=powershell-5.1] for your Operating System which includes the PowerShell
 Please take note of the system requirements and further notices for the respective version of the Windows Management Framework.

← Older revision		Revision as of 12:56, 18 September 2019
Line 5:		Line 5:


−	This tutorial aims to explain the usage of the [[Administration API - Using the API\|Administration 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 ~~[https://www~~.mailstore.com~~/en/products/mailstore-server/mailstore-~~server-trial-download/ 30-day-trial version] of MailStore Server is perfectly suited for this.	+	This tutorial aims to explain the usage of the [[Administration API - Using the API\|Administration 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 {{go.mailstore.com\|target{{=}}website&context{{=}}server-trial-download\|30-day-trial version}} of MailStore Server is perfectly suited for this.

	== Installation of Necessary Components ==		== Installation of Necessary Components ==

← Older revision		Revision as of 13:36, 10 January 2018
Line 5:		Line 5:


−	This tutorial aims to explain the usage of the [[Administration API - Using the API\|Administration 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 [~~http~~://www.mailstore.com/en/mailstore-server-trial-download~~.aspx~~ 30-day-trial version] of MailStore Server is perfectly suited for this.	+	This tutorial aims to explain the usage of the [[Administration API - Using the API\|Administration 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 [https://www.mailstore.com/en/products/mailstore-server/mailstore-server-trial-download/ 30-day-trial version] of MailStore Server is perfectly suited for this.

	== Installation of Necessary Components ==		== Installation of Necessary Components ==

@@ Line 10: / Line 10: @@
 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:
-* [ftp://ftp.mailstore.com/pub/Scripts/PowerShell/v9/MailStore_Server_Scripting_Tutorial.zip MailStore PowerShell API Wrapper and tutorial example scripts]
+* [[Media:MailStore_Server_Scripting_Tutorial.zip|MailStore PowerShell API Wrapper and tutorial example scripts]]
 * [http://www.microsoft.com/en-us/download/details.aspx?id=34595 Windows Management Framework 3.0] (contains PowerShell 3.0)
 * [http://www.microsoft.com/en-us/download/details.aspx?id=40855 Windows Management Framework 4.0] (alternatively, contains PowerShell 4.0)