MailStore SPE Help - User contributions [en]

Enhancing SSL Security

2022-06-22T12:55:44Z

Bmeyn:

The default configuration of most operating systems allow any set of supported ciphers and hashes to be used by applications when acting as SSL client or server. While this ensures full compatibility with other client and server applications, it does no longer match the expectation in SSL encrypted communication in regards to privacy and trust due to supporting insecure protocols, cipher suites and hash algorithms.

Thus enhancing the security of SSL mainly consists of disabling these insecure protocols, ciphers and hashes as well as prioritize cipher suites that allow the usage of [[wikipedia:Perfect Forward Secrecy|Perfect Forward Secrecy]].

As all components of the MailStore Service Provider Edition rely on Windows' security support provider (SSP) called ''Secure Channel'' (also known as ''Schannel''), a number of registry keys have to be created or modified in order to disable insecure protocols, ciphers and hashes. Although Microsoft's article [https://docs.microsoft.com/en-us/windows-server/security/tls/tls-registry-settings Transport Layer Security (TLS) registry settings] describes in detail which registry keys affect the security provider settings, it is not recommended to manually change these keys. A safer way to adjust the ''Schannel'' settings for server applications is [https://www.nartac.com/ Nartac Software's IIS Crypto] tool.

== Recommended Settings ==
Highest level of security can be achieved with the following settings in ''IIS Crypto''. In a multi-server setup of MailStore SPE, the changes should be applied to all servers with Management Server or Client Access Server role.

{| class="wikitable"
| '''Protocols Enabled'''
| TLS 1.2
|-
| '''Ciphers Enabled'''
| AES 128/128 
AES 256/256
|-
| '''Hashes Enabled'''
| SHA 
SHA256 
SHA384 
SHA512 
|-
| '''Key Exchange Enabled'''
| Diffie-Hellman 
PKCS 
ECDH
|-
| '''SSL Cipher Suite Order'''
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 
|}

Update Notices

2022-03-30T13:26:30Z

Bmeyn: /* General Information */

== General Information ==
* '''Before the installation, read the [https://go.mailstore.com?product=mailstore%20service%20provider%20edition&target=changelog&lang=en changelog] for information about all changes in the respective versions.'''
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be canceled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server
* After each update, check the files in the sample branding folder to identify if new settings or template variables have been introduced.
* Updating MailStore Client and/or MailStore Outlook Add-in installations
** For versions up to 13.x, this is typically required only for major version updates (e.g. 9.8 to 10). Exceptions are mentioned in the version specific notices below.
** For version 22.x and higher, version specific notices regarding these updates will be included if necessary.
* The following version specific upgrade notices are cumulative. Therefore, also read the notices regarding all version numbers between yours and the one you are going to install.
* For versions that are not explicitly listed here, the upgrade notices for preceding versions apply accordingly.

== Upgrading to 13.x ==
* '''Update of MailStore Client and Outlook Add-in''' Irrespective of MailStore Client's auto-update mechanism, a reinstallation of MailStore Client and the MailStore Outlook Add-in is required to make use of the following improvements:
** Unified validation of TLS certificates.
** Unified evaluation of group policies.
** Distinct error messages for certain certificate errors.
** Outlook Add-in: Due to the required changes of the login process to support modern authentication with Microsoft 365 and Google Workspace, the Outlook Add-in must be updated to version 13 to be able to connect to MailStore SPE 13.x. Connecting to an older version of MailStore SPE is no longer supported after the update.
* '''Microsoft 365 Support'''
*; A new directory service synchronization profile ''Microsoft 365 (Modern Authentication)'' as well as new profiles for archiving and exporting emails from or to Microsoft 365 have been introduced. These support modern authentication (OAuth 2.0 & OpenID Connect) and customers of Microsoft 365 are advised to regularly check for Microsoft's announcement on the timeline for removing HTTP Basic Auth from Microsoft Exchange Web Services (EWS) and to plan the migration to the new profiles in advance. Once Microsoft disables support for HTTP Basic Auth in Exchange Web Services on Microsoft 365, the existing directory service synchronization profile ''Microsoft 365 (Basic Auth)'' (formerly named ''Office 365'') and the Microsoft Exchange archiving and export profiles will stop working.
* '''Google Workspace Support'''
*; The ''Google Workspace'' directory service synchronization profile has been extended with support for modern authentication (OAuth 2.0 & OpenID Connect). Customers of Google Workspace are advised to regularly check for Google's announcement on the timeline for removing support for less secure apps, and should plan the migration to the new setting in advance. Once Google disables support for Less Secure Apps in Google Workspace, the existing directory service synchronization profile ''Google Workspace'' will no longer allow users to login to MailStore as long as the authentication method is still set to ''IMAP''.
* '''GPO Templates'''
*; GPO templates are now bundled with the application. End customers may download the GPO templates from the default page of the Client Access Server. See the index.html file in the sample branding folder on how to integrate the corresponding link. As the Email Archive Client and Email Archive Outlook Add-in use the same registry keys as MailStore Server and MailStore Outlook Add-in, the GPO templates provided are those bundled with the original MailStore products.
* '''IMAP Access to Archive'''
*; When using either the new ''Microsoft 365 (Modern Authentication)'' or ''Google Workspace'' directory service synchronization profile, users that have been added by these profiles cannot access their archive via the integrated IMAP server as a MailStore SPE instance is not able to verify their credentials by itself.
* '''Mobile Web Access'''
*; The dedicated Mobile Web Access has been removed due to no longer supported third-party components (e.g. jQuery Mobile) and in favor of MailStore Web Access, which has been received major enhancements in terms of performance and usability.
* '''Legacy Web Access'''
*; As parts of Legacy Web Access are representing the server-side of the Outlook Add-in, the Legacy Web Access is still present, but no longer advertised on the login screen of the Web Access.
* '''Group Policies'''
*; The following group policy settings are no longer supported in MailStore 13:
** '''MailStore Client: Accept Thumbprint'''
**; If a server name has been defined by a group policy, the certificate used by the Client Access Server must be trusted by the client computer and it must not be revoked or expired.
** '''MailStore Outlook Add-in: Accept Thumbprint'''
**; If a server name has been defined by a group policy, the certificate used by the Client Access Server must be trusted by the client computer and it must not be revoked or expired.

== Upgrading to 12.1 ==
* '''TLS Compatibility''' To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.

== Upgrading to 12 ==
* '''Expired Certificates'''
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.

== Upgrading to Version 11 ==
* '''Upgrading Archive Stores'''
*; '''Depending on the archive size this can take an excessive amount of time. On average 50.000 messages are processed per minute during the upgrade.'''
*; Until the archive stores have been upgraded, not all functionality of the software is available. To facilitate
** retention policies,
** the search functionality,
** the improved recovery records,
*; the databases of the archive stores must be upgraded.
*; Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
* '''Retention Policies''' If not all attached archive stores are available (State: ''Archive here'', ''Normal''), or their status is ''Write-Protected'', no automatic processing of retention policies takes place. Therefore verify if an archive store is set to ''Disabled'' or ''Write-Protected'' after the upgrade and change it to one of the above states or detach it completely. Please notice that only end customers are allowed to manage retention policies.
* '''Jobs''' With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.
* '''Access via Integrated IMAP Server''' To access the archive via the integrated IMAP server, an encrypted connection is now mandatory. If necessary, adjust the configuration of your email clients accordingly and enable TLS or STARTTLS.
* '''SMTP Settings''' In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator.
* '''Management API Commands Get-/SetComplianceConfiguration''' The property ''globalRetentionTimeYears'' has been removed from the commands. Own scripts using these commands have to be adjusted accordingly. To manage retention policies, two new commands are available: ''GetRetentionPolicies'' and ''SetRetentionPolicies''.

== Upgrading to 10.2 ==
* '''Branding''' For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.

== Upgrading to 10.1 ==
* '''Archiving Emails''' If not all attached archive stores are available (State: ''Archive here'', ''Normal'', or ''Write-Protected''), no archiving takes place. Running archiving profiles are terminated with an appropriate message. Under certain circumstances this prevents the creation of duplicate emails while archiving. Therefore verify if an archive store is set to ''disabled'' after the upgrade and change it to one of the above states or detach it completely.

== Upgrading to Version 10 ==
* '''Upgrade of Master Database''' To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.
* '''Upgrading Archive Stores''' To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
* '''Archives of Other Users''' These are no longer visible for instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked. Administrative functions such as deleting or renaming user archives are accessible through ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.
* '''Export E-mails''' The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.
* '''Auditing''' All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.

== Upgrading to Version 9.x ==
* '''System Requirements''' Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.
* '''E-mail Archive Client Compatibility''' Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.
* '''PDF Support of Full Text Search''' PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.
* '''MailStore Management API''' The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.

Instance Management

2021-09-30T12:24:35Z

Bmeyn: /* Configure */

For each instance further individual administrative functions exist. These functions are accessible through the instance details, which appear in pane below the instance list (''General > Instances'') of the Management Console when clicking on a running instance in the list.

All these functions are group by tabs, for which further details are provided below.

== Overview ==
On the ''Overview'' tab of the instance details a summary of the configuration is shown.

[[File:Ms_spe_instance_overview.png|center]]

== Archive Stores ==
The ''Archive Stores'' tab allows the administration of the instance storage as well as the search indexes. New archive stores are automatically created in the base directory and can be created on demand.

=== Create Archive Stores ===
Although MailStore Service Provider Edition creates new archive stores automatically, this can also be done manually as described in the following:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Create Store''.
* Fill out the ''Create Archive Store'' form:
*: [[File:Ms_spe_create_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store.
:* '''Archive new messages here:''' Enabled by default, new message will be archived in the newly created archive store if this option is checked.
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. the database and index directory may reside on a fast storage while the content resides in on a slower storage.
:* '''Directory:''' Directory in which the new archive store will be created. A proposal is created from the ''Name'' of the archive store and the base directory of the instance. Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~\Messages-2013-10</code>
* Click ''OK'' to create the new archive store.

=== Attach Existing Archive Store ===
Archive stores from MailStore Service Provider Edition instances or from on-premises MailStore Servers can be attached to an instance as described below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Attach Store''.
* Fill out the ''Attach Archive Store'' form:
*: [[File:Ms_spe_attach_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store
:* '''Archive new messages here:''' If checked, new message will be archived in the newly created archive store. (default: unchecked)
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. archive stores created before MailStore SPE/Server 10 do have the search index files located in the same directory as the database. So you have to activate this option and remove the \''Index'' directory from the ''Index Directory''-field.
:* '''Base Directory:''' Directory of the archive store to attach. This directory must contain the file "MailStoreFileGroup.fdb". Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~/2016-12</code>.
* Click ''OK'' to attach the archive store.

=== Unlock Archive Stores ===
In case the archive store was migrated from MailStore Server 10 or newer to MailStore SPE, additional steps are required.

==== The archive store is protected with a recovery key ====
* The archive store cannot be loaded successfully and the note ''Unable to unlock archive store (Identifier: <identifier>)'' appears.
: [[File:Ms_spe_attach_locked_generated_value.png|center]]
* To finalize the migration of this archive store you need to know the recovery key identified by <identifier>, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the recovery key. The recovery key must be entered in lowercase letters.
* Click ''Invoke'', ''true'' should appear below the text fields.
: [[File:Ms_spe_attach_unlock_generated_value.png|center]]
* Verify that the archive store was attached successfully.

==== The archive store is protected with a product key ====
* The archive store cannot be loaded successfully and the note ''Unable to open the archive store <name>. Can't decrypt encryption key.'' appears.
: [[File:Ms_spe_attach_locked_product_key.png|center]]
* To finalize the migration of this archive store you need to know the product key of the installation where the archive store was attached to last, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the product key. The product key must be entered in uppercase letters.
* Click ''Invoke'', ''true'' should appear.
: [[File:Ms_spe_attach_unlock_product_key.png|center]]
* Verify that the archive store was attached successfully.

More information about archive security can be found in the [https://help.mailstore.com/en/server/MailStore_Server_Service_Configuration#Security_and_Encryption MailStore Server Service Configuration article].

=== Maintain FS Databases ===
For storing meta data of the archive store's content embedded Firebird databases exist in every archive store. Under certain circumstances (e.g. after a disaster recovery of the server or storage) it might become necessary to perform a maintenance task on those databases. This can easily be done for all archive stores of a particular instance be following the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Maintain FS Databases'' to start the maintenance.
* A progress windows will appear.
* Wait until the process is completed successfully and click ''OK''. Otherwise click ''Cancel'' to interrupt maintenance process at any time.

=== Auto-Create Stores ===
From time to time, MailStore Service Provider Edition automatically creates a new archive store for optimal system performance and stability. The maximum size and amount of emails are determined internally by the system.

If needed, you can limit the size that an archive store can reach at most before a new one is created to align with your backup routine. You can also configure the storage location where new archive stores will be created automatically.

'''Important notice: '''The maximum size should not be configured manually without good reason, so that MailStore Service Provider Edition can determine the optimal time automatically for creating a new archive store.

To change these settings, please proceed as follows:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Auto-create''.
* Adjust the settings in the ''Auto-Create Archive Stores'' dialog.
*: [[File: Ms_spe_autocreate_stores_01.png|center]]
* Click ''OK'' to save the settings.

=== Store Commands ===
Advanced store commands are accessible by following these steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Select an archive store and click on ''Store Commands'' or right-click on an archive store to open a context menu.

A summary of the available store commands can be found in the tables below:

==== Requested State ====

{| class="wikitable"
! width="150px" | State
! Description
|-
| Disabled
| Disabled archive stores are not in use but the instance still knows about their existence. The content is not available to users or administrators while the archive store is disabled. This state is useful when moving archive stores to a new directory.
|-
| Write Protected
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| Normal
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| Current
| Same as ''Normal'' but new messages will be archived in the archive store that is set to ''Current''.
|}

==== Commands ====

{| class="wikitable"
! width="150px" | Command
! Description
|-
| Detach
| Detaches the selected archive store. The archive store can be re-attached by using the ''Attach'' function. Please note that the archive store's name and ID will not be retained when detaching and re-attaching. Therefore, when moving an archive store to a new location, disabling the the archive store and using ''Set Path'' afterwards is preferred over re-attaching.
|-
| Rename
| Specify a new name for the archive store.
|-
| Set Path
| Change the path of the archive store. The archive store must be disabled before changing the path. Please note that the file system directory must be moved manually to the new location before re-enabling the archive store.
|-
| Compact
| Optimizes the data structures.
|-
| Upgrade
| If an archive store from a MailStore Server was attached to an instance, it is highly recommended to upgrade the archive store to the latest format by using this function. Upgrade process can be interrupted and continued at any time.
|-
| Verify
| Verification of the data integrity between folder information and meta data as well as email headers, content and recovery records.
|-
| Recreate Recovery Records
| Recreates broken recovery records of an archive store. Use ''Verify'' to verify the state of the recovery records.
|}

=== Search Indexes ===
Additionally to container files storing the actual email content and the embedded Firebird databases used for storing meta information, a full-text index file is created for each archive that has emails stored in an archive store. By default the full-text index only included email bodies, but virtually any file type is supported (see ''Configure'').

To access these functions, follow the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Search Indexes''.

The below functions are available in the search index menu to configure and maintain the full-text indexes of an instance.

==== Rebuild Broken Indexes ====
Starts a rebuild of all search indexes across all archive stores that are marked as broken.

==== Rebuild All Indexes ====
Starts a rebuild of all search indexes in all archives stores.
This is usually only required after making changes to the list of attachment extensions to be included in the full-text index.

==== Configure ====
Specify a list of file extensions for attachments to be included in the full-text index. MailStore Service Provider Edition can index all file types for which a so-called IFilter driver is installed on the instance host on which the MailStore instance is running. The list of file extensions has to be separated by space.

[[File: Ms_spe_file_extensions.png|center]]

Under the name [http://www.microsoft.com/en-us/download/details.aspx?id=17062 Microsoft Office 2010 Filter Packs] Microsoft offers a package that, additionally to all legacy as well as recent Microsoft Office Formats, supports the Open Document Format (OpenOffice/LibreOffice).

For reasons of stability and performance, MailStore Service Provider Edition processes the following file types directly, regardless of the IFilter drivers that are installed:

* Text files (TXT)
* HTML files (HTM and HTML)
* PDF files (PDF)

Further background information about the IFilter system itself as well as links to additional IFilter drivers can be found in the corresponding Wikipedia article [[wikipedia:IFilter|IFilter]].

== Archive Access ==
{{:Accessing Instances}}

=== Inside the Instance ===
No matter whether logging on to an instance as the customer's administrator or as service provider via service provider archive access, the available functions of the MailStore Client are nearly the same. Only accessing and or modifying the archive content (e.g. creating folders, deleting messages,..) is prohibited for the ''$archiveadmin'' user.

Please refer to [[Instance Administration]] to get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.

== Live Statistics ==
The ''Live Statistics'' tab shows real time graphics about the instance activity such as I/O, memory and CPU usage as well as number of Remote Procedure Calls (RPC) and the number of emails verified and archived by the instance's archiving mechanism.

Instance Management

2021-09-28T15:58:18Z

Bmeyn: /* Auto-Create Stores */

For each instance further individual administrative functions exist. These functions are accessible through the instance details, which appear in pane below the instance list (''General > Instances'') of the Management Console when clicking on a running instance in the list.

All these functions are group by tabs, for which further details are provided below.

== Overview ==
On the ''Overview'' tab of the instance details a summary of the configuration is shown.

[[File:Ms_spe_instance_overview.png|center]]

== Archive Stores ==
The ''Archive Stores'' tab allows the administration of the instance storage as well as the search indexes. New archive stores are automatically created in the base directory and can be created on demand.

=== Create Archive Stores ===
Although MailStore Service Provider Edition creates new archive stores automatically, this can also be done manually as described in the following:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Create Store''.
* Fill out the ''Create Archive Store'' form:
*: [[File:Ms_spe_create_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store.
:* '''Archive new messages here:''' Enabled by default, new message will be archived in the newly created archive store if this option is checked.
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. the database and index directory may reside on a fast storage while the content resides in on a slower storage.
:* '''Directory:''' Directory in which the new archive store will be created. A proposal is created from the ''Name'' of the archive store and the base directory of the instance. Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~\Messages-2013-10</code>
* Click ''OK'' to create the new archive store.

=== Attach Existing Archive Store ===
Archive stores from MailStore Service Provider Edition instances or from on-premises MailStore Servers can be attached to an instance as described below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Attach Store''.
* Fill out the ''Attach Archive Store'' form:
*: [[File:Ms_spe_attach_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store
:* '''Archive new messages here:''' If checked, new message will be archived in the newly created archive store. (default: unchecked)
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. archive stores created before MailStore SPE/Server 10 do have the search index files located in the same directory as the database. So you have to activate this option and remove the \''Index'' directory from the ''Index Directory''-field.
:* '''Base Directory:''' Directory of the archive store to attach. This directory must contain the file "MailStoreFileGroup.fdb". Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~/2016-12</code>.
* Click ''OK'' to attach the archive store.

=== Unlock Archive Stores ===
In case the archive store was migrated from MailStore Server 10 or newer to MailStore SPE, additional steps are required.

==== The archive store is protected with a recovery key ====
* The archive store cannot be loaded successfully and the note ''Unable to unlock archive store (Identifier: <identifier>)'' appears.
: [[File:Ms_spe_attach_locked_generated_value.png|center]]
* To finalize the migration of this archive store you need to know the recovery key identified by <identifier>, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the recovery key. The recovery key must be entered in lowercase letters.
* Click ''Invoke'', ''true'' should appear below the text fields.
: [[File:Ms_spe_attach_unlock_generated_value.png|center]]
* Verify that the archive store was attached successfully.

==== The archive store is protected with a product key ====
* The archive store cannot be loaded successfully and the note ''Unable to open the archive store <name>. Can't decrypt encryption key.'' appears.
: [[File:Ms_spe_attach_locked_product_key.png|center]]
* To finalize the migration of this archive store you need to know the product key of the installation where the archive store was attached to last, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the product key. The product key must be entered in uppercase letters.
* Click ''Invoke'', ''true'' should appear.
: [[File:Ms_spe_attach_unlock_product_key.png|center]]
* Verify that the archive store was attached successfully.

More information about archive security can be found in the [https://help.mailstore.com/en/server/MailStore_Server_Service_Configuration#Security_and_Encryption MailStore Server Service Configuration article].

=== Maintain FS Databases ===
For storing meta data of the archive store's content embedded Firebird databases exist in every archive store. Under certain circumstances (e.g. after a disaster recovery of the server or storage) it might become necessary to perform a maintenance task on those databases. This can easily be done for all archive stores of a particular instance be following the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Maintain FS Databases'' to start the maintenance.
* A progress windows will appear.
* Wait until the process is completed successfully and click ''OK''. Otherwise click ''Cancel'' to interrupt maintenance process at any time.

=== Auto-Create Stores ===
From time to time, MailStore Service Provider Edition automatically creates a new archive store for optimal system performance and stability. The maximum size and amount of emails are determined internally by the system.

If needed, you can limit the size that an archive store can reach at most before a new one is created to align with your backup routine. You can also configure the storage location where new archive stores will be created automatically.

'''Important notice: '''The maximum size should not be configured manually without good reason, so that MailStore Service Provider Edition can determine the optimal time automatically for creating a new archive store.

To change these settings, please proceed as follows:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Auto-create''.
* Adjust the settings in the ''Auto-Create Archive Stores'' dialog.
*: [[File: Ms_spe_autocreate_stores_01.png|center]]
* Click ''OK'' to save the settings.

=== Store Commands ===
Advanced store commands are accessible by following these steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Select an archive store and click on ''Store Commands'' or right-click on an archive store to open a context menu.

A summary of the available store commands can be found in the tables below:

==== Requested State ====

{| class="wikitable"
! width="150px" | State
! Description
|-
| Disabled
| Disabled archive stores are not in use but the instance still knows about their existence. The content is not available to users or administrators while the archive store is disabled. This state is useful when moving archive stores to a new directory.
|-
| Write Protected
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| Normal
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| Current
| Same as ''Normal'' but new messages will be archived in the archive store that is set to ''Current''.
|}

==== Commands ====

{| class="wikitable"
! width="150px" | Command
! Description
|-
| Detach
| Detaches the selected archive store. The archive store can be re-attached by using the ''Attach'' function. Please note that the archive store's name and ID will not be retained when detaching and re-attaching. Therefore, when moving an archive store to a new location, disabling the the archive store and using ''Set Path'' afterwards is preferred over re-attaching.
|-
| Rename
| Specify a new name for the archive store.
|-
| Set Path
| Change the path of the archive store. The archive store must be disabled before changing the path. Please note that the file system directory must be moved manually to the new location before re-enabling the archive store.
|-
| Compact
| Optimizes the data structures.
|-
| Upgrade
| If an archive store from a MailStore Server was attached to an instance, it is highly recommended to upgrade the archive store to the latest format by using this function. Upgrade process can be interrupted and continued at any time.
|-
| Verify
| Verification of the data integrity between folder information and meta data as well as email headers, content and recovery records.
|-
| Recreate Recovery Records
| Recreates broken recovery records of an archive store. Use ''Verify'' to verify the state of the recovery records.
|}

=== Search Indexes ===
Additionally to container files storing the actual email content and the embedded Firebird databases used for storing meta information, a full-text index file is created for each archive that has emails stored in an archive store. By default the full-text index only included email bodies, but virtually any file type is supported (see ''Configure'').

To access these functions, follow the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Search Indexes''.

The below functions are available in the search index menu to configure and maintain the full-text indexes of an instance.

==== Rebuild Broken Indexes ====
Starts a rebuild of all search indexes across all archive stores that are marked as broken.

==== Rebuild All Indexes ====
Starts a rebuild of all search indexes in all archives stores.
This is usually only required after making changes to the list of attachment extensions to be included in the full-text index.

==== Configure ====
Specify a list of file extensions for attachments to be included in the full-text index. MailStore Service Provider Edition can index all file types for which a so-called IFilter driver is installed on the instance host on which the MailStore instance is running. The list of file extensions has to be separated by space.

[[File: Ms_spe_file_extensions.png|center]]

Under the name [http://www.microsoft.com/en-us/download/details.aspx?id=17062 Microsoft Office 2010 Filter Packs] Microsoft offers a package that, additionally to all legacy as well as recent Microsoft Office Formats, supports the Open Document Format (OpenOffice/LibreOffice). For indexing PDF files the Adobe Reader or [ftp://ftp.adobe.com/pub/adobe/acrobat/win/11.x/PDFFilter64Setup.msi Adobe PDF iFilter] (Internet Explorer or FTP client necessary for download) must be installed on the instance host. Further background information about the IFilter system itself as well as links to additional IFilter drivers can be found in the corresponding Wikipedia article [[wikipedia:IFilter|IFilter]].

:'''Important Notices:'''
* Take note of the [https://www.adobe.com/devnet-docs/etk_deprecated/tools/AdminGuide/Acrobat_Reader_IFilter_configuration.pdf installation instructions] of the 64bit IFilter. Especially adding the ''bin'' folder of the IFilter installation folder to the ''PATH'' system variable increases indexing speed a lot. The ''PATH'' system variable can be adjusted via an administrative command prompt (cmd) and then rundll32 sysdm.cpl,EditEnvironmentVariables
* Newer versions of Adobe Acrobat Reader do not contain an IFilter. Thus, please deactivate the automatic update function of Adobe Acrobat Reader 11.

For reasons of stability and performance, MailStore Service Provider Edition processes the following file types directly, regardless of the IFilter drivers that are installed:

* Text files (TXT)
* HTML files (HTM and HTML)

== Archive Access ==
{{:Accessing Instances}}

=== Inside the Instance ===
No matter whether logging on to an instance as the customer's administrator or as service provider via service provider archive access, the available functions of the MailStore Client are nearly the same. Only accessing and or modifying the archive content (e.g. creating folders, deleting messages,..) is prohibited for the ''$archiveadmin'' user.

Please refer to [[Instance Administration]] to get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.

== Live Statistics ==
The ''Live Statistics'' tab shows real time graphics about the instance activity such as I/O, memory and CPU usage as well as number of Remote Procedure Calls (RPC) and the number of emails verified and archived by the instance's archiving mechanism.

End User Access

2021-07-15T14:54:59Z

Bmeyn:

__NOTOC__

The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.

Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.

As both applications are identical to [[msserver:Accessing_the_Archive_with_the_MailStore_Client_software|MailStore Client]] and [[msserver:Accessing_the_Archive_with_the_Microsoft_Outlook_integration|MailStore Outlook Add-in]], their [[msserver:System_Requirements|system requirements]] can be found in the MailStore Server help.

== E-mail Archive Client ==
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:

* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
*:[[File:Ms_spe_access_client_01.png|center]]
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.
* Click ''Connect'' to connect.
* The E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.
* Enter your username.
*:[[File:Ms_spe_access_client_02.png|center]]
* Click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
*:[[File:Ms_spe_access_client_03.png|center]]
** If the user has been synchronized from Microsoft 365 or Google Workspace, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== E-mail Archive Add-in for Outlook ==
* Open Microsoft Outlook.
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook.
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Click ''Connect'' to continue.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google Workspace, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== Web Access ==
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.
Mobile devices are supported.

* Open a web browser.
* Navigate to Web Access. The URL is <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog as shown below appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google Workspace, the web browser will be redirected to allow authentication through Microsoft's or Google's authentication service.

== IMAP Client ==
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings.

When using Microsoft or Google to authenticate users at login, accessing the archive via IMAP is not possible for technical reasons.

* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.
* '''Password''' - Password which is required for accessing the MailStore instance.

'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.

System Requirements

2021-06-07T09:15:36Z

Bmeyn:

__NOTOC__
Before beginning the installation of MailStore Service Provider Edition it needs to be ensured that all system requirements are met.

== Hardware ==
=== Single Server Mode or Individual Instance Hosts ===
The calculator below helps to specify the hardware needs in a single server mode setup or for an individual instance host in a multi-server mode setup subject to the number of users, instances, stored email, and the [[msserver:Choosing_the_Right_Archiving_Strategy|archiving strategy]].
'''Important Notice:''' To ensure the stability and performance of a single server or instance host installation, these hardware requirements must be met at all times at a minimum. For example, in a hosted virtual server environment, servers with exclusively dedicated resources should be used instead of servers that share their resources with other machines.

==== System Requirements Calculator ====
Calculations are based on the following base values:

* Email Volume (User/Year): 10000
* Email Size: 75Kb
* Compression Ratio: 60%

<system_requirements />

=== Management Server ===
This information only applies to an individual Management Server in a multi-server setup.

{| class="wikitable" width="100%"
! width="150" scope="row" | '''Processor'''
| Any x64 compatible CPU
|-
! width="150" scope="row" | '''Main Memory'''
| 2 GB
|-
! width="150" scope="row" | '''Hard Disk'''
| 150 MB available disk space
|-
! width="150" scope="row" | '''Network Bandwidth'''
| 100 MBit/s
|}

=== Client Access Server ===
This information only applies to an individual Client Access Server in a multi-server setup.

{| class="wikitable" width="100%"
! width="150" scope="row" | '''Processor'''
| Any x64 compatible CPU
|-
! width="150" scope="row" | '''Main Memory'''
| 2 GB
|-
! width="150" scope="row" | '''Hard Disk'''
| 150 MB available disk space
|-
! width="150" scope="row" | '''Network Bandwidth'''
| 100 MBit/s
|}

== Software Requirements ==
The below system requirements only apply to MailStore Service Provider Edition and its components. Client applications such as the E-mail Archive Client and E-mail Archive Add-in for Outlook have their own system requirements. As both applications are identical to MailStore Client and MailStore Outlook Add-in, their [[msserver:System Requirements|system requirements]] can be found in the MailStore Server help.

* Following operating systems are supported
** Windows Server 2008 R2 SP1 Standard, Enterprise or Datacenter (Server Core Installation)
** Windows Server 2008 R2 SP1 Standard, Enterprise or Datacenter (Server with a GUI)
** Windows Server 2012 Standard or Datacenter (Server Core Installation)
** Windows Server 2012 Standard or Datacenter (Server with a GUI)
** Windows Server 2012 R2 Standard or Datacenter (Server Core Installation)
** Windows Server 2012 R2 Standard or Datacenter (Server with a GUI)
** Windows Server 2016 Standard or Datacenter (Server Core Installation)
** Windows Server 2016 Standard or Datacenter (Server with a GUI)
** Windows Server 2019 Standard or Datacenter (Server without Desktop Experience)
** Windows Server 2019 Standard or Datacenter (Server with Desktop Experience)
* Following web browsers are supported by the Management Console:
** Microsoft Edge
** Microsoft Internet Explorer 10 or higher
** Google Chrome 18 or higher
** Mozilla Firefox 18 or higher
** Apple Safari 6 or higher
* '''.NET Framework 4.5.1''' The appropriate Windows Server feature will be enabled automatically by the MailStore Service Provider Edition installer. In environments with centrally managed Windows updates the automatic installation may not succeed. In such cases the installation of the .NET Framework 4.5.1 feature must be done manually before executing the MailStore Service Provider Edition setup file. '''Important Notice:''' On Windows Server 2008 R2 Core, the features ''NetFx2-ServerCore'' and ''NetFx2-ServerCore-WOW64'' must be installed prior to executing the setup. Otherwise the .NET Framework 4.5.1 installer fails silently.
* '''IFilter drivers''' ''(optional)'' For indexing email attachments other than TXT and HTML files, additional IFilter drivers are required. Please refer to [[Instance_Management#Search_Indexes|Search Index]] for further details about attachment indexing.
* It is not recommended to install MailStore Service Provider Edition on servers that already provide other network services. Especially with email or web servers TCP port conflicts are likely to occur. Specifically, Microsoft's Internet Information Server (IIS) MUST NOT be installed on any server that hosts the Client Access Server role.

== Network Requirements ==
* Verify that the DNS name of the MailStore Service Provider Edition servers match their actual computer name and that all servers have a proper forward and reverse DNS resolution configured.
* Do not intercept connections from or to MailStore Service Provider Edition servers with web or email proxies. Read [[msserver:Notes_on_Antivirus_Software|Notes on Antivirus Software]] in the MailStore Server help for further details.
* To guarantee a decent user experience, the available bandwidth of the network connectivity should be at least 100 MBit/s (symmetric).
* The Management Server Role must be able to access ''my.mailstore.com'' permanently on port 443.
* For communication between MailStore Service Provider Edition services, access to the MailStore Management Console and end user access to instances, the following TCP ports are opened by the MailStore Service Provider Edition services and must therefore not be used by any other service.

{| class="wikitable"
! width="100px" | Port
! width="150px" | Role
! Description
|-
| align="center"| 143
| align="center"| Client Access Server
| The standard IMAP port is used to provide read-only access to archived emails via IMAP protocol. The IMAP server on this port supports unencrypted as well as TLS secured connections (recommended) that have been initiated by the email client via STARTTLS command.
|-
| align="center"| 443
| align="center"| Client Access Server
| The standard HTTPS port is used to provide SSL encrypted access to MailStore Instances via MailStore Client, MailStore Outlook Add-in, MailStore Web Access and MailStore Mobile Web Access.
|-
| align="center"| 993
| align="center"| Client Access Server
| The standard IMAPS port is used to provide read-only access to archived emails via IMAP protocol. The IMAP server on this port support SSL/TLS encrypted connections only.
|-
| align="center"| 8470
| align="center"| Management Server
| This port is used to provide administrators access to the Management Console via web browser. The HTTP server on this port support SSL/TLS encrypted connections only, also known as HTTPS.
|-
| align="center"| 8471
| align="center"| Management Server
| Instance Hosts and Client Access Servers connect to the Management Server through this port.
|-
| align="center"| 8472
| align="center"| Instance Host
| Client Access Servers and the Management Server connect to the Instance Hosts through this port.
|-
| align="center"| 8473
| align="center"| Client Access Server
| Management Server connects to Client Access Servers through this port.
|}

Update Notices

2021-06-02T07:42:05Z

Bmeyn:

== General Information ==
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version. The installation directory has to be adjusted manually in case the old version has been installed in a non default directory.
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server
* After each update check the files in the sample branding folder to identify if new settings or template variables have been introduced.
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.

== Upgrading to 13.x ==
* '''Update of MailStore Client and Outlook Add-in''' Irrespective of MailStore Client's auto-update mechanism, a reinstallation of MailStore Client and the MailStore Outlook Add-in is required to make use of the following improvements:
** Unified validation of TLS certificates.
** Unified evaluation of group policies.
** Distinct error messages for certain certificate errors.
** Outlook Add-in: Due to the required changes of the login process to support modern authentication with Microsoft 365 and Google Workspace, the Outlook Add-in must be updated to version 13 to be able to connect to MailStore Server 13.x. Connecting to an older version of MailStore Server is no longer supported after the update.
* '''Microsoft 365 Support'''
*; A new directory service synchronization profile ''Microsoft 365 (Modern Authentication)'' as well as new profiles for archiving and exporting emails from or to Microsoft 365 have been introduced. These support modern authentication (OAuth 2.0 & OpenID Connect) and customers of Microsoft 365 are advised to regularly check for Microsoft's announcement on the timeline for removing HTTP Basic Auth from Microsoft Exchange Web Services (EWS) and to plan the migration to the new profiles in advance. Once Microsoft disables support for HTTP Basic Auth in Exchange Web Services on Microsoft 365, the existing directory service synchronization profile ''Microsoft 365 (Basic Auth)'' (formerly named ''Office 365'') and the Microsoft Exchange archiving and export profiles will stop working.
* '''Google Workspace Support'''
*; The ''Google Workspace'' directory service synchronization profile has been extended with support for modern authentication (OAuth 2.0 & OpenID Connect). Customers of Google Workspace are advised to regularly check for Google's announcement on the timeline for removing support for less secure apps, and should plan the migration to the new setting in advance. Once Google disables support for Less Secure Apps in Google Workspace, the existing directory service synchronization profile ''Google Workspace'' will no longer allow users to login to MailStore as long as the authentication method is still set to ''IMAP''.
* '''GPO Templates'''
*; GPO templates are now bundled with the application. End customers may download the GPO templates from the default page of the Client Access Server. See the index.html file in the sample branding folder on how to integrate the corresponding link. As the Email Archive Client and Email Archive Outlook Add-in use the same registry keys as MailStore Server and MailStore Outlook Add-in, the GPO templates provided are those bundled with the original MailStore products.
* '''IMAP Access to Archive'''
*; When using either the new ''Microsoft 365 (Modern Authentication)'' or ''Google Workspace'' directory service synchronization profile, users that have been added by these profiles cannot access their archive via the integrated IMAP server as a MailStore SPE instance is not able to verify their credentials by itself.
* '''Mobile Web Access'''
*; The dedicated Mobile Web Access has been removed due to no longer supported third-party components (e.g. jQuery Mobile) and in favor of MailStore Web Access, which has been received major enhancements in terms of performance and usability.
* '''Legacy Web Access'''
*; As parts of Legacy Web Access are representing the server-side of the Outlook Add-in, the Legacy Web Access is still present, but no longer advertised on the login screen of the Web Access.
* '''Group Policies'''
*; The following group policy settings are no longer supported in MailStore 13:
** '''MailStore Client: Accept Thumbprint'''
**; If a server name has been defined by a group policy, the certificate used by the Client Access Server must be trusted by the client computer and it must not be revoked or expired.
** '''MailStore Outlook Add-in: Accept Thumbprint'''
**; If a server name has been defined by a group policy, the certificate used by the Client Access Server must be trusted by the client computer and it must not be revoked or expired.

== Upgrading to 12.1 ==
* '''TLS Compatibility''' To connect to Instances in environments that support TLS version 1.1 or 1.2 only via the MailStoreCmd command line util, the Email Archive Client launcher must be updated by downloading and reinstalling it either manually or through a GPO.

== Upgrading to 12 ==
* '''Expired Certificates'''
*; Irrespective of whether the certificate's trust can be verified, no connection is established by the E-Mail Archive Client to Client Access Server's whose certificate has expired or was revoked. In such a case, the certificate on the Client Access Server must be replaced first.

== Upgrading to Version 11 ==
* '''Upgrading Archive Stores'''
*; '''Depending on the archive size this can take an excessive amount of time. On average 50.000 messages are processed per minute during the upgrade.'''
*; Until the archive stores have been upgraded, not all functionality of the software is available. To facilitate
** retention policies,
** the search functionality,
** the improved recovery records,
*; the databases of the archive stores must be upgraded.
*; Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
* '''Retention Policies''' If not all attached archive stores are available (State: ''Archive here'', ''Normal''), or their status is ''Write-Protected'', no automatic processing of retention policies takes place. Therefore verify if an archive store is set to ''Disabled'' or ''Write-Protected'' after the upgrade and change it to one of the above states or detach it completely. Please notice that only end customers are allowed to manage retention policies.
* '''Jobs''' With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.
* '''Access via Integrated IMAP Server''' To access the archive via the integrated IMAP server, an encrypted connection is now mandatory. If necessary, adjust the configuration of your email clients accordingly and enable TLS or STARTTLS.
* '''SMTP Settings''' In order to being able to select system administrators as notification recipients in the new SMTP settings, the email address needs to be configured in the properties of the corresponding system administrator.
* '''Management API Commands Get-/SetComplianceConfiguration''' The property ''globalRetentionTimeYears'' has been removed from the commands. Own scripts using these commands have to be adjusted accordingly. To manage retention policies, two new commands are available: ''GetRetentionPolicies'' and ''SetRetentionPolicies''.

== Upgrading to 10.2 ==
* '''Branding''' For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.

== Upgrading to 10.1 ==
* '''Archiving Emails''' If not all attached archive stores are available (State: ''Archive here'', ''Normal'', or ''Write-Protected''), no archiving takes place. Running archiving profiles are terminated with an appropriate message. Under certain circumstances this prevents the creation of duplicate emails while archiving. Therefore verify if an archive store is set to ''disabled'' after the upgrade and change it to one of the above states or detach it completely.

== Upgrading to Version 10 ==
* '''Upgrade of Master Database''' To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.
* '''Upgrading Archive Stores''' To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
* '''Archives of Other Users''' These are no longer visible for instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked. Administrative functions such as deleting or renaming user archives are accessible through ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.
* '''Export E-mails''' The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.
* '''Auditing''' All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.

== Upgrading to Version 9.x ==
* '''System Requirements''' Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.
* '''E-mail Archive Client Compatibility''' Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.
* '''PDF Support of Full Text Search''' PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.
* '''MailStore Management API''' The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.

Instance Administration

2021-06-02T07:36:31Z

Bmeyn: /* Users and Privileges */

The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.

'''Important:''' Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the Client Access Server, and that in URLs the Instance ID needs to be added. '''Example:''' In case of the ''Redirect URI'' for modern authentication with Microsoft 365 or Google Workspace <tt>https://<fqdn>/oidc/signin</tt> needs to become <tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>.

== Archive Email ==
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.

If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].

In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.

=== Email Servers ===
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:

'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.

{{msserver::Implementation}}

For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:

* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]

=== Email Clients ===

==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].

=== Email Files ===
==== Archiving Outlook PST Files ====
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].

==== Archiving EML or MBOX Files ====
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].

== Export Email ==
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.

Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.

'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].

== Administrative Tools ==
The ''Administrative Tools'' provides access to the following settings:

{| width="100%" cellspacing="3" cellpadding="4"
| valign="top" width="50%"|
=== Users and Privileges ===
* [[msserver:Users, Folders and Settings|Users]]
* '''Directory Services'''
** [[msserver:Active Directory Integration|Active Directory]]
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]
** [[msserver:Application Integration|Application Integration]]
** [[msserver:Google_Workspace-Integration|Google Workspace]]
** [[msserver:IceWarp Server Integration|IceWarp Server]]
** [[msserver:Kerio Connect Integration|Kerio Connect]]
** [[msserver:Generic LDAP Integration|LDAP Generic]]
* [[msserver:Users, Folders and Settings|Privileges]]
* [[msserver:Archives|Archives]]
| valign="top" width="50%"|

=== Compliance ===
* [[msserver:Compliance General|Compliance General]]
** [[msserver:Retention Policies|Retention Policies]]
* [[msserver:Auditing|Auditing]]
* [[msserver:Audit Log|Audit Log]]

=== Management API ===
* [[msserver:MailStore Server Management Shell|Command Prompt]]
* [[msserver:Jobs|Jobs]]
* [[msserver:Job Results|Job Results]]
=== Miscellaneous ===
* [[msserver:SMTP Settings|SMTP Settings]]
* [[msserver:Active Sessions|Active Sessions]]
|}

Instance Administration

2021-06-02T07:35:23Z

Bmeyn:

The core functionality of an instance is identical to that of an on-premises MailStore Server. Therefore, this article is a collection of links to the corresponding section of the MailStore Server help.

'''Important:''' Be aware that host names referring to MailStore Server are typically need to be replaced by the host name of the Client Access Server, and that in URLs the Instance ID needs to be added. '''Example:''' In case of the ''Redirect URI'' for modern authentication with Microsoft 365 or Google Workspace <tt>https://<fqdn>/oidc/signin</tt> needs to become <tt>https://<fqdn_of_cas>/<instance_id>/oidc/signin</tt>.

== Archive Email ==
Emails can be archived from the mailboxes of email servers such as Microsoft Exchange as well as from the locally installed email clients of the users. Dependent on its type, archiving tasks can be performed continuously, manually or based on a schedule.

If you are not sure which archiving method best suits your company, please refer to chapter [[msserver:Choosing the Right Archiving Strategy|Choosing the Right Archiving Strategy]].

In chapter [[msserver:Email Archiving with MailStore Basics|Email Archiving with MailStore Basics]] you can find out more about working with archiving profiles, archiving specific folders, deleting emails after archiving and automating the archiving process.

=== Email Servers ===
A large collection of email servers is supported by MailStore for archiving email. As the actual procedure of setting up archiving depends on the email server you are using, specific instruction for well-known email servers are provided in our Implementation Guides below:

'''Please note:''' For various reasons, not all email servers and archiving strategies are fully supported in MailStore SPE (e.g. Gmail, MailStore Proxy). When in doubt, contact our technical support.

{{msserver::Implementation}}

For IMAP and POP3 servers, that are not listed above, the following generic instruction might be helpful:

* [[msserver:Archiving Server Mailboxes|Archiving Single Mailboxes]]
* [[msserver:Archiving IMAP and POP3 Multidrop Mailboxes|Archiving Multidrop Mailboxes]]
* [[msserver:Batch-archiving IMAP Mailboxes|Batch-archiving IMAP Mailboxes]]

=== Email Clients ===

==== Archiving Email from Outlook, Thunderbird and Other E-mail Clients ====
As opposed to all other archiving features, it is imperative that the E-mail Archive Client software is installed on the user computers when archiving emails from these users' email applications. Once the archiving task is set up, it can be started manually by the user or executed automatically according to a schedule. Additional information about this topic is available in chapter [[msserver:Archiving Email from Outlook, Thunderbird and others|Archiving Email from Outlook, Thunderbird and others]].

=== Email Files ===
==== Archiving Outlook PST Files ====
As administrator, you can archive Microsoft Outlook PST files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Outlook PST Files Directly|Archiving Outlook PST Files Directly]].

==== Archiving EML or MBOX Files ====
As administrator, you can archive emails from .eml or .msg files for other MailStore users. Additional information about these topics is available in chapter [[msserver:Archiving Emails from External Systems (File Import)|Archiving Emails from External Systems (File Import)]].

== Export Email ==
MailStore provides several functions regarding the export of archived emails. Emails can be exported directly into server mailboxes, or to the file system as individual email files (EML or MSG format), for example.

Find detailed instruction in the [[msserver:Exporting_Email|Exporting Email]] article of the MailStore Server Help.

'''Please note:''' Backup strategies (a backup of the entire archive) are discussed separately in the article [[Backup and Restore]].

== Administrative Tools ==
The ''Administrative Tools'' provides access to the following settings:

{| width="100%" cellspacing="3" cellpadding="4"
| valign="top" width="50%"|
=== Users and Privileges ===
* [[msserver:Users, Folders and Settings|Users]]
* '''Directory Services'''
** [[msserver:Active Directory Integration|Active Directory]]
** [[msserver:Synchronizing_User_Accounts_with_Microsoft_365_(Modern_Authentication)|Microsoft 365 (Modern Authentication)]]
** [[msserver:Office 365 Integration|Microsoft 365 (Basic Authentication)]]
** [[msserver:Application Integration|Application Integration]]
** [[msserver:G Suite Integration|G Suite]]
** [[msserver:IceWarp Server Integration|IceWarp Server]]
** [[msserver:Kerio Connect Integration|Kerio Connect]]
** [[msserver:Generic LDAP Integration|LDAP Generic]]
* [[msserver:Users, Folders and Settings|Privileges]]
* [[msserver:Archives|Archives]]
| valign="top" width="50%"|

=== Compliance ===
* [[msserver:Compliance General|Compliance General]]
** [[msserver:Retention Policies|Retention Policies]]
* [[msserver:Auditing|Auditing]]
* [[msserver:Audit Log|Audit Log]]

=== Management API ===
* [[msserver:MailStore Server Management Shell|Command Prompt]]
* [[msserver:Jobs|Jobs]]
* [[msserver:Job Results|Job Results]]
=== Miscellaneous ===
* [[msserver:SMTP Settings|SMTP Settings]]
* [[msserver:Active Sessions|Active Sessions]]
|}

End User Access

2021-06-02T07:33:43Z

Bmeyn: /* Web Access */

__NOTOC__

The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.

Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.

As both applications are identical to MailStore Client and MailStore Outlook Add-in, their [https://help.mailstore.com/en/server/System_Requirements system requirements] can be found in the MailStore Server help.

== E-mail Archive Client ==
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:

* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
*:[[File:Ms_spe_access_client_01.png|center]]
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.
* Click ''Connect'' to connect.
* The E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.
* Enter your username.
*:[[File:Ms_spe_access_client_02.png|center]]
* Click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
*:[[File:Ms_spe_access_client_03.png|center]]
** If the user has been synchronized from Microsoft 365 or Google Workspace, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== E-mail Archive Add-in for Outlook ==
* Open Microsoft Outlook.
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook.
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Click ''Connect'' to continue.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google Workspace, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== Web Access ==
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.
Mobile devices are supported.

* Open a web browser.
* Navigate to Web Access. The URL is <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog as shown below appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google Workspace, the web browser will be redirected to allow authentication through Microsoft's or Google's authentication service.

== IMAP Client ==
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings.

When using Microsoft or Google to authenticate users at login, accessing the archive via IMAP is not possible for technical reasons.

* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.
* '''Password''' - Password which is required for accessing the MailStore instance.

'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.

End User Access

2021-06-02T07:33:26Z

Bmeyn: /* E-mail Archive Add-in for Outlook */

__NOTOC__

The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.

Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.

As both applications are identical to MailStore Client and MailStore Outlook Add-in, their [https://help.mailstore.com/en/server/System_Requirements system requirements] can be found in the MailStore Server help.

== E-mail Archive Client ==
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:

* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
*:[[File:Ms_spe_access_client_01.png|center]]
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.
* Click ''Connect'' to connect.
* The E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.
* Enter your username.
*:[[File:Ms_spe_access_client_02.png|center]]
* Click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
*:[[File:Ms_spe_access_client_03.png|center]]
** If the user has been synchronized from Microsoft 365 or Google Workspace, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== E-mail Archive Add-in for Outlook ==
* Open Microsoft Outlook.
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook.
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Click ''Connect'' to continue.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google Workspace, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== Web Access ==
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.
Mobile devices are supported.

* Open a web browser.
* Navigate to Web Access. The URL is <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog as shown below appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google G Suite, the web browser will be redirected to allow authentication through Microsoft's or Google's authentication service.

== IMAP Client ==
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings.

When using Microsoft or Google to authenticate users at login, accessing the archive via IMAP is not possible for technical reasons.

* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.
* '''Password''' - Password which is required for accessing the MailStore instance.

'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.

End User Access

2021-06-02T07:32:55Z

Bmeyn: /* E-mail Archive Client */

__NOTOC__

The logon process for customers to administrate their MailStore Instance or to access their archives varies slightly from the logon process of an on-premises MailStore Server.

Find detailed information about logging in with E-mail Archive Client and E-mail Archive Add-in for Outlook below. Additionally find information about how to log on to Web Access using a web browser or the integrated IMAP server using any IMAP capable email client.

As both applications are identical to MailStore Client and MailStore Outlook Add-in, their [https://help.mailstore.com/en/server/System_Requirements system requirements] can be found in the MailStore Server help.

== E-mail Archive Client ==
Customers' administrators can access their own MailStore Instance with the E-mail Archive Client by using the credentials received from their service provider. End users can use the same client to archive or export email or to access their archived email. Follow the instructions below for logging on with E-mail Archive Client:

* Open the E-mail Archive Client by using the link ''E-mail Archive'' on the desktop.
* Select the preferred language from the ''Language'' drop down list and enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
*:[[File:Ms_spe_access_client_01.png|center]]
*: '''Hint:''' The language and server name can be saved to skip this step in the future by activating the ''Always connect to this server'' option. To change the settings again, start E-mail Archive Client while keeping the <tt>SHIFT</tt>-key pressed.
* Click ''Connect'' to connect.
* The E-mail Archive Client will update itself to become compatible with the provider's version of MailStore Service Provider Edition if necessary.
* Enter your username.
*:[[File:Ms_spe_access_client_02.png|center]]
* Click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
*:[[File:Ms_spe_access_client_03.png|center]]
** If the user has been synchronized from Microsoft 365 or Google Workspace, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== E-mail Archive Add-in for Outlook ==
* Open Microsoft Outlook.
* If the E-mail Archive Add-in for Outlook is not pre-configured, you will be asked to log in to your MailStore Instance as soon as you click any button of the E-mail Archive Add-in for Outlook.
* Enter the URL to connect to in the ''Server Name'' field. The URL must be in the format <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Click ''Connect'' to continue.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google G Suite, the default web browser will be opened to allow authentication through Microsoft's or Google's authentication service.

== Web Access ==
End users can access their archived email easily via any [[System Requirements|supported web browser]], by following the instructions below.
Mobile devices are supported.

* Open a web browser.
* Navigate to Web Access. The URL is <tt>https://<[[wikipedia:FQDN|fqdn]]_of_cas>/<instance_id_or_alias></tt>.
* Enter your username in the ''User Name'' field and click ''Next'' to continue.
* The MailStore Instance now determines how the user is to be authenticated.
** If the instance is able to verify the user's credentials itself, the password dialog as shown below appears. Enter the password into the ''Password'' field and click on ''Log in''
** If the user has been synchronized from Microsoft 365 or Google G Suite, the web browser will be redirected to allow authentication through Microsoft's or Google's authentication service.

== IMAP Client ==
Archived emails can be accessed via an integrated IMAP server with any IMAP capable email client using the following settings.

When using Microsoft or Google to authenticate users at login, accessing the archive via IMAP is not possible for technical reasons.

* '''Incoming Mail Server''' - Host name or IP address of a Client Access Server
* '''Port''' - For STARTTLS-encrypted connections (explicit TLS) standard IMAP port 143 is used. For implicit TLS encrypted connections standard IMAP port 993 is used. Login over unencrypted connections is not supported.
* '''User Name''' - Name of the MailStore user prepended by his instance id or alias <tt><instance_id_or_alias>/<username></tt>, e.g. <tt>jdcorp/jon.doe</tt>.
* '''Password''' - Password which is required for accessing the MailStore instance.

'''Please note:''' In addition to configuring the incoming mail server, email clients often require configuring the outgoing mail server as well. In this case, using the same data as for an existing email account will facilitate further processing emails from the email archive.

Instance Management

2021-05-11T07:19:46Z

Bmeyn: /* Configure */

For each instance further individual administrative functions exist. These functions are accessible through the instance details, which appear in pane below the instance list (''General > Instances'') of the Management Console when clicking on a running instance in the list.

All these functions are group by tabs, for which further details are provided below.

== Overview ==
On the ''Overview'' tab of the instance details a summary of the configuration is shown.

[[File:Ms_spe_instance_overview.png|center]]

== Archive Stores ==
The ''Archive Stores'' tab allows the administration of the instance storage as well as the search indexes. New archive stores are automatically created in the base directory of the instance every 5.000.000 messages.

=== Create Archive Stores ===
Although MailStore Service Provider Edition creates new archive stores automatically, this can also be done manually as described in the following:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Create Store''.
* Fill out the ''Create Archive Store'' form:
*: [[File:Ms_spe_create_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store.
:* '''Archive new messages here:''' Enabled by default, new message will be archived in the newly created archive store if this option is checked.
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. the database and index directory may reside on a fast storage while the content resides in on a slower storage.
:* '''Directory:''' Directory in which the new archive store will be created. A proposal is created from the ''Name'' of the archive store and the base directory of the instance. Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~\Messages-2013-10</code>
* Click ''OK'' to create the new archive store.

=== Attach Existing Archive Store ===
Archive stores from MailStore Service Provider Edition instances or from on-premises MailStore Servers can be attached to an instance as described below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Attach Store''.
* Fill out the ''Attach Archive Store'' form:
*: [[File:Ms_spe_attach_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store
:* '''Archive new messages here:''' If checked, new message will be archived in the newly created archive store. (default: unchecked)
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. archive stores created before MailStore SPE/Server 10 do have the search index files located in the same directory as the database. So you have to activate this option and remove the \''Index'' directory from the ''Index Directory''-field.
:* '''Base Directory:''' Directory of the archive store to attach. This directory must contain the file "MailStoreFileGroup.fdb". Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~/2016-12</code>.
* Click ''OK'' to attach the archive store.

=== Unlock Archive Stores ===
In case the archive store was migrated from MailStore Server 10 or newer to MailStore SPE, additional steps are required.

==== The archive store is protected with a recovery key ====
* The archive store cannot be loaded successfully and the note ''Unable to unlock archive store (Identifier: <identifier>)'' appears.
: [[File:Ms_spe_attach_locked_generated_value.png|center]]
* To finalize the migration of this archive store you need to know the recovery key identified by <identifier>, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the recovery key. The recovery key must be entered in lowercase letters.
* Click ''Invoke'', ''true'' should appear below the text fields.
: [[File:Ms_spe_attach_unlock_generated_value.png|center]]
* Verify that the archive store was attached successfully.

==== The archive store is protected with a product key ====
* The archive store cannot be loaded successfully and the note ''Unable to open the archive store <name>. Can't decrypt encryption key.'' appears.
: [[File:Ms_spe_attach_locked_product_key.png|center]]
* To finalize the migration of this archive store you need to know the product key of the installation where the archive store was attached to last, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the product key. The product key must be entered in uppercase letters.
* Click ''Invoke'', ''true'' should appear.
: [[File:Ms_spe_attach_unlock_product_key.png|center]]
* Verify that the archive store was attached successfully.

More information about archive security can be found in the [https://help.mailstore.com/en/server/MailStore_Server_Service_Configuration#Security_and_Encryption MailStore Server Service Configuration article].

=== Maintain FS Databases ===
For storing meta data of the archive store's content embedded Firebird databases exist in every archive store. Under certain circumstances (e.g. after a disaster recovery of the server or storage) it might become necessary to perform a maintenance task on those databases. This can easily be done for all archive stores of a particular instance be following the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Maintain FS Databases'' to start the maintenance.
* A progress windows will appear.
* Wait until the process is completed successfully and click ''OK''. Otherwise click ''Cancel'' to interrupt maintenance process at any time.

=== Auto-Create Stores ===
MailStore Service Provider Edition automatically creates new archive stores every 5.000.000 messages. This setting can be adjusted to your need:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Auto-create''.
* Adjust the settings in the ''Auto-Create Archive Stores'' dialog.
*: [[File: Ms_spe_autocreate_stores_01.png|center]]
*: '''Important notice:''' Non-optimal settings can have a negative impact on the overall performance of the instance.
* Click ''OK'' to save the settings.

=== Store Commands ===
Advanced store commands are accessible by following these steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Select an archive store and click on ''Store Commands'' or right-click on an archive store to open a context menu.

A summary of the available store commands can be found in the tables below:

==== Requested State ====

{| class="wikitable"
! width="150px" | State
! Description
|-
| Disabled
| Disabled archive stores are not in use but the instance still knows about their existence. The content is not available to users or administrators while the archive store is disabled. This state is useful when moving archive stores to a new directory.
|-
| Write Protected
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| Normal
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| Current
| Same as ''Normal'' but new messages will be archived in the archive store that is set to ''Current''.
|}

==== Commands ====

{| class="wikitable"
! width="150px" | Command
! Description
|-
| Detach
| Detaches the selected archive store. The archive store can be re-attached by using the ''Attach'' function. Please note that the archive store's name and ID will not be retained when detaching and re-attaching. Therefore, when moving an archive store to a new location, disabling the the archive store and using ''Set Path'' afterwards is preferred over re-attaching.
|-
| Rename
| Specify a new name for the archive store.
|-
| Set Path
| Change the path of the archive store. The archive store must be disabled before changing the path. Please note that the file system directory must be moved manually to the new location before re-enabling the archive store.
|-
| Compact
| Optimizes the data structures.
|-
| Upgrade
| If an archive store from a MailStore Server 5 or older was attached to an instance, it is highly recommended to upgrade the archive store to the latest format by using this function. Upgrade process can be interrupted and continued at any time.
|-
| Verify
| Verification of the data integrity between folder information and meta data as well as email headers, content and recovery records.
|-
| Recreate Recovery Records
| Recreates broken recovery records of an archive store. Use ''Verify'' to verify the state of the recovery records.
|}

=== Search Indexes ===
Additionally to container files storing the actual email content and the embedded Firebird databases used for storing meta information, a full-text index file is created for each archive that has emails stored in an archive store. By default the full-text index only included email bodies, but virtually any file type is supported (see ''Configure'').

To access these functions, follow the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Search Indexes''.

The below functions are available in the search index menu to configure and maintain the full-text indexes of an instance.

==== Rebuild Broken Indexes ====
Starts a rebuild of all search indexes across all archive stores that are marked as broken.

==== Rebuild All Indexes ====
Starts a rebuild of all search indexes in all archives stores.
This is usually only required after making changes to the list of attachment extensions to be included in the full-text index.

==== Configure ====
Specify a list of file extensions for attachments to be included in the full-text index. MailStore Service Provider Edition can index all file types for which a so-called IFilter driver is installed on the instance host on which the MailStore instance is running. The list of file extensions has to be separated by space.

[[File: Ms_spe_file_extensions.png|center]]

Under the name [http://www.microsoft.com/en-us/download/details.aspx?id=17062 Microsoft Office 2010 Filter Packs] Microsoft offers a package that, additionally to all legacy as well as recent Microsoft Office Formats, supports the Open Document Format (OpenOffice/LibreOffice). For indexing PDF files the Adobe Reader or [ftp://ftp.adobe.com/pub/adobe/acrobat/win/11.x/PDFFilter64Setup.msi Adobe PDF iFilter] (Internet Explorer or FTP client necessary for download) must be installed on the instance host. Further background information about the IFilter system itself as well as links to additional IFilter drivers can be found in the corresponding Wikipedia article [[wikipedia:IFilter|IFilter]].

:'''Important Notices:'''
* Take note of the [https://www.adobe.com/devnet-docs/etk_deprecated/tools/AdminGuide/Acrobat_Reader_IFilter_configuration.pdf installation instructions] of the 64bit IFilter. Especially adding the ''bin'' folder of the IFilter installation folder to the ''PATH'' system variable increases indexing speed a lot. The ''PATH'' system variable can be adjusted via an administrative command prompt (cmd) and then rundll32 sysdm.cpl,EditEnvironmentVariables
* Newer versions of Adobe Acrobat Reader do not contain an IFilter. Thus, please deactivate the automatic update function of Adobe Acrobat Reader 11.

For reasons of stability and performance, MailStore Service Provider Edition processes the following file types directly, regardless of the IFilter drivers that are installed:

* Text files (TXT)
* HTML files (HTM and HTML)

== Archive Access ==
{{:Accessing Instances}}

=== Inside the Instance ===
No matter whether logging on to an instance as the customer's administrator or as service provider via service provider archive access, the available functions of the MailStore Client are nearly the same. Only accessing and or modifying the archive content (e.g. creating folders, deleting messages,..) is prohibited for the ''$archiveadmin'' user.

Please refer to [[Instance Administration]] to get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.

== Live Statistics ==
The ''Live Statistics'' tab shows real time graphics about the instance activity such as I/O, memory and CPU usage as well as number of Remote Procedure Calls (RPC) and the number of emails verified and archived by the instance's archiving mechanism.

Instance Management

2021-05-10T15:10:46Z

Bmeyn: /* Configure */

For each instance further individual administrative functions exist. These functions are accessible through the instance details, which appear in pane below the instance list (''General > Instances'') of the Management Console when clicking on a running instance in the list.

All these functions are group by tabs, for which further details are provided below.

== Overview ==
On the ''Overview'' tab of the instance details a summary of the configuration is shown.

[[File:Ms_spe_instance_overview.png|center]]

== Archive Stores ==
The ''Archive Stores'' tab allows the administration of the instance storage as well as the search indexes. New archive stores are automatically created in the base directory of the instance every 5.000.000 messages.

=== Create Archive Stores ===
Although MailStore Service Provider Edition creates new archive stores automatically, this can also be done manually as described in the following:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Create Store''.
* Fill out the ''Create Archive Store'' form:
*: [[File:Ms_spe_create_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store.
:* '''Archive new messages here:''' Enabled by default, new message will be archived in the newly created archive store if this option is checked.
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. the database and index directory may reside on a fast storage while the content resides in on a slower storage.
:* '''Directory:''' Directory in which the new archive store will be created. A proposal is created from the ''Name'' of the archive store and the base directory of the instance. Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~\Messages-2013-10</code>
* Click ''OK'' to create the new archive store.

=== Attach Existing Archive Store ===
Archive stores from MailStore Service Provider Edition instances or from on-premises MailStore Servers can be attached to an instance as described below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Attach Store''.
* Fill out the ''Attach Archive Store'' form:
*: [[File:Ms_spe_attach_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store
:* '''Archive new messages here:''' If checked, new message will be archived in the newly created archive store. (default: unchecked)
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. archive stores created before MailStore SPE/Server 10 do have the search index files located in the same directory as the database. So you have to activate this option and remove the \''Index'' directory from the ''Index Directory''-field.
:* '''Base Directory:''' Directory of the archive store to attach. This directory must contain the file "MailStoreFileGroup.fdb". Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~/2016-12</code>.
* Click ''OK'' to attach the archive store.

=== Unlock Archive Stores ===
In case the archive store was migrated from MailStore Server 10 or newer to MailStore SPE, additional steps are required.

==== The archive store is protected with a recovery key ====
* The archive store cannot be loaded successfully and the note ''Unable to unlock archive store (Identifier: <identifier>)'' appears.
: [[File:Ms_spe_attach_locked_generated_value.png|center]]
* To finalize the migration of this archive store you need to know the recovery key identified by <identifier>, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the recovery key. The recovery key must be entered in lowercase letters.
* Click ''Invoke'', ''true'' should appear below the text fields.
: [[File:Ms_spe_attach_unlock_generated_value.png|center]]
* Verify that the archive store was attached successfully.

==== The archive store is protected with a product key ====
* The archive store cannot be loaded successfully and the note ''Unable to open the archive store <name>. Can't decrypt encryption key.'' appears.
: [[File:Ms_spe_attach_locked_product_key.png|center]]
* To finalize the migration of this archive store you need to know the product key of the installation where the archive store was attached to last, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the product key. The product key must be entered in uppercase letters.
* Click ''Invoke'', ''true'' should appear.
: [[File:Ms_spe_attach_unlock_product_key.png|center]]
* Verify that the archive store was attached successfully.

More information about archive security can be found in the [https://help.mailstore.com/en/server/MailStore_Server_Service_Configuration#Security_and_Encryption MailStore Server Service Configuration article].

=== Maintain FS Databases ===
For storing meta data of the archive store's content embedded Firebird databases exist in every archive store. Under certain circumstances (e.g. after a disaster recovery of the server or storage) it might become necessary to perform a maintenance task on those databases. This can easily be done for all archive stores of a particular instance be following the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Maintain FS Databases'' to start the maintenance.
* A progress windows will appear.
* Wait until the process is completed successfully and click ''OK''. Otherwise click ''Cancel'' to interrupt maintenance process at any time.

=== Auto-Create Stores ===
MailStore Service Provider Edition automatically creates new archive stores every 5.000.000 messages. This setting can be adjusted to your need:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Auto-create''.
* Adjust the settings in the ''Auto-Create Archive Stores'' dialog.
*: [[File: Ms_spe_autocreate_stores_01.png|center]]
*: '''Important notice:''' Non-optimal settings can have a negative impact on the overall performance of the instance.
* Click ''OK'' to save the settings.

=== Store Commands ===
Advanced store commands are accessible by following these steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Select an archive store and click on ''Store Commands'' or right-click on an archive store to open a context menu.

A summary of the available store commands can be found in the tables below:

==== Requested State ====

{| class="wikitable"
! width="150px" | State
! Description
|-
| Disabled
| Disabled archive stores are not in use but the instance still knows about their existence. The content is not available to users or administrators while the archive store is disabled. This state is useful when moving archive stores to a new directory.
|-
| Write Protected
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| Normal
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| Current
| Same as ''Normal'' but new messages will be archived in the archive store that is set to ''Current''.
|}

==== Commands ====

{| class="wikitable"
! width="150px" | Command
! Description
|-
| Detach
| Detaches the selected archive store. The archive store can be re-attached by using the ''Attach'' function. Please note that the archive store's name and ID will not be retained when detaching and re-attaching. Therefore, when moving an archive store to a new location, disabling the the archive store and using ''Set Path'' afterwards is preferred over re-attaching.
|-
| Rename
| Specify a new name for the archive store.
|-
| Set Path
| Change the path of the archive store. The archive store must be disabled before changing the path. Please note that the file system directory must be moved manually to the new location before re-enabling the archive store.
|-
| Compact
| Optimizes the data structures.
|-
| Upgrade
| If an archive store from a MailStore Server 5 or older was attached to an instance, it is highly recommended to upgrade the archive store to the latest format by using this function. Upgrade process can be interrupted and continued at any time.
|-
| Verify
| Verification of the data integrity between folder information and meta data as well as email headers, content and recovery records.
|-
| Recreate Recovery Records
| Recreates broken recovery records of an archive store. Use ''Verify'' to verify the state of the recovery records.
|}

=== Search Indexes ===
Additionally to container files storing the actual email content and the embedded Firebird databases used for storing meta information, a full-text index file is created for each archive that has emails stored in an archive store. By default the full-text index only included email bodies, but virtually any file type is supported (see ''Configure'').

To access these functions, follow the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Search Indexes''.

The below functions are available in the search index menu to configure and maintain the full-text indexes of an instance.

==== Rebuild Broken Indexes ====
Starts a rebuild of all search indexes across all archive stores that are marked as broken.

==== Rebuild All Indexes ====
Starts a rebuild of all search indexes in all archives stores.
This is usually only required after making changes to the list of attachment extensions to be included in the full-text index.

==== Configure ====
Specify a list of file extensions for attachments to be included in the full-text index. MailStore Service Provider Edition can index all file types for which a so-called IFilter driver is installed on the instance host on which the MailStore instance is running. The list of file extensions has to be separated by space.

[[File: Ms_spe_file_extensions.png|center]]

Under the name [http://www.microsoft.com/en-us/download/details.aspx?id=17062 Microsoft Office 2010 Filter Packs] Microsoft offers a package that, additionally to all legacy as well as recent Microsoft Office Formats, supports the Open Document Format (OpenOffice/LibreOffice). For indexing PDF files the Adobe Reader or [ftp://ftp.adobe.com/pub/adobe/acrobat/win/11.x/PDFFilter64Setup.msi Adobe PDF iFilter] (IE or FTP client necessary for download) must be installed on the instance host. Further background information about the IFilter system itself as well as links to additional IFilter drivers can be found in the corresponding Wikipedia article [[wikipedia:IFilter|IFilter]].

:'''Important Notices:'''
* Take note of the [https://www.adobe.com/devnet-docs/etk_deprecated/tools/AdminGuide/Acrobat_Reader_IFilter_configuration.pdf installation instructions] of the 64bit IFilter. Especially adding the ''bin'' folder of the IFilter installation folder to the ''PATH'' system variable increases indexing speed a lot. The ''PATH'' system variable can be adjusted via an administrative command prompt (cmd) and then rundll32 sysdm.cpl,EditEnvironmentVariables
* Newer versions of Adobe Acrobat Reader do not contain an IFilter. Thus, please deactivate the automatic update function of Adobe Acrobat Reader 11.

For reasons of stability and performance, MailStore Service Provider Edition processes the following file types directly, regardless of the IFilter drivers that are installed:

* Text files (TXT)
* HTML files (HTM and HTML)

== Archive Access ==
{{:Accessing Instances}}

=== Inside the Instance ===
No matter whether logging on to an instance as the customer's administrator or as service provider via service provider archive access, the available functions of the MailStore Client are nearly the same. Only accessing and or modifying the archive content (e.g. creating folders, deleting messages,..) is prohibited for the ''$archiveadmin'' user.

Please refer to [[Instance Administration]] to get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.

== Live Statistics ==
The ''Live Statistics'' tab shows real time graphics about the instance activity such as I/O, memory and CPU usage as well as number of Remote Procedure Calls (RPC) and the number of emails verified and archived by the instance's archiving mechanism.

Main Page

2020-01-09T16:12:53Z

Bmeyn:

__NOTOC__
{{DISPLAYTITLE:MailStore Service Provider Edition Help}}

Service providers receive an unlimited, scalable software solution with MailStore Service Provider Edition, which they will be able to independently operate either on their existing IT infrastructures or those they have leased. This help website has an exclusive focus on installing and setting up the backend of the MailStore Service Provider Edition. The ''Getting Started'' section takes service providers through the essential setup and configuration steps and ends with a few important yet optional post-installation tasks.

== Getting Started ==
The following provides a walk-though of the essential steps to get the MailStore Service Provider Edition up and running, including the creation of instances, management of users, and the archiving of email.

=== Before You Start ===
{|
| style="vertical-align: top; width: 200px" | [[Overview]]
| Familiarize with the architecture of the MailStore Service Provider Edition. The overview also shows the most common and realizable scenarios.
|-
| [[System Requirements]]
| Before installing MailStore Service Provider Edition, ensure that the system requirements are met. A requirements calculator helps to determine the needs dependent on the number of users, instances, archiving strategy, and the intended retention period of archived email.
|-
| [[Frequently Asked Questions]]
| Checking the FAQ might help to identify potential pitfalls or show stoppers early in the implementation process.
|}

=== Installation and Setup ===
{|
| style="vertical-align: top; width: 200px" | [[Installing MailStore Service Provider Edition|Installation]]
| Irrespective of the projected scenario, it all begins with the installation of the software itself.
|-
| [[Single Server Mode Setup|Initial Configuration]]
| Starting with Single Server Mode is generally a good starting point. Roles can be added or moved to other servers as more and more instances are added to the environment.
|-
| [[Firewall Configuration for Single Server Mode|Firewall Configuration]]
| To access the MailStore Service Provider Edition from remote systems, appropriate firewall rules must be set up.
|}

=== Using MailStore Service Provider Edition ===
{|
| style="vertical-align: top; width: 200px" | [[Management_Console_-_Logging_On|Logging On]]
| The Management Console is the central web-based administrative tool for MailStore Service Provider Edition administrators.
|-
| [[Creating Instances]]
| Within a the MailStore Service Provider Edition, every customer gets his own self-contained MailStore instance that runs completely isolated from those belonging to other customers. Before emails can be archived, it is necessary to create such a MailStore instance.
|-
| [[Accessing Instances]]
| A special service provider access to running instances is available in the Management Console, making it very easy to fully manage instances for customers.
|}

=== Archiving Email ===
{|
| style="vertical-align: top; width: 200px" | [[Instance Administration]]
| Get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.
|-
|}

=== Post Installation Tasks ===
{|
| [[End User Access]]
| This article provides information on how to access an instance as a customer's administrator if he responsible for the administration of the instance. Also information about how end users can access archived email are found here.
|-
| style="vertical-align: top; width: 200px" | [[Branding]]
| The MailStore Service Provider Edition comes with a generic service provider branding. Learn more about how to give the MailStore Service Provider Edition a unique look representing the service providers own corporate identity.
|-
| [[Replace Self-signed SSL Certificates]]
| For security and end user convenience, it is highly recommended to replace the self-signed SSL certificates of the public facing HTTP, IMAP, and IMAPS services by certificates signed by a trusted root certificate authority. This article provides the necessary information.
|-
| [[Backup and Restore]]
| In most scenarios, the archive is the last resort of emails. Thus it highly recommended to protect the archive, by implementing a decent backup plan, from hardware or software failure that could mean potential loss of data.
|-
| [[Management_Console_-_General#SMTP_Settings|SMTP Settings]]
| To receive notifications about available product updates or automatic Web Access updates, the Service Provider Edition needs to know how to deliver emails to system administrators. This article explains how to configure the required SMTP settings.
|-
| [[Monitoring]]
| This article to tries to give and overview of what services and parameters to proactively monitor with a suitable monitoring solution, in order to provide customers the best possible experience.
|-
| [[Enhancing SSL Security]]
| The default SSL security settings on most operating systems do not meet the current security industry standards for the sake of backward compatibility. Learn more about how to enhance the SSL settings on Windows operating systems in order to provide your customer the best available security standards.
|}

{|
| style="vertical-align: top; width: 50%" |

== Management Console ==
The MailStore Management Console is the primary, web based administration utility for MailStore Service Provider Edition administrators. The following articles provide documentation for all available functions. Each function of the Management Console also has a corresponding [[Management API - Function Reference|Management API command]], which allows full, script-based control over MailStore Service Provider Edition.

* [[Management_Console_-_Logging On|Logging On]]
* [[Management_Console_-_General|General]]
** [[Instance Management]]
** [[Instance Administration]]
* [[Management_Console_-_Infrastructure|Infrastructure]]
* [[Management_Console_-_Security|Security]]
* [[Management_Console_-_Developer|Developer]]
| style="vertical-align: top; width: 50%" |

== Management API ==
The Management API extends the management capabilities of the MailStore Service Provider Edition by providing a HTTP based access to all management functions. This allows to fully automate the administration of MailStore Service Provider Edition via scripts or even integration into centralized management solutions. For an even faster development, example API libraries for different scripting and programming languages are provided.

* [[Management API - Using the API|Using the API]]
* [[Management API - Function Reference|Function Reference]]
* [[Management API - Command Line Client|Command Line Client]]
'''Example Implementation of API Libraries'''
* [[PowerShell_API_Wrapper_Tutorial|PowerShell]]
* [[Python API Wrapper Tutorial|Python]]
* [[Media:Mailstore-mgmt-api-client.zip|Linux MailStore Management API Client]]
|-
| style="vertical-align: top; width: 50%" |

== Related Articles ==
* [[Application Integration|Directory Service: Application Integration]]
* [http://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]
* [[MailStore Server to MailStore SPE Migration]]
* [[Moving Roles]]
* '''Multi Server Mode'''
** [[Multi Server Mode Setup|Setup]]
** [[Firewall Configuration for Multi Server Mode|Firewall Configuration]]
* [[Renaming Servers]]
* [[Moving Instances]]
* [[Security Advisories]]
* [[Startup Scripts]]
* [[Update Notices]]
* [[Working with SSL Certificates]]
* [https://help.mailstore.com/en/gateway MailStore Gateway Help]
| style="vertical-align: top; width: 50%" |

== Downloads ==
'''Active Directory Group Policy Templates'''
* [[Media:MailStoreSPE_ADMX.zip|ADMX-Template]]
|}

Management API - Function Reference

2019-12-10T17:14:56Z

Bmeyn: /* RepairStoreDatabase */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get current state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemSmtpConfiguration ==
Get current system wide SMTP configuration.

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RecoverStore ==
Recreates a broken Firebird database from recovery records. The archive store must have been upgraded to the latest version and the recovery records must not be corrupt. The archive store must be in the ''Disabled'' or ''Error'' state.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>encryptionKey</tt>
| string (optional)
| Encryption key of the archive store.
|}

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== ReloadBranding ==
Reloads the SPE branding information from the filesystem. Newly connected clients are getting the updated branding.

== RenameStore ==
Rename archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RepairStoreDatabase ==
Tries to resolve certain issues with archive store databases (e.g. missing database indexes).

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to receive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archive store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system administrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system administrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== SetSystemSmtpConfiguration ==
Set system wide SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== config ====
Example config object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientSystemAdministrator": ["admin", "johndoe"]
}
</source>

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|-
| <tt>safeMode</tt>
| bool (optional)
| Start instances in Safe Mode to perform maintenance.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== TestSystemSmtpConfiguration ==
Test current system wide SMTP configuration.

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via the Email Archive client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user. Use ''SetPrivilegesOnFolder'' to grant that user privileges on the own archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The unique identifier of the job to be deleted.
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>jobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the E-Mail-Archive Client. Client side profiles can be started by using the ''MailStoreCmd'' and the commands ''import-execute'' and ''export-execute''.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the E-Mail-Archive Client.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"adminEmailPreviewEnabled": true,
"legalHoldEnabled": false,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
</source>

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddress": "administrator@example.com"
}
</source>

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma separated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

=== Argument Values ===

==== privileges ====

{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
|-
| <tt>read</tt>
| The user is granted read access to the specified folder.
|-
| <tt>write</tt>
| The user is granted write access to the specified folder. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folder.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

MailStore Server to MailStore SPE Migration

2019-06-17T09:22:32Z

Bmeyn:

__NOTOC__
This guide explains how to turn a MailStore Server installation into a MailStore SPE Instance.

As the two products use a slightly different format of the master database (''MailStoreMaster.fdb''), which contains the configuration, it is not possible to move the entire ''MailArchive'' directory of MailStore Server onto a MailStore SPE Instance Host. However, it is possible to transfer all archive stores, which contain the actual messages, by following these simple steps:

'''Important Notice:''' The MailStore Server archive store must be on Version 7 or higher. If this is not the case, the entire archive (MasterDatabase and Archive Stores) must be loaded once into a MailStore Server 7, or higher, before it can be migrated to the SPE, because then some necessary database upgrades will be performed. The MailStore SPE version must be equal or higher than the MailStore Server version where the archive stores were attached to last. When MailStore Server is on version 10 or higher and the customer does not want to share the product key with the service provider, the recovery key can be set to a generated value before migrating.
* First [[Creating_Instances| create a new MailStore SPE Instance]]. The instance must not be started yet.
* Stop all archiving profiles in MailStore Server, either by setting the execution mode to ''manual'', by disabling all ''Jobs'' or by disabling all scheduled tasks.
* [http://en.help.mailstore.com/MailStore_Server_Service_Configuration Stop the MailStore Server] service.
* Copy all archive store directories from MailStore Server into the instance's ''Data'' directory. Do not transfer the ''MailStoreMaster.fdb'', the ''MailStoreMaster.key'' and ''MailStore.xml'' files. Make sure, there is no remaining ''.lock'' file in any of the archive store directories. If there is, the MailStore Server service has not been stopped completely yet. When there are identical folder names, do not merge them, but give them unique names instead.
'''Important Notice:''' After this step, do not run any of the archiving profiles in MailStore Server again, otherwise you might risk that emails are not getting archived by the MailStore SPE Instance (i.e. when a profile contains automatic deletion rules).
* Start the MailStore SPE Instance.
* [[Instance_Management#Attach_Existing_Archive_Store|Attach the archive stores]] that were previously transferred to the newly created instance. In case the archive store is migrated from MailStore Server 10 or newer the recovery key (product key or generated value) of the source MailStore Server installation is required. You have to use the ''UnlockStore'' command in the ''DEVELOPER'' > ''Management API'' window of the Management Console as described [[Instance_Management#Unlock_Archive_Stores|here]].
* Set the state of one archive store to ''Current''.

== Additional Steps ==
Depending on the previous configuration of MailStore Server, the following tasks are to be done to configure the MailStore SPE Instance accordingly:

* Create users, either manually or by synchronizing with a directory service.
* Configure compliance settings.
* Create archiving profiles.
* Verify the rest of the configuration, such as search index configuration, export profiles, permissions, etc.

Working with SSL Certificates

2019-06-17T09:08:48Z

Bmeyn:

Although various methods exist to create and import SSL certificates, this task can be laborious on Windows servers where no certificate policy exists (i.e. standalone servers). This article describes how to manually create and verify a certificate signing requests (CSR) and import the certificate after the CSR has been signed by a certificate authority, using Microsoft's ''Certreq'' tool.

Service Providers who already possess certificates and/or manage their certificates with OpenSSL/LibreSSL, find useful information in [[#Importing an_Existing_Certificate|Importing an Existing Certificate]].

== Creating or Renewing a Certificate ==
Follow the below instructions to create or renew a certificate and import it into Windows' certificate store.

=== Generating a Certificate Signing Request (CSR) ===
It is assumed that the following steps are carried out on the machine, where the certificate is actually going to be used by MailStore SPE.

* Prepare a text file <tt>request.inf</tt> with the following content:
<pre>
;----------------- request.inf -----------------
[Version]
Signature="$Windows NT$"

[NewRequest]
; replace Subject attributes in the line below with real values
Subject = "CN=mailarchive.example.com, OU=Department, O=Organisation, L=Locality, S=State, C=Country"
KeySpec = 1
KeyLength = 2048
Exportable = TRUE
FriendlyName = mailarchive.example.com
MachineKeySet = TRUE
SMIME = False
PrivateKeyArchive = FALSE
UserProtected = FALSE
UseExistingKeySet = FALSE
ProviderName = "Microsoft RSA SChannel Cryptographic Provider"
ProviderType = 12
RequestType = PKCS10
KeyUsage = 0xa0

[EnhancedKeyUsageExtension]
OID = 1.3.6.1.5.5.7.3.1 ; this is for Server Authentication

[Extensions]
2.5.29.17 = "{text}"
_continue_ = "DNS=mailarchive.example.com&"
_continue_ = "DNS=archive.example.com&"
_continue_ = "DNS=*.example.com&"
</pre>
* Adjust the ''Subject'' and ''FriendlyName'' values according to your needs.
* Adjust the ''Subject Alternative Names (SAN)'' in the ''[Extensions]'' section as well. Please note that the ''Common Name (CN)'' in the ''Subject'' is irrelevant for the verification by clients and that all host names must be included as SANs. Additional host names may be added with appending additional ''_continue_'' lines.
* Save the file.
* Open an elevated command prompt and navigate to the directory where the ''request.inf'' is stored.
* Create the CSR by executing the following command:
certreq -new request.inf request.csr

=== Validating the Certificate Signing Request ===
To verify that the CSR is correct, execute the following command to display it in a human readable format:

certutil -dump request.csr

=== Submitting the Certificate Signing Request ===
Submit the CSR to your preferred CA. The CA might ask for the server platform during the submission process. Selecting ''IIS 7'' or ''None of the listed'' should be sufficient. After successful approval of the CSR, you will get the signed certificate in return.

'''Please note:''' Nowadays most CAs require the installation of intermediate CA certificates. Detailed information about the installation process of intermediate CA certificates is typically included in the electronic delivery of your certificate.

=== Importing the Certificate ===
* Open an elevated command prompt and navigate to the directory where the certificate file is stored.
* Execute the following command to import the certificate into the computer's personal certificate store:

certreq -accept certificate.cer

=== Verifying the Import ===
* Log on as administrator to the server on which certificate has been imported.
* Open the ''Microsoft Management Console (MMC)''
* Add the Certificate Snap-In by following these steps:
** Click on ''File'' > ''Add/Remove Snap-In'' > ''Certificate'' > ''Add >''
** Select ''Computer Account'' and click on ''Next >''
** Select ''Local Computer'' and click on ''Finish''
** Close any open dialog windows
* Click on ''Certificates (Local Computer)'' > ''Personal'' > ''Certificates''
* Double-click on the previously imported certificate
* Make sure that the private key for the certificate is available.

==== Repairing the Certificate Store ====
Sometimes the matching private key cannot be found although the certificate was imported successfully into the correct certificate store. Try to repair the certificate store as follows:

* Open an elevated PowerShell and execute the following command:

Get-ChildItem Cert:\LocalMachine\My | select Subject, Serialnumber, Thumbprint, HasPrivateKey

* Check the subjects, serialnumbers and fingerprints of the installed certificates, to identify the certificate to be used by MailStore.
* Repair the corresponding certificate store by executing the following command, where ''SerialNumber'' is the serial number of the certificate that should be used.

certutil -repairstore my SerialNumber

=== Using the Certificate ===

* [[Replace_Self-signed_SSL_Certificates|Replace]] the self-signed certificates in the ''Client Access Server''.

== Importing an Existing Certificate ==
Typically certificates are exchanged between computers by means of Personal Information Exchange (PFX/P12) containers. These can, for example, be created using the export functions of the MMC Snap-In ''Certificates''.

=== Optional: Creating a PFX Container with OpenSSL/LibreSSL ===
When the original CSR was not created with Windows' own tools or not even created on a Windows computer, it is unlikely that the private key or the vertificate is available in Windows' certificate store of the MailStore Server computer, but on stored on the file system instead.

In this case, a Personal Information Exchange (PFX) container need to be created first. This needs to contain the certificate, private key, and all certificates of the certificate chain. After that, the PFX container can by imported into Windows' certificate store.

The following steps need to be executes to convert the certificate files into a PFX container with OpenSSL or LibreSSL:

* Copy the certificate, private key and the certificates of the certificate chain into the OpenSSL or LibreSSL directory.
* Open an elevated command prompt and navigate to this directory.
* Create the PFX container by executing the following command, adjust the file names if necessary:
openssl pkcs12 -export -out certificate.pfx -inkey privateKey.key -in certificate.crt -certfile CACert.crt

=== Importing a PFX container ===
* Open an elevated command prompt and navigate into the directory where the PFX container resides.
* Enter the following command to import the certificate into the personal store of the machine account, adjust the certificate file name if necessary:
certutil -enterprise -importpfx my certificate.pfx
* Enter the password which is used to protect the PFX file.
* Certutil shows a success message when the certificate was imported successfully.

== Weblinks ==
* [https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/certreq_1 Microsoft Technet: Certreq]
* [https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/certutil Microsoft Technet: Certutil]
* [https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/ff625722(v=ws.10) Microsoft Technet: How to Request a Certificate With a Custom Subject Alternative Name]
* [https://www.libressl.org/ LibreSSL]
* [https://www.openssl.org/docs/apps/openssl.html OpenSSL Documentation]

Replace Self-signed SSL Certificates

2019-06-17T08:57:57Z

Bmeyn:

MailStore Service Provider Edition automatically creates self-signed certificates when adding a new role to a server. While these certificates are suitable for authenticating MailStore Service Provider Edition's own services against each other by storing and verifying the unique fingerprints of the used certificates, self-signed certificates are not suitable for public internet services like email or web servers.

Therefore it is recommended to replace the SSL certificates used by the Client Access Servers for offering IMAP and web based access to the archives with certificates signed by an official certificate authority. Information on requesting, renewing and working with such certificates can be found in this [[Working_with_SSL_Certificates|article]].

== Prerequisites ==
Before a certificate can be used by the Client Access Server service, the certificate and its private key must be stored in the computer's personal/MY certificate store ('''not''' Administrator's or any other user's).

== Installing New Certificates ==
* Start the MailStore Service Provider Edition Configuration tool on a server that is a Client Access Server by double-clicking it's desktop icon. On Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* Stop the ''Client Access Server''.
* Click ''Configure..''.
* For each endpoint in the ''Features'' section (HTTP, IMAP, IMAPS) click on the button behind the '''Certificate'' field to select the new certificate from the Windows certificate store.
*:[[File:Ms_spe_replace_self_signed_cert_01.png]]
*; '''Please note:''' The ''Certificate'' under the ''Client Access Server Settings'' usually must not be replaced. If you change this certificate, you also need to [[Multi_Server_Mode_Setup#Pairing_with_Management_Server|pair]] your ''CAS'' with the ''Management Server'' to gain trust again.
* Click ''OK'' to save changes or ''Cancel'' to discard.
* Start the Client Access Server.

Repeat the above on each Client Access Server in your MailStore Service Provider Edition infrastructure.

File:Ms spe replace self signed cert 01.png

2019-06-17T08:37:36Z

Bmeyn: Bmeyn uploaded a new version of File:Ms spe replace self signed cert 01.png

Replace Self-signed SSL Certificates

2019-06-17T08:34:57Z

Bmeyn: /* Installing New Certificates */

MailStore Service Provider Edition automatically creates self-signed certificates when adding a new role to a server. While these certificates are suitable for authenticating MailStore Service Provider Edition's own services against each other by storing and verifying the unique fingerprints of the used certificates, self-signed certificates are not suitable for public internet services like email or web servers.

Therefore it is recommended to replace the SSL certificates used by the Client Access Servers for offering IMAP and web based access to the archives with certificates signed by an official certificate authority.

== Prerequisites ==
Before a certificate can be used by the Client Access Server service, the certificate and its private key must be stored in the computer's personal/MY certificate store ('''not''' Administrator's or any other user's).

== Installing New Certificates ==
* Start the MailStore Service Provider Edition Configuration tool on a server that is a Client Access Server by double-clicking it's desktop icon. On Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* Stop the ''Client Access Server''.
* Click ''Configure..''.
* For each endpoint in the ''Features'' section (HTTP, IMAP, IMAPS) click on the button behind the '''Certificate'' field to select the new certificate from the Windows certificate store.
*:[[File:Ms_spe_replace_self_signed_cert_01.png]]
*; '''Please note:''' The ''Certificate'' under the ''Client Access Server Settings'' usually must not be replaced. If you change this certificate, you also need to [[Multi_Server_Mode_Setup#Pairing_with_Management_Server|pair]] your ''CAS'' with the ''Management Server'' to gain trust again.
* Click ''OK'' to save changes or ''Cancel'' to discard.
* Start the Client Access Server.

Repeat the above on each Client Access Server in your MailStore Service Provider Edition infrastructure.

File:Ms spe replace self signed cert 01.png

2019-06-17T08:30:53Z

Bmeyn:

File:Ms spe access client 02.png

2019-06-17T07:55:04Z

Bmeyn: Bmeyn uploaded a new version of File:Ms spe access client 02.png

Branding

2019-03-11T16:37:02Z

Bmeyn: /* Client Branding */

__NOTOC__
The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily to match your corporate design.

== Modify and Activate Branding ==
Follow the instructions below to apply your own branding:

* Open Windows Explorer on the Management Server.
* Navigate to the ''config'' subdirectory of the MailStore Service Provider Edition installation. (Default: <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>).
* Create a new folder named <tt>Branding</tt>.
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.
* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Navigate to ''Navigation > Developer> Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.

=== Client Branding ===
The following table provides information about the fields available for MailStore Client branding stored in <tt>ClientBranding.json</tt>.

{| class="wikitable"
! width=250px | Name
! Description
|-
| <tt>clientName</tt>
| Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"
|-
| <tt>helpUrl</tt>
| URL to be opened when clicking on help in client.
|-
| <tt>loginHeaderImage_410x81_png</tt>
| Header image for login dialog. Required dimension: width: 410px; height: 81px
|-
| <tt>headerBackgroundColor</tt>
| Background color of header, e.g. "#126d9c"
|-
| <tt>headerLeftImage_autox95_png</tt>
| Left header image. Required dimension: width: auto; height: 95px
|-
| <tt>headerRightImage_autox95_png</tt>
| Right header image. Required dimension: width: auto; height: 95px
|-
| <tt>about_html</tt>
| HTML file containing the about site.
|-
| <tt>watermarkImage_300x150_png</tt>
| Watermark image. Required dimension: width: 300px; height: 150px
|-
| <tt>gatewayName</tt>
| Custom name that the MailStore Gateway archiving profile is listed under.
|}

=== Web Branding ===
The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in <tt>WebBranding.json</tt>.

{| class="wikitable"
! width=250px | Name
! Description
|-
| <tt>webName</tt>
| Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"
|-
| <tt>webAbout_html</tt>
| HTML file containing the about site.
|-
| <tt>webRoot_html</tt>
| HTML file to be used when no in instance was given in the URL.
|-
| <tt>webHelpUrl</tt>
| URL to be opened when clicking on help in web access.
|-
| <tt>webLoginHeaderImage_410x81_png</tt>
| Header image for login dialog. Required dimension: width: 410px; height: 81px
|-
| <tt>webHeaderBackgroundColor</tt>
| Background color of header, e.g. "#126d9c"
|-
| <tt>webHeaderBackgroundImage_autox36_png</tt>
| Header header image. Required dimension: width: auto; height: 36px
|-
| <tt>outlookAddinName</tt>
| Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN".
|-
| <tt>outlookAddinHelpUrl</tt>
| URL to be opened when clicking on help in Outlook Add-in.
|-
| <tt>watermarkImage_300x150_png</tt>
| Watermark image. Required dimension: width: 300px; height: 150px
|-
| <tt>favicon_ico</tt>
| Favicon in 16x16, 32x32, 64x64 pixel.
|-
| <tt>favicon_png</tt>
| Favicon in 196x196 pixel in PNG format.
|-
| <tt>highlightColor</tt>
| Color used for section titles, buttons and other controls, e.g. "#6aabce".
|}

Controlling Instances

2019-01-16T12:40:56Z

Bmeyn: /* Safe Mode */

To start, stop or restart instances follow the steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select one or multiple instances from the list using the appropriate checkboxes.
* Click either on ''Start'', ''Safe Mode'', ''Stop'' or ''Restart''.

Please notice that the ''Start Mode'' of an instance must be set to ''Automatic'' or ''Manual'' in order to start an instance.

== Safe Mode ==

An instance can be started in ''Safe Mode'' to perform maintenance on its configuration.

While the ''Safe Mode'' is active:
* Only administrators can log in to the instance
* Automatic archiving and export profiles are not started
* Jobs are not started automatically
* All internal heartbeats are disabled

Management API - Function Reference

2018-09-26T09:21:30Z

Bmeyn:

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get current state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemSmtpConfiguration ==
Get current system wide SMTP configuration.

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RecoverStore ==
Recreates a broken Firebird database from recovery records. The archive store must have been upgraded to the latest version and the recovery records must not be corrupt. The archive store must be in the ''Disabled'' or ''Error'' state.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>encryptionKey</tt>
| string (optional)
| Encryption key of the archive store.
|}

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== ReloadBranding ==
Reloads the SPE branding information from the filesystem. Newly connected clients are getting the updated branding.

== RenameStore ==
Rename archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to receive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archive store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system administrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system administrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== SetSystemSmtpConfiguration ==
Set system wide SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== config ====
Example config object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientSystemAdministrator": ["admin", "johndoe"]
}
</source>

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|-
| <tt>safeMode</tt>
| bool (optional)
| Start instances in Safe Mode to perform maintenance
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== TestSystemSmtpConfiguration ==
Test current system wide SMTP configuration.

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via the Email Archive client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user. Use ''SetPrivilegesOnFolder'' to grant that user privileges on the own archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The unique identifier of the job to be deleted.
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>jobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"adminEmailPreviewEnabled": true,
"legalHoldEnabled": false,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
</source>

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddress": "administrator@example.com"
}
</source>

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma separated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

=== Argument Values ===

==== privileges ====

{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
|-
| <tt>read</tt>
| The user is granted read access to the specified folder.
|-
| <tt>write</tt>
| The user is granted write access to the specified folder. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folder.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

Management API - Function Reference

2018-09-26T09:20:40Z

Bmeyn:

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get current state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemSmtpConfiguration ==
Get current system wide SMTP configuration.

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RecoverStore ==
Recreates a broken Firebird database from recovery records. The archive store must have been upgraded to the latest version and the recovery records must not be corrupt. The archive store must be in the ''Disabled'' or ''Error'' state.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>encryptionKey</tt>
| string (optional)
| Encryption key of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

When the ''recoverDeletedMessages'' parameter is set to ''true'', only deleted messages that still have leftovers in the recovery records can be recovered. When an archive store has been compacted with [[#CompactStore|CompactStore]] or recovery record files have grown to their auto-compacting size of 8 MiB these leftovers could already be removed and deleted messages cannot be recovered.

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== ReloadBranding ==
Reloads the SPE branding information from the filesystem. Newly connected clients are getting the updated branding.

== RenameStore ==
Rename archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to receive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archive store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system administrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system administrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== SetSystemSmtpConfiguration ==
Set system wide SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== config ====
Example config object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientSystemAdministrator": ["admin", "johndoe"]
}
</source>

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== TestSystemSmtpConfiguration ==
Test current system wide SMTP configuration.

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>includeIndexes</tt>
| bool
| Defines whether to verify the search indexes as well.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via the Email Archive client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user. Use ''SetPrivilegesOnFolder'' to grant that user privileges on the own archive.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The unique identifier of the job to be deleted.
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>jobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"adminEmailPreviewEnabled": true,
"legalHoldEnabled": false,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
</source>

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddress": "administrator@example.com"
}
</source>

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma separated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

=== Argument Values ===

==== privileges ====

{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
|-
| <tt>read</tt>
| The user is granted read access to the specified folder.
|-
| <tt>write</tt>
| The user is granted write access to the specified folder. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folder.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

Controlling Instances

2018-09-26T09:12:23Z

Bmeyn:

To start, stop or restart instances follow the steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select one or multiple instances from the list using the appropriate checkboxes.
* Click either on ''Start'', ''Safe Mode'', ''Stop'' or ''Restart''.

Please notice that the ''Start Mode'' of an instance must be set to ''Automatic'' or ''Manual'' in order to start an instance.

== Safe Mode ==

An instance can be started in ''Safe Mode'' to to perform maintenance on its configuration.

While the ''Safe Mode'' is active:
* Only administrators can log in to the instance
* Automatic archiving and export profiles are not started
* Jobs are not started automatically
* All internal heartbeats are disabled

Controlling Instances

2018-09-26T09:11:20Z

Bmeyn:

Management Console - General

2018-09-06T10:55:43Z

Bmeyn: /* SMTP Settings */

__NOTOC__
== Dashboard ==
The dashboard of the Management Console is divided into the following parts.

=== Service Health ===
This sections gives a quick overview of the status of all configured hosts and their roles which are under the control of the Management Server. The root node of the tree always represents the Management Server, the left branch the Instance Hosts and the right branch shows the Client Access Servers. Instance Host nodes also show the number of available and active instances.

=== Version and License Information ===
Details about the product version in use and the licensee including their customer number are displayed here.

=== My Resources ===
The ''My Resources'' sections lists all resources created in the MailStore Service Provider Edition. This includes the number of ''Management Server'', ''Instance Hosts'', ''Client Access Server'' and the total number of instances available and running.

=== Messages ===
System messages that might require further administrative actions are shown in the ''Messages'' section of the dashboard. Typical message may contain warnings about license update failures or necessary search index rebuilds.

=== Related Links ===
This sections contains links to the most valuable online resources including this online help, Customer Service Center, etc.

== Instances ==
The main task of each MailStore Service Provider Edition administrator will be the management of instances. General administrative tasks such as creating, configuring, stating, stopping and deleting instances is described in the following.

Individual instance tasks like managing archive stores and search indexes, managing users and creating setting up archiving is covered in [[Instance Management]].

=== Creating Instances ===

{{:Creating Instances }}

=== Controlling Instances ===

{{:Controlling Instances}}

=== Configuring Instances ===
Most configuration settings of existing instances can be modified. The instance to modify must be stopped before its configuration can be changed. To change the configuration proceed as follows:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select the instances to modify.
* Click on ''Configure...''.
* Make the desired configuration changes.
*: [[File:Ms_spe_create_instance_02.png|center]]
*: ''Tab: Base Configuration''
*:: '''URL Alias''' Meaningful unique alias name that can be used as an alternative to the instance ID.
*:: '''Display Name:''' Additional identification information for the instance, e.g. customer name.
*:: '''Instance Host:''' Instance Host on which the new instance gets created.
*:: '''Start Mode:''' Defines how the instance is started. Choose from the following options (Default: ''Automatic''):
*::: ''Disabled:'' The instance can neither be started automatically nor manually.
*::: ''Manual:'' The instance can only be started manually.
*::: ''Automatic:'' The instance will automatically be started with the Instance. Host.
*:: '''Base Directory:''' Directory where instance's data will be stored.
*: ''Tab: Advanced Configuration''
*:: '''Enable VSS Writer:''' Enable support for Volume Shadow Service.
*::: '''Exclude Indexes from VSS Backup:''' Excludes the unencrypted search index files from the backup set reported by the VSS writer.
*:::: '''Please note:''' This option can be set so that administrators which have access to the backup files cannot access the unencrypted search index files. When restoring backups that do not include search index files, the search indexes have to be [[Instance_Management#Search_Indexes|rebuilt]].
*:: '''Enable Debug Log:''' Enable debug logging for the instance.
*:: '''Enable IMAP Server Connection Log:''' Enable IMAP Server connection logging for the instance.
* Click ''OK'' to save the changes.

'''Important notice:''' Neither changing the ''Instance Host'' nor the ''Base Directory'' will move the archive data to the new location. If necessary this must be done manually before starting the instance again.

=== Deleting Instances ===
Instances can be deleted at any time as long as they are stopped. Deleting an instance only removes it from the management database of the MailStore Service Provider Edition. All instance data remains on the hard disk and must be removed manually if necessary. To delete an instance follow these instructions:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select the instances to delete.
* Click on ''Command'' > ''Delete''.
* Confirm the security query with ''OK'' to delete the instance, otherwise click ''Cancel'' to abort.

== License Information ==
Clicking on the ''License Information'' menu item opens an overview of all data that is used by the billing process.

=== Used Licenses per Instance ===
Displays a list off all instances and their respective amount of used licenses.

=== Used Resources ===
This is a statistical overview of used resources.

=== Raw Licensing Request ===
The raw licensing request tab shows how the actual licensing request to our accounting servers looks like. The Management Server sends this information once every 24 hours to renew the local licensing information of the MailStore Service Provider Edition.

== SMTP Settings ==
Notifications are send by email in the following situations:

* product updates are available,
* a new Web Access version was installed automatically,
* license renewal requests failed for three consecutive days.

To send emails to administrators of the Service Provider Edition, the following settings have to be defined:

* '''Server:''' Enter the host name or IP address of the SMTP server.
* '''Port:''' By default, port 587 is used for email submission. If a different port (i.e. 25) is required by the SMTP server, change it here.
* '''Protocol:''' Select the protocol required by the SMTP server. Select ''SMTP'' for an unencrypted connection to the SMTP server. For an encrypted connection, select ''SMTP-TLS'' (STARTTLS, Explicit SSL) or ''SMTP-SSL'' (Implicit SSL). If the SMTP server does not use a SSL certificate signed by a trusted Certificate Authority, check ''Ignore SSL Warnings''; otherwise, the sending process will fail.
* '''Server requires authentication:''' If the SMTP server requires authentication prior to sending, check the corresponding checkbox and enter the appropriate credentials into the ''User Name'' and ''Password'' fields.
* '''Display Name:''' Enter a name that helps to identify the origin of the emails send by the Service Provider Edition.
* '''Email Address:''' Enter the email address of the sender. Some email servers, like Microsoft Exchange, verify that the authenticated users is allowed to use a particular email address.
* '''Recipient for Notifications:''' Select the system administrators who should receive notifications. When none are listed, verify that at least one [[Management_Console_-_Security|system administrator]] has the email address attribute set.

Once all settings have been specified, the SPE can be instructed to send a test email to the selected system administrators; simply click on ''Apply and Test''. If an error message appears or the recipient specified does not receive the email, the following hints for troubleshooting may be helpful.

=== Troubleshooting ===
* If no error occurs upon sending but the email does not arrive, please check the spam or junk mail folder of the mailbox.
* If an error message appears because of an invalid certificate ("Server's certificate was rejected by the verifier because of an unknown certificate authority."), check ''Ignore SSL Warnings'' and try again.
* If an error message appears indicating that ''"One or more recipients rejected"'', the SMTP server probably requires authentication. Enter the appropriate credentials as described above.
* If an error message appears because of invalid credentials (e.g. ''"Incorrect authentication data"''or ''"Authentication failed"''), verify the data entered.
* If further error messages appear or other problems arise, please check your input for possible mistakes.

Management Console - General

2018-09-06T10:51:35Z

Bmeyn: /* SMTP Settings */

__NOTOC__
== Dashboard ==
The dashboard of the Management Console is divided into the following parts.

=== Service Health ===
This sections gives a quick overview of the status of all configured hosts and their roles which are under the control of the Management Server. The root node of the tree always represents the Management Server, the left branch the Instance Hosts and the right branch shows the Client Access Servers. Instance Host nodes also show the number of available and active instances.

=== Version and License Information ===
Details about the product version in use and the licensee including their customer number are displayed here.

=== My Resources ===
The ''My Resources'' sections lists all resources created in the MailStore Service Provider Edition. This includes the number of ''Management Server'', ''Instance Hosts'', ''Client Access Server'' and the total number of instances available and running.

=== Messages ===
System messages that might require further administrative actions are shown in the ''Messages'' section of the dashboard. Typical message may contain warnings about license update failures or necessary search index rebuilds.

=== Related Links ===
This sections contains links to the most valuable online resources including this online help, Customer Service Center, etc.

== Instances ==
The main task of each MailStore Service Provider Edition administrator will be the management of instances. General administrative tasks such as creating, configuring, stating, stopping and deleting instances is described in the following.

Individual instance tasks like managing archive stores and search indexes, managing users and creating setting up archiving is covered in [[Instance Management]].

=== Creating Instances ===

{{:Creating Instances }}

=== Controlling Instances ===

{{:Controlling Instances}}

=== Configuring Instances ===
Most configuration settings of existing instances can be modified. The instance to modify must be stopped before its configuration can be changed. To change the configuration proceed as follows:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select the instances to modify.
* Click on ''Configure...''.
* Make the desired configuration changes.
*: [[File:Ms_spe_create_instance_02.png|center]]
*: ''Tab: Base Configuration''
*:: '''URL Alias''' Meaningful unique alias name that can be used as an alternative to the instance ID.
*:: '''Display Name:''' Additional identification information for the instance, e.g. customer name.
*:: '''Instance Host:''' Instance Host on which the new instance gets created.
*:: '''Start Mode:''' Defines how the instance is started. Choose from the following options (Default: ''Automatic''):
*::: ''Disabled:'' The instance can neither be started automatically nor manually.
*::: ''Manual:'' The instance can only be started manually.
*::: ''Automatic:'' The instance will automatically be started with the Instance. Host.
*:: '''Base Directory:''' Directory where instance's data will be stored.
*: ''Tab: Advanced Configuration''
*:: '''Enable VSS Writer:''' Enable support for Volume Shadow Service.
*::: '''Exclude Indexes from VSS Backup:''' Excludes the unencrypted search index files from the backup set reported by the VSS writer.
*:::: '''Please note:''' This option can be set so that administrators which have access to the backup files cannot access the unencrypted search index files. When restoring backups that do not include search index files, the search indexes have to be [[Instance_Management#Search_Indexes|rebuilt]].
*:: '''Enable Debug Log:''' Enable debug logging for the instance.
*:: '''Enable IMAP Server Connection Log:''' Enable IMAP Server connection logging for the instance.
* Click ''OK'' to save the changes.

'''Important notice:''' Neither changing the ''Instance Host'' nor the ''Base Directory'' will move the archive data to the new location. If necessary this must be done manually before starting the instance again.

=== Deleting Instances ===
Instances can be deleted at any time as long as they are stopped. Deleting an instance only removes it from the management database of the MailStore Service Provider Edition. All instance data remains on the hard disk and must be removed manually if necessary. To delete an instance follow these instructions:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select the instances to delete.
* Click on ''Command'' > ''Delete''.
* Confirm the security query with ''OK'' to delete the instance, otherwise click ''Cancel'' to abort.

== License Information ==
Clicking on the ''License Information'' menu item opens an overview of all data that is used by the billing process.

=== Used Licenses per Instance ===
Displays a list off all instances and their respective amount of used licenses.

=== Used Resources ===
This is a statistical overview of used resources.

=== Raw Licensing Request ===
The raw licensing request tab shows how the actual licensing request to our accounting servers looks like. The Management Server sends this information once every 24 hours to renew the local licensing information of the MailStore Service Provider Edition.

== SMTP Settings ==
Notifications are send by email in the following situations:

* product updates are available,
* a new Web Access version was installed automatically,
* license renewal requests failed for three consecutive days.

To send emails to administrators of the Service Provider Edition, the following settings have to be defined:

* '''Server:''' Enter the host name or IP address of the SMTP server.
* '''Port:''' By default, port 587 is used for email submission. If a different port (i.e. 25) is required by the SMTP server, change it here.
* '''Protocol:''' Select the protocol required by the SMTP server. Select ''SMTP'' for an unencrypted connection to the SMTP server. For an encrypted connection, select ''SMTP-TLS'' (STARTTLS, Explicit SSL) or ''SMTP-SSL'' (Implicit SSL). If the SMTP server does not use a SSL certificate signed by a trusted Certificate Authority, check ''Ignore SSL Warnings''; otherwise, the sending process will fail.
* '''Server requires authentication:''' If the SMTP server requires authentication prior to sending, check the corresponding checkbox and enter the appropriate credentials into the ''User Name'' and ''Password'' fields.
* '''Display Name:''' Enter a name that helps to identify the origin of the emails send by the Service Provider Edition.
* '''Email Address:''' Enter the email address of the sender. Some email servers like Microsoft Exchange, verify that the authenticated users is allowed to use a particular email address.
* '''Recipient for Notifications:''' Select the system administrators who should receive notifications. When none are listed, verify that at least one [[Management_Console_-_Security|system administrator]] has the email address attribute set.

Once all settings have been specified, the SPE can be instructed to send a test email to the selected system administrators; simply click on ''Apply and Test''. If an error message appears or the recipient specified does not receive the email, the following hints for troubleshooting may be helpful.

=== Troubleshooting ===
* If no error occurs upon sending but the email does not arrive, please check the spam or junk mail folder of the mailbox.
* If an error message appears because of an invalid certificate ("Server's certificate was rejected by the verifier because of an unknown certificate authority."), check ''Ignore SSL Warnings'' and try again.
* If an error message appears indicating that ''"One or more recipients rejected"'', the SMTP server probably requires authentication. Enter the appropriate credentials as described above.
* If an error message appears because of invalid credential (e.g. ''"Incorrect authentication data"''or ''"Authentication failed"''), verify the data entered.
* If further error messages appear or other problems arise, please check your input for possible mistakes.

Management Console - General

2018-07-25T15:01:00Z

Bmeyn: /* SMTP Settings */

__NOTOC__
== Dashboard ==
The dashboard of the Management Console is divided into the following parts.

=== Service Health ===
This sections gives a quick overview of the status of all configured hosts and their roles which are under the control of the Management Server. The root node of the tree always represents the Management Server, the left branch the Instance Hosts and the right branch shows the Client Access Servers. Instance Host nodes also show the number of available and active instances.

=== Version and License Information ===
Details about the product version in use and the licensee including their customer number are displayed here.

=== My Resources ===
The ''My Resources'' sections lists all resources created in the MailStore Service Provider Edition. This includes the number of ''Management Server'', ''Instance Hosts'', ''Client Access Server'' and the total number of instances available and running.

=== Messages ===
System messages that might require further administrative actions are shown in the ''Messages'' section of the dashboard. Typical message may contain warnings about license update failures or necessary search index rebuilds.

=== Related Links ===
This sections contains links to the most valuable online resources including this online help, Customer Service Center, etc.

== Instances ==
The main task of each MailStore Service Provider Edition administrator will be the management of instances. General administrative tasks such as creating, configuring, stating, stopping and deleting instances is described in the following.

Individual instance tasks like managing archive stores and search indexes, managing users and creating setting up archiving is covered in [[Instance Management]].

=== Creating Instances ===

{{:Creating Instances }}

=== Controlling Instances ===

{{:Controlling Instances}}

=== Configuring Instances ===
Most configuration settings of existing instances can be modified. The instance to modify must be stopped before its configuration can be changed. To change the configuration proceed as follows:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select the instances to modify.
* Click on ''Configure...''.
* Make the desired configuration changes.
*: [[File:Ms_spe_create_instance_02.png|center]]
*: ''Tab: Base Configuration''
*:: '''URL Alias''' Meaningful unique alias name that can be used as an alternative to the instance ID.
*:: '''Display Name:''' Additional identification information for the instance, e.g. customer name.
*:: '''Instance Host:''' Instance Host on which the new instance gets created.
*:: '''Start Mode:''' Defines how the instance is started. Choose from the following options (Default: ''Automatic''):
*::: ''Disabled:'' The instance can neither be started automatically nor manually.
*::: ''Manual:'' The instance can only be started manually.
*::: ''Automatic:'' The instance will automatically be started with the Instance. Host.
*:: '''Base Directory:''' Directory where instance's data will be stored.
*: ''Tab: Advanced Configuration''
*:: '''Enable VSS Writer:''' Enable support for Volume Shadow Service.
*::: '''Exclude Indexes from VSS Backup:''' Excludes the unencrypted search index files from the backup set reported by the VSS writer.
*:::: '''Please note:''' This option can be set so that administrators which have access to the backup files cannot access the unencrypted search index files. When restoring backups that do not include search index files, the search indexes have to be [[Instance_Management#Search_Indexes|rebuilt]].
*:: '''Enable Debug Log:''' Enable debug logging for the instance.
*:: '''Enable IMAP Server Connection Log:''' Enable IMAP Server connection logging for the instance.
* Click ''OK'' to save the changes.

'''Important notice:''' Neither changing the ''Instance Host'' nor the ''Base Directory'' will move the archive data to the new location. If necessary this must be done manually before starting the instance again.

=== Deleting Instances ===
Instances can be deleted at any time as long as they are stopped. Deleting an instance only removes it from the management database of the MailStore Service Provider Edition. All instance data remains on the hard disk and must be removed manually if necessary. To delete an instance follow these instructions:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Select the instances to delete.
* Click on ''Command'' > ''Delete''.
* Confirm the security query with ''OK'' to delete the instance, otherwise click ''Cancel'' to abort.

== License Information ==
Clicking on the ''License Information'' menu item opens an overview of all data that is used by the billing process.

=== Used Licenses per Instance ===
Displays a list off all instances and their respective amount of used licenses.

=== Used Resources ===
This is a statistical overview of used resources.

=== Raw Licensing Request ===
The raw licensing request tab shows how the actual licensing request to our accounting servers looks like. The Management Server sends this information once every 24 hours to renew the local licensing information of the MailStore Service Provider Edition.

== SMTP Settings ==
To be able to send emails to system administrators, the Service Provider Edition needs SMTP access data. The SPE sends notifications by email if product updates are available, if a new Web Access version was installed automatically or if the license renewal was not possible for three consecutive days.

* Enter the host name of the SMTP server or its IP address into the field ''Server''.
* By default, MailStore uses port 587. If you want to use a different port, enter the port to use in the ''Port'' field.
* From the drop-down ''Protocol'', select ''SMTP'' for an unencrypted connection to the SMTP server. For an encrypted connection, select ''SMTP-TLS'' (STARTTLS, Explicit SSL) or ''SMTP-SSL'' (Implicit SSL). If the SMTP server does not have an official or trusted SSL certificate, check ''Ignore SSL Warnings''; otherwise, the sending process will fail.
* Especially SMTP servers which are accessible through the internet require a login (SMTP authentication). Check the corresponding checkbox and enter the appropriate credentials into the ''User Name'' and ''Password'' fields.
* In the ''Sender'' section, enter the ''Display Name'' and the ''Email Address'' of the email sender. Many SMTP servers require an existing email address to be entered. The display name can be chosen freely; ideally the name indicates that the email was sent by the Service Provider Edition.
* Under ''Recipient for Notifications'', select the system administrators who should receive notifications. When there are no [[Management_Console_-_Security|administrators with configured email address]], this list remains empty.
* Once all settings have been specified, the SPE can be instructed to send a test email to the selected system administrators; simply click on ''Apply and Test''. If an error message appears or the recipient specified does not receive the email, the following hints for troubleshooting may be helpful.

=== Troubleshooting ===
* If no error occurs upon sending but the email does not arrive, please check the spam or junk mail folder of the mailbox. Perhaps the email was filtered out.
* If an error message appears because of an invalid certificate ("Server's certificate was rejected by the verifier because of an unknown certificate authority."), check ''Ignore SSL Warnings'' and try again.
* If an error message appears indicating that ''"One or more recipients rejected"'', the SMTP server probably requires authentication. Enter the appropriate access data as described above.
* If an error message appears because of invalid access data (''"Incorrect authentication data"''or ''"Authentication failed"''), verify the data entered.
* If further error messages appear or other problems arise, please check your input for possible mistakes.

Single Server Mode Setup

2018-05-30T15:30:09Z

Bmeyn: /* Set Up Single Server Mode */

__NOTOC__
== Set Up Single Server Mode ==
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the MailStore Service Provider Edition Configuration tool will ask for the desired mode. Select ''Single Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_01.png|center]]
* Enter your product key into the ''Product Key'' field and change ''Server Name'' to the fully qualified host name of the server (e.g. <tt>server.ms-spe.test</tt>). Enter the user name , the full name (optional), the email address and the password of the initial administrator account that will be used to log on to the Management Console. The password must meet the [[Notes on Password Complexity|complexity rules]]. '''Important notice: ''' Changing the host name after MailStore SPE has been configured requires additional, mostly manual actions such as transferring the license, recreation of roles and making changes to the configuration database. Therefore it is recommend to not change the host name afterwards.
*: [[File:ms_spe_config_02.png|center]]
* Click ''OK''.
* The MailStore Service Provider Edition Configuration tool will now create the configuration files for the ''Management Server'', ''Instance Host'' and ''Client Access Server'' roles. After the configuration has been successfully created, a Windows service is registered and started for each role. It takes about 10-15 seconds until the roles show up in the MailStore Service Provider Edition Configuration tool. '''Important notice:''' Unless a different target directory was specified during installation, the configuration files are stored in <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>. Although these files are in text format (JSON), please do not attempt to modify any of these files without using the MailStore Service Provider Edition Configuration tool.
*: [[File:ms_spe_config_status_all_roles.png|550px|center]]
* The startup process of the services takes place in the background. Therefore a service shown as ''running'' may still revert to ''stopped'' during a period of about 30 seconds in the event of an error.

Multi Server Mode Setup

2018-05-30T15:29:44Z

Bmeyn: /* Set Up Management Server */

__NOTOC__
== Multi Server Mode Setup ==
When setting up MailStore Service Provider Edition in multi server mode, the first role to set up must always be the Management Server role. Afterwards one or multiple Instance Hosts and Client Access Servers can be set up. Each server in a multi server mode setup can host one or multiple roles.

=== Set Up Management Server ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role''
* Select ''Management Server''
* Enter your product key into the Product Key field and change Server Name to the fully qualified host name of the server (e.g. mgmt.ms-spe.test). Enter the user name , the full name (optional), the email address and the password of the initial administrator account that will be used to log on to the Management Console. The password must meet the [[Notes on Password Complexity|complexity rules]]. '''Important notice: '''Changing the host name after the Management Server has been configured requires additional, mostly manual actions such as transferring the license, re-pairing Instance Hosts and Client Access Servers and making changes to the configuration database. Therefore it is recommend to not change the host name afterwards.
*: [[File:ms_spe_config_mgmt_01.png|center]]
* Fill out the ''Configure Management Server Role'' form.
*: [[File:ms_spe_config_mgmt_02.png|center]]
*; '''Management Server Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from Instance Hosts and Client Access Servers (Default: *:8471)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server to authenticate against Instance Hosts and Client Access Serves. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Console Settings'''
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections to the Management Console (Default: *:8470)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server's HTTP server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management API Settings'''
*; The Management API needs to be active when [[#Pairing_with_Management_Server|Instance Hosts or Client Access Servers will be paired]] with this Management Server.
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections to the Management Console and Management API (Default: *:8470)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server's API server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Debug Log'''
*; In case of errors the debug log of the Management Server can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Management Server role.
* Click ''Start'' to start the Management Server service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Set Up Instance Host ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role''
* Select ''Instance Host''
* Fill out the ''Configure Instance Host Role'' form.
*: [[File:ms_spe_config_ih_01.png|center]]
*; '''Instance Host Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from the Management Server (Default: *:8472)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Instance Host to authenticate against Management Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Server Connection'''
** '''Management Server:''' Fully qualified host name (FQHN) of the Management Server to connect to.
** '''Port:''' TCP port where the above Management Server accepts incoming connections.
** '''Management Server Cert:''' Fingerprint of the TSL certificate used by the Management Server to authenticate against Instance Host. This value is set automatically when [[Multi_Server_Mode_Setup#Pairing with Management Server|Pairing with Management Server]]
*; '''Debug Log'''
*; In case of errors the debug log of the Instance Host can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Instance Host role.
* Click ''Start'' to start the Instance Host service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Set Up Client Access Server ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*; [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role'' .
* Select ''Client Access Server''.
* Fill out the ''Configure Client Access Server Role'' form.
*: [[File:ms_spe_config_cas_01.png|center]]
*; '''Client Access Server Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from the Management Server (Default: *:8473)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Client Access Server to authenticate against Management Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Server Connection'''
** '''Management Server:''' Fully qualified host name (FQHN) of the Management Server to connect to.
** '''Port:''' TCP port where the above Management Server accepts incoming connections.
** '''Management Server Cert:''' Fingerprint of the TLS certificate used by the Management Server to authenticate against Client Access Server. This value is set automatically when [[Multi_Server_Mode_Setup#Pairing with Management Server|Pairing with Management Server]]
*; '''Features'''
**; '''Client Access / Web Access / Outlook Add-in (HTTPS) Enabled:''' If enabled the Client Access Server provides access to archives via MailStore Client, MailStore Outlook Add-in and MailStore Web Access.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:443)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the HTTP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
**; '''IMAP Server with explicit TLS Enabled:''' If enabled the Client Access Server provides access to archives via IMAP protocol. Connections must be secured via STARTTLS.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:143)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the IMAP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
**; '''IMAP Server with implicit TLS Enabled:''' If enabled the Client Access Server provides access to archives via IMAP protocol. Connection is encrypted via SSL/TLS.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:993)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the IMAP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Debug Log'''
*; In case of errors the debug log of the Client Access Server can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Client Access Server role.
* Click ''Start'' to start the Client Access Server service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Pairing with Management Server ===
Before Client Access Servers and Instance Hosts are able to communicate with the Management Server, TLS certificate fingerprints must be exchanged to establish a trust relationship. Additionally the Instance Hosts and Client Access Servers must be registered in the Management Server with its server name and TCP port.

This process can simply be performed by using the pairing function as described in the following:

* Enter the fully qualified host name of the server where the role is added in the ''Server Name'' field.
* Enter the fully qualified host name of the ''Management Server'' in the corresponding ''Management Server'' field while configuring an Instance Host or Client Access Server.
* Click ''Pair with this server''.
* Enter the user name and password of a MailStore Service Provider Edition administrator.
* Click ''OK'' to pair this role with the Management Server.
* The fingerprint of the Management Server's TLS certificate is copied in the ''Management Server Cert'' field of the role to be installed.
* The fingerprint of the role's TCP server's TLS certificate is transferred to the Management Database of the Management Server. This can be reviewed [[Management_Console_-_Infrastructure|here]].

'''Please note:''' Pairing is carried out through the Management API. Therefore the Management API must be enabled on the Management Server and the Instance Hosts and Client Access Servers must be able to establish a connection to the API on the Management Server (Default TCP port: 8474).

If your security policy does not permit establishing such a connection, pairing must be performed manually. Please refer to [[Management Console - Infrastructure#Add New Instance Host|Add New Instance Host]] or [[Management Console - Infrastructure#Add New Client Access Server|Add New Client Access Server]] for further details.

Multi Server Mode Setup

2018-05-30T15:29:18Z

Bmeyn: /* Multi Server Mode Setup */

__NOTOC__
== Multi Server Mode Setup ==
When setting up MailStore Service Provider Edition in multi server mode, the first role to set up must always be the Management Server role. Afterwards one or multiple Instance Hosts and Client Access Servers can be set up. Each server in a multi server mode setup can host one or multiple roles.

=== Set Up Management Server ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role''
* Select ''Management Server''
* Enter your product key into the Product Key field and change Server Name to the fully qualified host name of the server (e.g. mgmt.ms-spe.test). Enter the user name , the full name (optional), the email address and the password of the initial administrator account that will be used to log on to the Management Console. The password must meet the [[Notes on Password Complexity|complexity rules]]. '''Important notice: '''Changing the host name after the Management Server has been configured requires additional, mostly manual actions such as transferring the license, re-pairing Instance Hosts and Client Access Servers and making changes to the configuration database. Therefore it is recommend to not change the hostname afterwards.
*: [[File:ms_spe_config_mgmt_01.png|center]]
* Fill out the ''Configure Management Server Role'' form.
*: [[File:ms_spe_config_mgmt_02.png|center]]
*; '''Management Server Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from Instance Hosts and Client Access Servers (Default: *:8471)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server to authenticate against Instance Hosts and Client Access Serves. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Console Settings'''
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections to the Management Console (Default: *:8470)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server's HTTP server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management API Settings'''
*; The Management API needs to be active when [[#Pairing_with_Management_Server|Instance Hosts or Client Access Servers will be paired]] with this Management Server.
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections to the Management Console and Management API (Default: *:8470)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server's API server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Debug Log'''
*; In case of errors the debug log of the Management Server can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Management Server role.
* Click ''Start'' to start the Management Server service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Set Up Instance Host ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role''
* Select ''Instance Host''
* Fill out the ''Configure Instance Host Role'' form.
*: [[File:ms_spe_config_ih_01.png|center]]
*; '''Instance Host Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from the Management Server (Default: *:8472)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Instance Host to authenticate against Management Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Server Connection'''
** '''Management Server:''' Fully qualified host name (FQHN) of the Management Server to connect to.
** '''Port:''' TCP port where the above Management Server accepts incoming connections.
** '''Management Server Cert:''' Fingerprint of the TSL certificate used by the Management Server to authenticate against Instance Host. This value is set automatically when [[Multi_Server_Mode_Setup#Pairing with Management Server|Pairing with Management Server]]
*; '''Debug Log'''
*; In case of errors the debug log of the Instance Host can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Instance Host role.
* Click ''Start'' to start the Instance Host service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Set Up Client Access Server ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*; [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role'' .
* Select ''Client Access Server''.
* Fill out the ''Configure Client Access Server Role'' form.
*: [[File:ms_spe_config_cas_01.png|center]]
*; '''Client Access Server Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from the Management Server (Default: *:8473)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Client Access Server to authenticate against Management Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Server Connection'''
** '''Management Server:''' Fully qualified host name (FQHN) of the Management Server to connect to.
** '''Port:''' TCP port where the above Management Server accepts incoming connections.
** '''Management Server Cert:''' Fingerprint of the TLS certificate used by the Management Server to authenticate against Client Access Server. This value is set automatically when [[Multi_Server_Mode_Setup#Pairing with Management Server|Pairing with Management Server]]
*; '''Features'''
**; '''Client Access / Web Access / Outlook Add-in (HTTPS) Enabled:''' If enabled the Client Access Server provides access to archives via MailStore Client, MailStore Outlook Add-in and MailStore Web Access.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:443)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the HTTP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
**; '''IMAP Server with explicit TLS Enabled:''' If enabled the Client Access Server provides access to archives via IMAP protocol. Connections must be secured via STARTTLS.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:143)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the IMAP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
**; '''IMAP Server with implicit TLS Enabled:''' If enabled the Client Access Server provides access to archives via IMAP protocol. Connection is encrypted via SSL/TLS.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:993)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the IMAP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Debug Log'''
*; In case of errors the debug log of the Client Access Server can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Client Access Server role.
* Click ''Start'' to start the Client Access Server service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Pairing with Management Server ===
Before Client Access Servers and Instance Hosts are able to communicate with the Management Server, TLS certificate fingerprints must be exchanged to establish a trust relationship. Additionally the Instance Hosts and Client Access Servers must be registered in the Management Server with its server name and TCP port.

This process can simply be performed by using the pairing function as described in the following:

* Enter the fully qualified host name of the server where the role is added in the ''Server Name'' field.
* Enter the fully qualified host name of the ''Management Server'' in the corresponding ''Management Server'' field while configuring an Instance Host or Client Access Server.
* Click ''Pair with this server''.
* Enter the user name and password of a MailStore Service Provider Edition administrator.
* Click ''OK'' to pair this role with the Management Server.
* The fingerprint of the Management Server's TLS certificate is copied in the ''Management Server Cert'' field of the role to be installed.
* The fingerprint of the role's TCP server's TLS certificate is transferred to the Management Database of the Management Server. This can be reviewed [[Management_Console_-_Infrastructure|here]].

'''Please note:''' Pairing is carried out through the Management API. Therefore the Management API must be enabled on the Management Server and the Instance Hosts and Client Access Servers must be able to establish a connection to the API on the Management Server (Default TCP port: 8474).

If your security policy does not permit establishing such a connection, pairing must be performed manually. Please refer to [[Management Console - Infrastructure#Add New Instance Host|Add New Instance Host]] or [[Management Console - Infrastructure#Add New Client Access Server|Add New Client Access Server]] for further details.

Multi Server Mode Setup

2018-05-30T15:28:16Z

Bmeyn: /* Multi Server Mode Setup */

__NOTOC__
== Multi Server Mode Setup ==
When setting up MailStore Service Provider Edition in multi server mode, the first role to set up must always be the Management Server role. Afterwards one or multiple Instance Hosts and Client Access Servers can be set up. Each server in a multi server mode setup can host one or multiple roles.

=== Set Up Management Server ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role''
* Select ''Management Server''
* Enter your product key into the Product Key field and change Server Name to the fully qualified host name of the server (e.g. mgmt.ms-spe.test). Enter the user name , the full name (optional), the email address and the password of the initial administrator account that will be used to log on to the Management Console. The password must meet the [[Notes on Password Complexity|complexity rules]]. '''Important notice: ''' Changing the hostname after the Management Server has been configured requires additional, mostly manual actions such as transferring the license, re-pairing Instance Hosts and Client Access Servers and making changes to the configuration database. Therefore it is recommend to not change the hostname afterwards.
*: [[File:ms_spe_config_mgmt_01.png|center]]
* Fill out the ''Configure Management Server Role'' form.
*: [[File:ms_spe_config_mgmt_02.png|center]]
*; '''Management Server Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from Instance Hosts and Client Access Servers (Default: *:8471)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server to authenticate against Instance Hosts and Client Access Serves. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Console Settings'''
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections to the Management Console (Default: *:8470)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server's HTTP server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management API Settings'''
*; The Management API needs to be active when [[#Pairing_with_Management_Server|Instance Hosts or Client Access Servers will be paired]] with this Management Server.
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections to the Management Console and Management API (Default: *:8470)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Management Server's API server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Debug Log'''
*; In case of errors the debug log of the Management Server can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Management Server role.
* Click ''Start'' to start the Management Server service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Set Up Instance Host ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role''
* Select ''Instance Host''
* Fill out the ''Configure Instance Host Role'' form.
*: [[File:ms_spe_config_ih_01.png|center]]
*; '''Instance Host Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from the Management Server (Default: *:8472)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Instance Host to authenticate against Management Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Server Connection'''
** '''Management Server:''' Fully qualified host name (FQHN) of the Management Server to connect to.
** '''Port:''' TCP port where the above Management Server accepts incoming connections.
** '''Management Server Cert:''' Fingerprint of the TSL certificate used by the Management Server to authenticate against Instance Host. This value is set automatically when [[Multi_Server_Mode_Setup#Pairing with Management Server|Pairing with Management Server]]
*; '''Debug Log'''
*; In case of errors the debug log of the Instance Host can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Instance Host role.
* Click ''Start'' to start the Instance Host service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Set Up Client Access Server ===
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the ''MailStore Service Provider Edition Configuration'' will ask for the desired mode. Select ''Multi Server Mode'' and click ''OK''.
*; [[File:ms_spe_config_multi_01.png|center]]
* Click ''Add Server Role'' .
* Select ''Client Access Server''.
* Fill out the ''Configure Client Access Server Role'' form.
*: [[File:ms_spe_config_cas_01.png|center]]
*; '''Client Access Server Settings'''
** '''Server Name:''' Fully qualified host name (FQHN) of the server
** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections from the Management Server (Default: *:8473)
** '''Certificate: ''' Fingerprint of the TLS certificate used by the Client Access Server to authenticate against Management Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Management Server Connection'''
** '''Management Server:''' Fully qualified host name (FQHN) of the Management Server to connect to.
** '''Port:''' TCP port where the above Management Server accepts incoming connections.
** '''Management Server Cert:''' Fingerprint of the TLS certificate used by the Management Server to authenticate against Client Access Server. This value is set automatically when [[Multi_Server_Mode_Setup#Pairing with Management Server|Pairing with Management Server]]
*; '''Features'''
**; '''Client Access / Web Access / Outlook Add-in (HTTPS) Enabled:''' If enabled the Client Access Server provides access to archives via MailStore Client, MailStore Outlook Add-in and MailStore Web Access.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:443)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the HTTP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
**; '''IMAP Server with explicit TLS Enabled:''' If enabled the Client Access Server provides access to archives via IMAP protocol. Connections must be secured via STARTTLS.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:143)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the IMAP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
**; '''IMAP Server with implicit TLS Enabled:''' If enabled the Client Access Server provides access to archives via IMAP protocol. Connection is encrypted via SSL/TLS.
*** '''Listeners:''' If the server is multihomed you can specify on which IP address and TCP port to listen for incoming connections (Default: *:993)
*** '''Certificate:''' Fingerprint of the TLS certificate used by the IMAP Server. Use the button next to the fingerprint to select a different certificate from the computer's certificate store.
*; '''Debug Log'''
*; In case of errors the debug log of the Client Access Server can be enabled here.
** '''Path: ''' Directory on the file system where the debug log files are written into.
* Click ''OK'' to add the Client Access Server role.
* Click ''Start'' to start the Client Access Server service.
*: '''Please note:''' As the startup process of the services is asynchronous, please wait up to 30 seconds. A service shown as running may still switch back to stopped during that period if an error occurred.
* It is now safe to close the MailStore Service Provider Edition Configuration tool

=== Pairing with Management Server ===
Before Client Access Servers and Instance Hosts are able to communicate with the Management Server, TLS certificate fingerprints must be exchanged to establish a trust relationship. Additionally the Instance Hosts and Client Access Servers must be registered in the Management Server with its server name and TCP port.

This process can simply be performed by using the pairing function as described in the following:

* Enter the fully qualified host name of the server where the role is added in the ''Server Name'' field.
* Enter the fully qualified host name of the ''Management Server'' in the corresponding ''Management Server'' field while configuring an Instance Host or Client Access Server.
* Click ''Pair with this server''.
* Enter the user name and password of a MailStore Service Provider Edition administrator.
* Click ''OK'' to pair this role with the Management Server.
* The fingerprint of the Management Server's TLS certificate is copied in the ''Management Server Cert'' field of the role to be installed.
* The fingerprint of the role's TCP server's TLS certificate is transferred to the Management Database of the Management Server. This can be reviewed [[Management_Console_-_Infrastructure|here]].

'''Please note:''' Pairing is carried out through the Management API. Therefore the Management API must be enabled on the Management Server and the Instance Hosts and Client Access Servers must be able to establish a connection to the API on the Management Server (Default TCP port: 8474).

If your security policy does not permit establishing such a connection, pairing must be performed manually. Please refer to [[Management Console - Infrastructure#Add New Instance Host|Add New Instance Host]] or [[Management Console - Infrastructure#Add New Client Access Server|Add New Client Access Server]] for further details.

Single Server Mode Setup

2018-05-30T15:26:47Z

Bmeyn: /* Set Up Single Server Mode */

__NOTOC__
== Set Up Single Server Mode ==
* If not executed automatically by the installation program, start the MailStore Service Provider Edition Configuration tool by double-clicking its desktop icon. On a Windows Server Core use the command line prompt to start the executable (default: <tt>%PROGRAMFILES%\MailStore Infrastructure\MailStoreInfrastructureConfig.exe</tt>.
* If no configuration files and services are found, the MailStore Service Provider Edition Configuration tool will ask for the desired mode. Select ''Single Server Mode'' and click ''OK''.
*: [[File:ms_spe_config_01.png|center]]
* Enter your product key into the ''Product Key'' field and change ''Server Name'' to the fully qualified host name of the server (e.g. <tt>server.ms-spe.test</tt>). Enter the user name , the full name (optional), the email address and the password of the initial administrator account that will be used to log on to the Management Console. The password must meet the [[Notes on Password Complexity|complexity rules]]. '''Important notice: ''' Changing the hostname after MailStore SPE has been configured requires additional, mostly manual actions such as transferring the license, recreation of roles and making changes to the configuration database. Therefore it is recommend to not change the hostname afterwards.
*: [[File:ms_spe_config_02.png|center]]
* Click ''OK''.
* The MailStore Service Provider Edition Configuration tool will now create the configuration files for the ''Management Server'', ''Instance Host'' and ''Client Access Server'' roles. After the configuration has been successfully created, a Windows service is registered and started for each role. It takes about 10-15 seconds until the roles show up in the MailStore Service Provider Edition Configuration tool. '''Important notice:''' Unless a different target directory was specified during installation, the configuration files are stored in <tt>%PROGRAMFILES%\MailStore Infrastructure\config</tt>. Although these files are in text format (JSON), please do not attempt to modify any of these files without using the MailStore Service Provider Edition Configuration tool.
*: [[File:ms_spe_config_status_all_roles.png|550px|center]]
* The startup process of the services takes place in the background. Therefore a service shown as ''running'' may still revert to ''stopped'' during a period of about 30 seconds in the event of an error.

Template:Notes on Password Complexity

2018-05-30T15:25:48Z

Bmeyn:

* must be at least 10 characters long,
* must not contain the user name,
* must not contain the product name ''MailStore'', the comparison is done case insensitive,
* must not contain the same character more than two times in a row,
* must have characters from at least 3 out of 5 character classes. These 5 character classes are:
** the upper case letters A-Z,
** the lower case letters a-z,
** the digits 0-9,
** the special characters !"#$%&'()*+,-./:;<=>?\[]@^_`{|}~ and the space character,
** characters that are neither upper case nor lower case, e.g. Chinese and Japanese characters.

Update Notices

2018-04-13T15:50:14Z

Bmeyn: /* Upgrading to Version 11 */

== General Information ==
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation.
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.

== Upgrading to Version 11 ==
* '''Upgrading Archive Stores''' Until the archive stores have been upgraded, not all functionality of the software is available. To facilitate
** retention policies,
** the search functionality,
** the improved recovery records,
*; the databases of the archive stores must be upgraded. Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
* '''Retention Policies''' If not all attached archive stores are available (State: ''Archive here'', ''Normal''), or their status is ''Write-Protected'', no automatic processing of retention policies takes place. Therefore verify if an archive store is set to ''Disabled'' or ''Write-Protected'' after the upgrade and change it to one of the above states or detach it completely. Please notice that only end customers are allowed to manage retention policies.
* '''Jobs''' With the release of this version, the service provider administrator ''$archiveadmin'' is limited to manage only his own jobs.
* '''Access via Integrated IMAP Server''' To access the archive via the integrated IMAP server, an encrypted connection is now mandatory. If necessary, adjust the configuration of your email clients accordingly and enable TLS or STARTTLS.
* '''Management API Commands Get-/SetComplianceConfiguration''' The property ''globalRetentionTimeYears'' has been removed from the commands. Own scripts using these commands have to be adjusted accordingly. To manage retention policies, two new commands are available: ''GetRetentionPolicies'' and ''SetRetentionPolicies''.

== Upgrading to 10.2 ==
* '''Branding''' For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.

== Upgrading to 10.1 ==
* '''Archiving Emails''' If not all attached archive stores are available (State: ''Archive here'', ''Normal'', or ''Write-Protected''), no archiving takes place. Running archiving profiles are terminated with an appropriate message. Under certain circumstances this prevents the creation of duplicate emails while archiving. Therefore verify if an archive store is set to ''disabled'' after the upgrade and change it to one of the above states or detach it completely.

== Upgrading to Version 10 ==
* '''Upgrade of Master Database''' To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.
* '''Upgrading Archive Stores''' To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
* '''Archives of Other Users''' These are no longer visible for instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked. Administrative functions such as deleting or renaming user archives are accessible through ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.
* '''Export E-mails''' The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.
* '''Auditing''' All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.

== Upgrading to Version 9.x ==
* '''System Requirements''' Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.
* '''E-mail Archive Client Compatibility''' Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.
* '''PDF Support of Full Text Search''' PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.
* '''MailStore Management API''' The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.

Management API - Function Reference

2018-02-13T10:33:21Z

Bmeyn:

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get current state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemSmtpConfiguration ==
Get current system wide SMTP configuration.

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RenameStore ==
Rename archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to receive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archive store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system administrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system administrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string,
"emailAddress" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== SetSystemSmtpConfiguration ==
Set system wide SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== config ====
Example config object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientSystemAdministrator": ["admin", "johndoe"]
}
</source>

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== TestSystemSmtpConfiguration ==
Test current system wide SMTP configuration.

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via the Email Archive client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The unique identifier of the job to be deleted.
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>jobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"adminEmailPreviewEnabled": true,
"globalRetentionTimeYears": null,
"legalHoldEnabled": false,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
</source>

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddress": "administrator@example.com"
}
</source>

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma separated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

=== Argument Values ===

==== privileges ====
{{Template:Management_API_User_Privileges}}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

=== Argument Values ===

==== privileges ====

{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
|-
| <tt>read</tt>
| The user is granted read access to the specified folder.
|-
| <tt>write</tt>
| The user is granted write access to the specified folder. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folder.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

Template:Management API User Privileges

2018-02-13T10:31:44Z

Bmeyn: Created page with "{| class="wikitable" ! width=270px | Name ! Description |- | <tt>none</tt> | The user is granted no global privileges. If specified, this value has to be the only value in the..."

{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>none</tt>
| The user is granted no global privileges. If specified, this value has to be the only value in the list.
|-
| <tt>admin</tt>
| The user is granted administrator privileges. If specified, this value has to be the only value in the list.
|-
| <tt>login</tt>
| The user can log on to MailStore Server.
|-
| <tt>changePassword</tt>
| The user can change his own MailStore Server password. This only makes sense if the authentication is set to ''integrated''.
|-
| <tt>archive</tt>
| The user can run archiving profiles.
|-
| <tt>modifyArchiveProfiles</tt>
| The user can create, modify and delete archiving profiles.
|-
| <tt>export</tt>
| The user can run export profiles.
|-
| <tt>modifyExportProfiles</tt>
| The user can create, modify and delete export profiles.
|-
| <tt>delete</tt>
| The user can delete messages. Please note that a non-admin user can only delete messages in folders where he has been granted delete access. In addition, compliance settings may be in effect, keeping administrators and users from deleting messages even if they have been granted the privilege to do so.
|}

Update Notices

2017-11-22T08:40:03Z

Bmeyn: /* Upgrading to 10.2 */

== General Information ==
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation.
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be cancelled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server
* Please note the following version specific upgrade notices. Also read the notices from all version numbers between yours and the one you are going to install.

== Upgrading to 10.2 ==
* '''Branding''' For the new responsive Web Access additional branding parameters were introduced. Please review your branding configuration after installing the upgrade. See [[Branding]] for the full list of options.

== Upgrading to 10.1 ==
* '''Archiving Emails''' If not all attached archive stores are available (State: ''Archive here'', ''Normal'', or ''Write-Protected''), no archiving takes place. Running archiving profiles are terminated with an appropriate message. Under certain circumstances this prevents the creation of duplicate emails while archiving. Therefore verify if an archive store is set to ''disabled'' after the upgrade and change it to one of the above states or detach it completely.

== Upgrading to Version 10 ==
* '''Upgrade of Master Database''' To facilitate encryption of the master database it is upgraded to Firebird 3 during the first start of an instance and encrypted afterwards. This process might extend the time required for the first start of the instance by several minutes.
* '''Upgrading Archive Stores''' To facilitate encryption the databases of the archive store must be upgraded. Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Right-click on an archive store and select ''Perform Upgrade'' to upgrade a single archive store.
** Carefully read the notices and click on ''OK'' to start the upgrade process or click on ''Cancel''.
* '''Archives of Other Users''' These are no longer visible for instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked. Administrative functions such as deleting or renaming user archives are accessible through ''Administrative Tools > Users and Archives > Archives'' in the Email Archive Client.
* '''Export E-mails''' The previous change may also have an impact on export profiles owned by an instance administrator, in case the export scope contains archives of other users. As these are no longer visible to instance administrators if the ''Archive Access'' (formerly knows as ''E-mail Preview'') is blocked, they are not taken into account by export profiles.
* '''Auditing''' All activities that are exclusively executable by instance administrators are displayed as ''Enabled (locked)'' at ''Compliance'' > ''Auditing''. Irrespective of the ''Disabled'' status, all activities of instance administrators, excluding ''MessageRetrieveContent'', are written into the audit log.

== Upgrading to Version 9.x ==
* '''System Requirements''' Please ensure that your system configuration matches the updated system requirements. MailStore Service Provider Edition now requires .NET Framework 4.5.1. The E-mail Archive Client and E-mail Archive Add-in for Outlook now require .NET Framework 4.5.1 and Internet Explorer 8 or higher.
* '''E-mail Archive Client Compatibility''' Due to a bug in version 8.5 of the E-mail Archive Client, it cannot update itself to version 9. Therefore re-deployment of version 9 of the E-mail Archive Client is required.
* '''PDF Support of Full Text Search''' PDF support has been removed from MailStore SPE's own indexer. Therefore it is required to either install a recent version of Adobe Reader or an appropriate IFilter driver (i.e. [https://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] on the Instance Host machines.
* '''MailStore Management API''' The Management API is now listening on its own TCP port, 8474 by default. It does no longer support sessions, thus login, logout and cookie handling is no longer required nor supported. HTTP basic authentication must be used instead. Please make sure to modify your scripts accordingly. The API is not enabled by default. You have to activate it in the Management Role.

Management API - Function Reference

2017-11-08T08:54:19Z

Bmeyn: /* dayOfMonth */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get currrent state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RenameStore ==
Rename archvive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to reveive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archvie store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system adminstrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system adminstrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"fullName" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric representation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The uniqe identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| Unique ID of message. Format: <store_id>:<message_num>
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>JobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --instanceID="customer1" --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --JobId=1''

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<pre>
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddress": "administrator@example.com"
}
</pre>

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma seperated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

Management API - Function Reference

2017-11-08T08:52:51Z

Bmeyn: /* interval */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get currrent state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RenameStore ==
Rename archvive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to reveive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archvie store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system adminstrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system adminstrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"fullName" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>240</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The uniqe identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| Unique ID of message. Format: <store_id>:<message_num>
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>JobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --instanceID="customer1" --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --JobId=1''

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

=== Argument Values ===

==== settings====
Example settings object:
<pre>
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddress": "administrator@example.com"
}
</pre>

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma seperated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

Management API - Function Reference

2017-10-26T13:29:00Z

Bmeyn: /* SetUserAuthentication */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get currrent state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RenameStore ==
Rename archvive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to reveive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archvie store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system adminstrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system adminstrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"fullName" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The uniqe identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| Unique ID of message. Format: <store_id>:<message_num>
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>JobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --instanceID="customer1" --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --JobId=1''

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetSmtpSettings ==
Set SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>settings</tt>
| json
| SMTP configuration.
|}

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma seperated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

Management API - Function Reference

2017-10-26T13:27:16Z

Bmeyn: /* SyncUsersWithDirectoryServices */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get currrent state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RenameStore ==
Rename archvive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to reveive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archvie store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system adminstrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system adminstrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"fullName" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The uniqe identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| Unique ID of message. Format: <store_id>:<message_num>
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>JobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --instanceID="customer1" --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --JobId=1''

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma seperated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

== TestSmtpSettings ==
Test current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

Management API - Function Reference

2017-10-26T13:22:49Z

Bmeyn: /* GetServiceStatus */

__NOTOC__

== AttachStore ==
Attach existing archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CompactStore ==
Compact archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store
|}

== CreateClientAccessServer ==
Register new client access server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Client Access Server.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateClientOneTimeUrlForArchiveAdmin ==
Create URL including OTP for $archiveadmin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>instanceUrl</tt>
| string (optional)
| Base URL for accessing instance.
|}

== CreateDirectoryOnInstanceHost ==
Create a directory on an Instance Host

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string
| Path of directory to create.
|}

== CreateInstance ==
Create new MailStore instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new instance.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== CreateInstanceHost ==
Create a new Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new Instance Host.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== CreateLicenseRequest ==
Create and return data of a license request.

== CreateStore ==
Create and attach a new archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string
| Meaningful name of archive store.
|-
| <tt>path</tt>
| string
| Path of directory containing archive store data.
|-
| <tt>requestedState</tt>
| string (optional)
| State of archive store after attaching.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== CreateSystemAdministrator ==
Create a new SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Configuration of new SPE system administrator.
|-
| <tt>password</tt>
| string
| Password of new SPE system administrator.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"userName" : string,
"fullName" : string
}
</source>

== DeleteClientAccessServer ==
Delete Client Access Server from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Client Access Server.
|}

== DeleteInstanceHost ==
Delete Instance Host from management database.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|}

== DeleteInstances ==
Delete one or multiple MailStore Instances

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== DeleteSystemAdministrator ==
Delete SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|}

== DetachStore ==
Detach archive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== FreezeInstances ==
Freeze a MailStore Instance

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetArchiveAdminEnabled ==
Get currrent state of archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetClientAccessServers ==
Get list of Client Access Servers.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|-
| <tt>withServiceStatus</tt>
| bool
| Include service status or not.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetDirectoriesOnInstanceHost ==
Get file system directory structure from Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverName</tt>
| string
| Name of Instance Host.
|-
| <tt>path</tt>
| string (optional)
| Path of directory to obtain subdirectories from.
|}

== GetEnvironmentInfo ==
Return general information about SPE environment.

== GetIndexConfiguration ==
Get list of attachment file types to index.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstanceHosts ==
Get list of Instance Hosts.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverNameFilter</tt>
| string (optional)
| Server name filter string.
|}

=== Argument Values ===

==== serverNameFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>null</tt>
| All servers
|-
| <tt>serverName</tt>
| Only the given serverName. Must match exactly.
|}

== GetInstanceProcessLiveStatistics ==
Get live statistics from instance process.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetInstances ==
Get list of instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== GetInstanceStatistics ==
Get archive statistics from instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetServiceStatus ==
Get current status of all SPE services.

== GetSmtpSettings ==
Get current SMTP configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStoreAutoCreateConfiguration ==
Get automatic archive store creation settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetStores ==
Get list of archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetSystemAdministrators ==
Get list of system administrators.

== MaintainFileSystemDatabases ==
Execute maintenance task on archive store databases.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== MergeStore ==
Merge two archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of destination archive store.
|-
| <tt>sourceId</tt>
| number
| Unique ID of source archive store.
|}

== PairWithManagementServer ==
Pair server role with Management Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>serverType</tt>
| string
| Type of server role.
|-
| <tt>serverName</tt>
| string
| Name of server that hosts 'serverType' role.
|-
| <tt>port</tt>
| number
| TCP port on which 'serverType' role on 'serverName' accepts connections.
|-
| <tt>thumbprint</tt>
| string
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
|}

=== Argument Values ===

==== serverType ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>instanceHost</tt>
| Pairing an Instance Host.
|-
| <tt>clientAccessServer</tt>
| Pairing a Client Access Server.
|}

== Ping ==
Send a keep alive packet.

== RebuildSelectedStoreIndexes ==
Rebuild search indexes of selected archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== RenameStore ==
Rename archvive store

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>name</tt>
| string
| New name of archive store.
|}

== RestartInstances ==
Restart one or multiple instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== RetryOpenStores ==
Retry opening stores that failed previously

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SelectAllStoreIndexesForRebuild ==
Select all archive store for rebuild.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== SetArchiveAdminEnabled ==
Enable or disable archive admin access.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>enabled</tt>
| bool
| Enable or disable flag.
|}

== SetClientAccessServerConfiguration ==
Set the configuration of a Client Access Server.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Client Access Server configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
}
}
</source>

== SetIndexConfiguration ==
Set full text search index configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Full text search index configuration.
|}

=== Argument Values ===

==== config ====
Use GetIndexConfiguration to reveive supported value.

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"instanceID" : string,
"alias" : string,
"displayName" : string,
"instanceHost" : string,
"startMode" : string,
"baseDirectory" : string,
"debugLogEnabled" : bool,
"vssWriterEnabled" : bool
}
</source>

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| Instance Host configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"serverName" : string,
"port" : number,
"serverCertificate" : {
"thumbprint" : string
},
"baseDirectory" : string
}
</source>

== SetStoreAutoCreateConfiguration ==
Set configuration for automatic archive store creation.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Archive store automatic creation configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"enabled" : bool,
"interval" : string,
"sizeThreshold" : string,
"numberOfMessagesThreshold" : number,
"baseDirectory" : string
}
</source>

== SetStorePath ==
Set the path to archive store data.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>path</tt>
| string
| Path to archvie store data.
|}

== SetStoreRequestedState ==
Set state of archive store.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|-
| <tt>requestedState</tt>
| string
| State of archive store.
|}

=== Argument Values ===

==== requestedState ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>current</tt>
| Same as Normal but new messages will be archived in the archive store that is set to Current.
|-
| <tt>normal</tt>
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| <tt>writeProtected</tt>
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| <tt>disabled</tt>
| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
|}

== SetSystemAdministratorConfiguration ==
Set SPE system adminstrator configuration.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>config</tt>
| json
| SPE system adminstrator configuration.
|}

=== Argument Values ===

==== config ====
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
{
"fullName" : string
}
</source>

== SetSystemAdministratorPassword ==
Set password for SPE system administrator.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>userName</tt>
| string
| User name of SPE system administrator.
|-
| <tt>password</tt>
| string
| New password for SPE system administrator.
|}

== StartInstances ==
Start one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== StopInstances ==
Stop one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== ThawInstances ==
Thaw one or multiple MailStore Instances.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceFilter</tt>
| string
| Instance filter string.
|}

=== Argument Values ===

==== instanceFilter ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>*</tt>
| All instances
|-
| <tt>instance01 instance02 instance03</tt>
| instance01, instance02 and instance03
|-
| <tt>*instancehost01 *instancehost02</tt>
| All instances on instancehost1 and instancehost2
|-
| <tt>* .running</tt>
| All running instances
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade archive store from MailStore Server 5 or older to current format.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStore ==
Verify archive stores consistency.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of archive store.
|}

== VerifyStores ==
Verify consistency of all archive stores.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== CancelJobAsync ==
Cancel a running job asynchronously.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be canceled.
|}

== ClearUserPrivilegesOnFolders ==
Removes all privileges of a user on all archive folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== CreateJob ==
Create a new job to execute Management API commands.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>name</tt>
| string (optional)
| A meaningful name for the job. Example: ''Daily Backup''.
|-
| <tt>action</tt>
| string (optional)
| Management API command to execute.
|-
| <tt>owner</tt>
| string (optional)
| Username of the job owner; must be an administrator.
|-
| <tt>timeZoneId</tt>
| string (optional)
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== CreateProfile ==
Create a new archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.

== CreateUser ==
Create new MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of new MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|-
| <tt>authentication</tt>
| string (optional)
| Authentication setting for user: 'integrated' or 'directoryServices'.
|-
| <tt>password</tt>
| string (optional)
| Password of new user.
|}

== DeleteEmptyFolders ==
Remove folders from folder tree that do not contain emails.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Entry point in folder tree.
|}

== DeleteJob ==
Deletes a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| The uniqe identifier of the job to be deleted.
|}

== DeleteMessage ==
Delete a single message

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| string (optional)
| Unique ID of message. Format: <store_id>:<message_num>
|}

== DeleteProfile ==
Delete an archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique ID of profile.
|}

== DeleteUser ==
Delete a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|}

== GetChildFolders ==
Get child folders.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Parent folder.
|-
| <tt>maxLevels</tt>
| number (optional)
| Depth of child folders.
|}

== GetComplianceConfiguration ==
Get current compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetDirectoryServicesConfiguration ==
Get current Directory Services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetFolderStatistics ==
Get folder statistics.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetJobResults ==
Retrieves list of finished job executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneId</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>JobId</tt>
| number (optional)
| The job id for which to retrieve results.
|}

Interactive Management Shell Example: ''GetJobResults --instanceID="customer1" --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --JobId=1''

== GetJobs ==
Retrieve list of jobs

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetMessages ==
Get list of messages from a folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>folder</tt>
| string (optional)
| Folder whose content to list.
|}

== GetProfiles ==
Get list of archiving and exporting profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

== GetTimeZones ==
Get list of available time zones.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetUserInfo ==
Get detailed information about user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user
|}

== GetUsers ==
Get list of users.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|}

== GetWorkerResults ==
Get results of profile executions.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromIncluding</tt>
| string
| Beginning of time range to fetch.
|-
| <tt>toExcluding</tt>
| string
| End of time range to fetch.
|-
| <tt>timeZoneID</tt>
| string
| Time zone in which timestamp should be returned.
|-
| <tt>profileID</tt>
| number (optional)
| Filter results by given profile ID.
|-
| <tt>userName</tt>
| string (optional)
| Filter results by given user name.
|}

== MoveFolder ==
Move folder.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>fromFolder</tt>
| string
| Old folder name.
|-
| <tt>toFolder</tt>
| string
| New folder name.
|}

== RenameJob ==
Rename job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be renamed.
|-
| <tt>name</tt>
| string (optional)
| The new job name.
|}

== RenameUser ==
Rename a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>oldUserName</tt>
| string
| Old user name.
|-
| <tt>newUserName</tt>
| string
| New user name.
|}

== RunJobAsync ==
Run an existing job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| The identifier of the job to be run.
|}

== RunProfile ==
Run an existing archiving or exporting profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number
| Unique profile ID.
|}

== RunTemporaryProfile ==
Run a temporary/non-existent profile.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>properties</tt>
| json
| Profile properties.
|-
| <tt>raw</tt>
| bool
| Currently only 'true' is supported.
|}

=== Argument Values ===

==== properties ====
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.

== SetComplianceConfiguration ==
Set compliance configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Compliance configuration.
|}

=== Argument Values ===

==== config ====
Use GetComplianceConfiguration to receive supported value.

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>config</tt>
| json
| Directory services configuration.
|}

=== Argument Values ===

==== config ====
Use GetDirectoryServicesConfiguration to receive supported value.

== SetJobEnabled ==
Set enabled status of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| number (optional)
| The unique identifier of the job to be modified.
|-
| <tt>enabled</tt>
| bool (optional)
| Boolean value of '''enabled''' attribute.
|}

== SetJobSchedule ==
Modify the schedule of a job.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>id</tt>
| number
| The unique identifier of the job to be modified.
|-
| <tt>timeZoneId</tt>
| string
| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
|-
| <tt>date</tt>
| string (optional)
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
|-
| <tt>interval</tt>
| number (optional)
| Interval for running job.
|-
| <tt>time</tt>
| string (optional)
| Time for running job. Without additional parameter, this means daily execution.
|-
| <tt>dayOfWeek</tt>
| string (optional)
| Day of week to run job. Parameter "time" also required.
|-
| <tt>dayOfMonth</tt>
| string (optional)
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
|}

=== Argument Values ===

==== interval ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>5</tt>
| Every 5 minutes.
|-
| <tt>10</tt>
| Every 10 minutes.
|-
| <tt>15</tt>
| Every 15 minutes.
|-
| <tt>20</tt>
| Every 20 minutes.
|-
| <tt>30</tt>
| Every 30 minutes.
|-
| <tt>60</tt>
| Every hour.
|-
| <tt>120</tt>
| Every 2 hours.
|-
| <tt>180</tt>
| Every 3 hours.
|-
| <tt>260</tt>
| Every 4 hours.
|-
| <tt>360</tt>
| Every 6 hours.
|-
| <tt>720</tt>
| Every 12 hours.
|}

==== dayOfWeek ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>Sunday</tt>
| Sunday
|-
| <tt>Monday</tt>
| Monday
|-
| <tt>Tuesday</tt>
| Tuesday
|-
| <tt>Wednesday</tt>
| Wednesday
|-
| <tt>Thursday</tt>
| Thursday
|-
| <tt>Friday</tt>
| Friday
|-
| <tt>Saturday</tt>
| Saturday
|}

==== dayOfMonth ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>1 to 31</tt>
| Numeric represation of day of month.
|-
| <tt>Last</tt>
| Last day of month.
|}

== SetUserAuthentication ==
Set authentication settings of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>authentication</tt>
| string
| Authentication method. Either 'integrated' or 'directoryServices'.
|}

== SetUserDistinguishedName ==
Set the LDAP distinguished name of a MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>distinguishedName</tt>
| string (optional)
| LDAP DN string.
|}

== SetUserEmailAddresses ==
Set email addresses of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>emailAddresses</tt>
| string (optional)
| List of email addresses.
|}

== SetUserFullName ==
Set full name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>fullName</tt>
| string (optional)
| Full name of MailStore user.
|}

== SetUserPassword ==
Set password of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>password</tt>
| string
| Password of MailStore user.
|}

== SetUserPop3UserNames ==
Set POP3 user name of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>pop3UserNames</tt>
| string (optional)
| Comma seperated list of POP3 user names.
|}

== SetUserPrivileges ==
Set privileges of MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>privileges</tt>
| string
| Comma separated list of privileges.
|}

== SetUserPrivilegesOnFolder ==
Set privileges on folder for MailStore user.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>userName</tt>
| string
| User name of MailStore user.
|-
| <tt>folder</tt>
| string
| Folder name.
|-
| <tt>privileges</tt>
| string
| Comma separated list of folder privileges.
|}

== SyncUsersWithDirectoryServices ==
Sync users of MailStore instance with directory services.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>dryRun</tt>
| bool (optional)
| Simulate sync only.
|}

Instance Management

2017-04-10T15:40:53Z

Bmeyn: /* Configure */

For each instance further individual administrative functions exist. These functions are accessible through the instance details, which appear in pane below the instance list (''General > Instances'') of the Management Console when clicking on a running instance in the list.

All these functions are group by tabs, for which further details are provided below.

== Overview ==
On the ''Overview'' tab of the instance details a summary of the configuration is shown.

[[File:Ms_spe_instance_overview.png|center]]

== Archive Stores ==
The ''Archive Stores'' tab allows the administration of the instance storage as well as the search indexes. New archive stores are automatically created in the base directory of the instance every 5.000.000 messages.

=== Create Archive Stores ===
Although MailStore Service Provider Edition creates new archive stores automatically, this can also be done manually as described in the following:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Create Store''.
* Fill out the ''Create Archive Store'' form:
*: [[File:Ms_spe_create_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store.
:* '''Archive new messages here:''' Enabled by default, new message will be archived in the newly created archive store if this option is checked.
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used, e.g. the database and index directory may reside on a fast storage while the content resides in on a slower storage.
:* '''Directory:''' Directory in which the new archive store will be created. A proposal is created from the ''Name'' of the archive store and the base directory of the instance. Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~\Messages-2013-10</code>
* Click ''OK'' to create the new archive store.

=== Attach Existing Archive Store ===
Archive stores from MailStore Service Provider Edition instances or from on-premises MailStore Servers can be attached to an instance as described below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Attach Store''.
* Fill out the ''Attach Archive Store'' form:
*: [[File:Ms_spe_attach_archivestore_01.png|center]]
:* '''Name:''' Meaningful name for the archive store
:* '''Archive new messages here:''' If checked, new message will be archived in the newly created archive store. (default: unchecked)
:* '''Use different directories for database, content and search index:''' If checked, a non-default directory structure can be used. E.g. archive stores created before MailStore SPE/Server 10 do have the search index files located in the same directory as the database.
:* '''Base Directory:''' Directory of the archive store to attach. This directory must contain the file "MailStoreFileGroup.fdb". Use the tilde to point to a directory relative to the base directory of the instance, e.g. <code>~/2016-12</code>.
* Click ''OK'' to attach the archive store.

=== Unlock Archive Stores ===
In case the archive store was migrated from MailStore Server 10 or newer to MailStore SPE, additional steps are required.

==== The archive store is protected with a recovery key ====
* The archive store cannot be loaded successfully and the note ''Unable to unlock archive store (Identifier: <identifier>)'' appears.
: [[File:Ms_spe_attach_locked_generated_value.png|center]]
* To finalize the migration of this archive store you need to know the recovery key identified by <identifier>, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the recovery key. The recovery key must be entered in lowercase letters.
* Click ''Invoke'', ''true'' should appear below the text fields.
: [[File:Ms_spe_attach_unlock_generated_value.png|center]]
* Verify that the archive store was attached successfully.

==== The archive store is protected with a product key ====
* The archive store cannot be loaded successfully and the note ''Unable to open the archive store <name>. Can't decrypt encryption key.'' appears.
: [[File:Ms_spe_attach_locked_product_key.png|center]]
* To finalize the migration of this archive store you need to know the product key of the installation where the archive store was attached to last, the instanceID of the instance where the archive store is attached to and the ID of the attached archive store.
* Navigate to ''Navigation > DEVELOPER > Management API''. Select ''UnlockStore'' from the drop down menu and enter the ''instanceID'' of the instance, the ''ID'' of the archive store and the product key. The product key must be entered in uppercase letters.
* Click ''Invoke'', ''true'' should appear.
: [[File:Ms_spe_attach_unlock_product_key.png|center]]
* Verify that the archive store was attached successfully.

More information about archive security can be found in the [https://help.mailstore.com/en/server/MailStore_Server_Service_Configuration#Security_and_Encryption MailStore Server Service Configuration article].

=== Maintain FS Databases ===
For storing meta data of the archive store's content embedded Firebird databases exist in every archive store. Under certain circumstances (e.g. after a disaster recovery of the server or storage) it might become necessary to perform a maintenance task on those databases. This can easily be done for all archive stores of a particular instance be following the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Maintain FS Databases'' to start the maintenance.
* A progress windows will appear.
* Wait until the process is completed successfully and click ''OK''. Otherwise click ''Cancel'' to interrupt maintenance process at any time.

=== Auto-Create Stores ===
MailStore Service Provider Edition automatically creates new archive stores every 5.000.000 messages. This setting can be adjusted to your need:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Auto-create''.
* Adjust the settings in the ''Auto-Create Archive Stores'' dialog.
*: [[File: Ms_spe_autocreate_stores_01.png|center]]
*: '''Important notice:''' Non-optimal settings can have a negative impact on the overall performance of the instance.
* Click ''OK'' to save the settings.

=== Store Commands ===
Advanced store commands are accessible by following these steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Select an archive store and click on ''Store Commands'' or right-click on an archive store to open a context menu.

A summary of the available store commands can be found in the tables below:

==== Requested State ====

{| class="wikitable"
! width="150px" | State
! Description
|-
| Disabled
| Disabled archive stores are not in use but the instance still knows about their existence. The content is not available to users or administrators while the archive store is disabled. This state is useful when moving archive stores to a new directory.
|-
| Write Protected
| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
|-
| Normal
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
|-
| Current
| Same as ''Normal'' but new messages will be archived in the archive store that is set to ''Current''.
|}

==== Commands ====

{| class="wikitable"
! width="150px" | Command
! Description
|-
| Detach
| Detaches the selected archive store. The archive store can be re-attached by using the ''Attach'' function. Please note that the archive store's name and ID will not be retained when detaching and re-attaching. Therefore, when moving an archive store to a new location, disabling the the archive store and using ''Set Path'' afterwards is preferred over re-attaching.
|-
| Rename
| Specify a new name for the archive store.
|-
| Set Path
| Change the path of the archive store. The archive store must be disabled before changing the path. Please note that the file system directory must be moved manually to the new location before re-enabling the archive store.
|-
| Compact
| Optimizes the data structures.
|-
| Upgrade
| If an archive store from a MailStore Server 5 or older was attached to an instance, it is highly recommended to upgrade the archive store to the latest format by using this function. Upgrade process can be interrupted and continued at any time.
|-
| Verify
| Verification of the data integrity between folder information and meta data as well as email headers and content.
|}

=== Search Indexes ===
Additionally to container files storing the actual email content and the embedded Firebird databases used for storing meta information, a full-text index file is created for each archive that has emails stored in an archive store. By default the full-text index only included email bodies, but virtually any file type is supported (see ''Configure'').

To access these functions, follow the instructions below:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click ''General > Instances''.
* Open the instance details by clicking on a running instance in the list.
* Click on the ''Archive Stores'' tab.
* Click ''Search Indexes''.

The below functions are available in the search index menu to configure and maintain the full-text indexes of an instance.

==== Rebuild Broken Indexes ====
Starts a rebuild of all search indexes across all archive stores that are marked a broken.

==== Rebuild All Indexes ====
Starts a rebuild of all search indexes in all archives stores.
This is usually only required after making changes to the list of attachment extensions to be included in the full-text index.

==== Configure ====
Specify a list of file extensions for attachments to be included in the full-text index. MailStore Service Provider Edition can index all file types for which a so-called IFilter driver is installed on the instance host on which the MailStore Server instance is running. The list of file extensions has to be separated by space.

[[File: Ms_spe_file_extensions.png|center]]

Under the name [http://www.microsoft.com/en-us/download/details.aspx?id=17062 Microsoft Office 2010 Filter Packs] Microsoft offers a package that, additionally to all legacy as well as recent Microsoft Office Formats, supports the Open Document Format (OpenOffice/LibreOffice). For indexing PDF files the Adobe Reader or [http://www.adobe.com/support/downloads/detail.jsp?ftpID=5542 Adobe PDF iFilter] must be installed on the MailStore Server machine. Further background information about the IFilter system itself as well as links to additional IFilter drivers can be found in the corresponding Wikipedia article [[wikipedia:IFilter|IFilter]].

For reasons of stability and performance, MailStore Server processes the following file types directly, regardless of the IFilter drivers that are installed:

* Text files (TXT)
* HTML files (HTM and HTML)

== Archive Access ==
{{:Accessing Instances}}

=== Inside the Instance ===
No matter whether logging on to an instance as the customer's administrator or as service provider via service provider archive access, the available functions of the MailStore Client are nearly the same. Only accessing and or modifying the archive content (e.g. creating folders, deleting messages,..) is prohibited for the ''$archiveadmin'' user.

Please refer to [[Instance Administration]] to get an overview of the functions available inside each individual instance, such as managing users and setting up archiving and how these relate to the on premises solution MailStore Server.

== Live Statistics ==
The ''Live Statistics'' tab shows real time graphics about the instance activity such as I/O, memory and CPU usage as well as number of Remote Procedure Calls (RPC) and the number of emails verified and archived by the instance's archiving mechanism.

Management Console - General

2017-03-28T16:26:29Z

Bmeyn: /* Configuring Instances */

Creating Instances

2017-03-28T16:18:48Z

Bmeyn:

To create new instances for customers follow these steps:

* [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
* Click on ''General'' > ''Instances''.
* Click ''Create Instance''.
* Enter a unique ''Instance ID''.
*: [[File:Ms_spe_create_instance_01.png|center]]
*: '''Hint:''' It is not necessary to choose a meaningful instance ID, as an alias name can define in the next step. The instance ID could for example be a customer number or any other unique identifier from a CRM system.
* Click ''OK''.
* Fill out the ''Instance Configuration'' form:
*: [[File:Ms_spe_create_instance_02.png|center]]
*: ''Tab: Base Configuration''
*:: '''URL Alias''' Meaningful unique alias name that can be used as an alternative to the instance ID.
*:: '''Display Name:''' Additional identification information for the instance, e.g. customer name.
*:: '''Instance Host:''' Instance Host on which the new instance gets created.
*:: '''Start Mode:''' Defines how the instance is started. Choose from the following options (Default: ''Automatic''):
*::: ''Disabled:'' The instance can neither be started automatically nor manually.
*::: ''Manual:'' The instance can only be started manually.
*::: ''Automatic:'' The instance will automatically be started with the Instance. Host.
*:: '''Base Directory:''' Directory where instance's data will be stored.
*: ''Tab: Advanced Configuration''
*:: '''Enable VSS Writer:''' Enable support for Volume Shadow Service.
*::: '''Exclude Indexes from VSS Backup:''' Excludes the unencrypted search index files from the backup set reported by the VSS writer.
*:::: '''Please note:''' This option can be set so that administrators which have access to the backup files cannot access the unencrypted search index files. When restoring backups that do not include search index files, the search indexes have to be [[Instance_Management#Search_Indexes|rebuilt]].
*:: '''Enable Debug Log:''' Enable debug logging for the instance.
*:: '''Enable IMAP Server Connection Log:''' Enable IMAP Server connection logging for the instance.
* Click ''OK'' to create the instance.
* MailStore Service Provider Edition will now create the new instance and displays the login credential for afterwards.
*: [[File:Ms_spe_create_instance_03.png|center]]
*: If the end customer should be able to administrate the newly created MailStore Server instance on his own, these credentials must be made available to him. Otherwise it is not necessary to save these credentials.
* Click ''OK'' to finish.

Irrespective of the configured ''Start Mode'', the newly created instance must be started manually before it can be used. Read more about starting, stopping and restarting of instances in the next section.