MailStore SPE Help - User contributions [en]

System Requirements

2023-03-03T12:32:22Z

Rrommelrath:

__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 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)
** Windows Server 2022 Standard or Datacenter (Server without Desktop Experience)
** Windows Server 2022 Standard or Datacenter (Server with Desktop Experience)
* The 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.8''' 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.8 feature must be done manually before executing the MailStore Service Provider Edition setup file. 
* '''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. If a system wide proxy has been configured, it will be used.
* If there will be multiple Client Access Servers (CAS) and a load balancer is installed in front of these CAS, the load balancer must be configured in such a way that a user's sessions terminate on the same CAS (sticky sessions).
* 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.
|}

File:Ms spe instance overview.png

2022-12-21T10:40:56Z

Rrommelrath: Rrommelrath uploaded a new version of File:Ms spe instance overview.png

Instance Management

2022-12-21T10:35:35Z

Rrommelrath: MS-2263-removed-abandoned-live-statistics

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.

Moving Roles

2022-11-16T15:17:21Z

Rrommelrath:

== Single Server Mode ==
In order to retain a single server mode setup by keeping the Management Server, Instance Host and Client Access Server on a single server, follow the instructions below. If only one of the roles in a single server mode setup should to be moved to another server, refer to corresponding section under [[Moving Roles#Multi_Server_Mode|Multi Server Mode]] in this article.

* The following only applies if MFA has been enabled for some or all system administrators:
*:* Log in at the Management Console and [[Management_Console_-_System_Administrators|disable MFA]] for all administrators that have it enabled. The MFA secret, that is used to generate MFA codes, is stored DPAPI-protected in the management database. When the management database is transferred to a different machine, the secret cannot be decrypted on that machine and manual editing of the database would be required, which should be avoided.
* Start the MailStore Service Provider Edition Configuration tool on the server that has the Management Server role by double-clicking its 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'', ''Instance Host'', and ''Management Server'' services.
* Transfer your MailStore SPE license to the new server through our [https://my.mailstore.com/TransferLicense license portal].
* Install MailStore Service Provider Edition on the new server and set it up [[Single_Server_Mode_Setup|Single Server Mode]].
* Stop the ''Client Access Server'', ''Instance Host'', and ''Management Server'' services on the new server.
* Remove all MailStore SPE related certificates from the server's personal (MY) certificate store of the new server.
*: [[File:Spe-certificate-store.png|center]]
* Export the SSL certificates and private keys from the old server's certificate store and import them into the same location on the new server.
** On Windows Server 2012 R2 you can use the following PowerShell command to export all certificats stored in the computers ''MY'' store as PFX containers to the current user's desktop. That PowerShell session requires elevated privileges: <pre>(Get-ChildItem Cert:\LocalMachine\My).Thumbprint | ForEach-Object { Export-PfxCertificate -Cert ("Cert:\LocalMachine\My\{0}" -f $_) -FilePath ("$env:USERPROFILE\Desktop\{0}.pfx" -f $_) -Password (ConvertTo-SecureString -AsPlainText -Force "not_secure_234") }</pre>
** Windows Server 2012 R2 Powershell command to import the previously exported certificates from the current user's desktop into the new server's certificate store. That PowerShell sessions requires elevated privileges: <pre>Get-ChildItem -Path $env:USERPROFILE\Desktop\ -Filter *.pfx | Import-PfxCertificate -Exportable -Password (ConvertTo-SecureString -AsPlainText -Force "not_secure_234") -CertStoreLocation Cert:\LocalMachine\My</pre>
* Remove the <tt>%program files%\MailStore Infrastructure\config</tt> directory on the new server and replace it with the <tt>config</tt> directory from the old one.
* Transfer your instance data directories to the new server. If the instance data on the new server is stored in a different location than on the old one, the ''Base Directory'' of the instances must be adjusted accordingly. Refer to [[Instance_Management#Archive_Stores|Instance Management]] for further details.
* When the host name of the server has changed, also follow the instructions in [[Renaming_Servers#Renaming_the_Server|Renaming the Server]]
* Start the ''Management Server'' service followed by the ''Instance Host'' and ''Client Access Server'' service.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.
* [[Management_Console_-_System_Administrators|Re-enable Multi-Factor Authentication]] for system administrators that had it enabled.

== Multi Server Mode ==
=== Moving the Management Server ===
* The following only applies if MFA has been enabled for some or all system administrators:
*:* Log in at the Management Console and [[Management_Console_-_System_Administrators|disable MFA]] for all administrators that have it enabled. The MFA secret, that is used to generate MFA codes, is stored DPAPI-protected in the management database. When the management database is transferred to a different machine, the secret cannot be decrypted on that machine and manual editing of the database would be required, which should be avoided.
* Start the MailStore Service Provider Edition Configuration tool on the server that has the Management Server role by double-clicking its 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 ''Management Server'' service.
* Transfer your MailStore SPE license through our [https://my.mailstore.com/TransferLicense license portal].
* Install the MailStore Service Provider Edition on the new server and set it up in [[Multi_Server_Mode_Setup|Multi Server Mode]]
* Add the ''Management Server'' role on the new server, but do not start it yet.
* Transfer the file <tt>MailStoreManagementDatabase.json</tt> from the old server's configuration directory to the same location on the new server. By default, this file resides in <tt>%programfiles\MailStore Infrastructure\config%</tt>.
* Start the ''Management Server'' service on the new server.
* Adjust the ''Management Server'' setting in the configuration of each ''Instance Host'' and ''Client Access Server'' by clicking on the corresponding ''Configure...'' button in the MailStore Service Provider Edition Configuration tool.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.
* [[Management_Console_-_System_Administrators|Re-enable Multi-Factor Authentication]] for system administrators that had it enabled.

=== Moving an Instance Host ===
* Start the MailStore Service Provider Edition Configuration tool on a server that is a Instance Host 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 ''Instance Host'' service.
* Install MailStore Service Provider Edition on the new server and set it up in [[Multi_Server_Mode_Setup|Multi Server Mode]].
* Add the ''Instance Host'' role.
* [[Multi_Server_Mode_Setup#Pairing_with_Management_Server|Pair with the Management Server]].
* Start the ''Instance Host'' service.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.
* Follow the [[Moving_Instances|Moving Instances]] guide to move the instances to the new instance host.
* Remove the ''Instance Host'' role from the old server.
* Finally [[Management_Console_-_Infrastructure#Removing_Instance_Hosts|remove the instance host]] that still exist with the old host name.

=== Moving a Client Access Server ===
* Export the certificates, including their private keys, that are visible to the end users on the old client access server. By default these are ''MailStoreClientAccessServerHttp'' and ''MailStoreClientAccessServerImap'', but '''not''' ''MailStoreClientAccessServerTcp''.
* Import these certificates into the new server's personal (MY) certificate store.
* 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'' service.
* Install MailStore Service Provider Edition on the new server and set it up in [[Multi_Server_Mode_Setup|Multi Server Mode]].
* Add the ''Client Access Server'' role.
* [[Multi_Server_Mode_Setup#Pairing_with_Management_Server|Pair with the Management Server]].
* Adjust the certificate settings in the ''Configure Client Access Server Role'' dialog to use the imported certificates.
* Start the ''Client Access Server'' service.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.
* Remove the ''Client Access Server'' role from the old server.
* Finally [[Management_Console_-_Infrastructure#Removing_Client_Access_Servers|remove the client access server]] that still exist with the old host name.

Backup and Restore

2022-11-16T10:03:54Z

Rrommelrath: /* Multi-Factor Authentication enabled */

== Creating Backups ==
The management database as well as your branding data is stored in the ''config'' sub directory right below the program files directory of the MailStore Service Provider Edition (default: <tt>C:\Program Files\MailStore Infrastructure</tt>) on the Management Server. To be able to fully restore a MailStore Service Provider Edition installation, it is highly recommended to create regular backups of that ''config'' directory.

Even more important than the backup of the management database and branding are consistent backups of the MailStore Instances. These instances store their data in at least one directory on the disk, which is the base directory specified during initial creation of the instance. By default, automatically created archive stores are located in sub directories of the base directory, making it sufficient in most cases to only back up the content of the instance's base directory and all sub directories.

When the auto-create settings of archive stores have been modified, additional storage locations must be backed up along with the base directory.

'''Hint:''' The base directory contains a link ''Debug Log'' which points to <tt>%PROGRAMDATA%\MailStore Infrastructure\Debug Log\<instanceID></tt>. It is usually not necessary to follow that link and backup the debug logs if any.

Depending on the environment, backup capacity, backup locations or the backup software in use, different methods might be available for backing up MailStore Instances. The following provides an overview of the most commonly used backup methods and how they cope with the requirement of creating consistent backups.

=== File Based Backups ===
While file based backups solutions are good for backing up independent files, they are usually not suitable for creating consistent backups of MailStore Instances as their data is spread across multiple rapidly changing files.

In order to create consistent backups with file based backup tools, it is required to either freeze and thaw (see [[#Prepare Instance For Snapshot via API Commands]] or shutdown and restart each instance that is to be backed up. As the instances must remain shut down for the time of the backup, this typically results in long downtimes during which the instances are neither able to archive new email nor provide end user access to the archived data.

=== Storage Snapshots ===
When using Volume Shadow Services (VSS) or other methods of creating snapshots on storage level, it is necessary to ensure that all files used by the instances are closed before the snapshot is created. This can either be achieved by enabling VSS support in the instances themselves or by sending the appropriate API command prior to creating snapshots.

==== Enabling and Testing VSS Support ====
Each MailStore Instance provides a so-called Volume Shadow Service Writer (VSS Writer) for external backup software that uses the Microsoft Volume Shadow Service. The external backup software can use it to create consistent backups of the MailStore Instance's database and all archive stores. Whether this method succeeds, however, largely depends on the backup software which is used.

Before MailStore Instances react on VSS events, such support must be enabled in their advanced configuration first. Follow the steps below to enable VSS support for an instance and verify the result.

* [[Management Console - Logging On|Log on]] to the Management Console.
* Click on ''General'' > ''Instances''.
* Select the instance to modify.
* Click on ''Stop'' if the instance is running.
* Click on ''Configure...''.
* Open the ''Advanced Configuration'' tab.
* Check the ''Enable VSS Writer'' option.
* Click ''OK'' to save the changes.

Now start your VSS based backup and wait until it has finished. To verify that the appropriate VSS events were initiated in MailStore during the backup, open the Windows System Protocol in the event viewer on the Instance Host where the instance was previously backed up and search for the following events:

# ''A backup session has been started.''
# ''The archive has been frozen as a reaction on the OnPrepareSnapshot event.''
# ''The archive has been thawn as a reaction on the OnThaw event. ''
# ''The backup session has been shut down.''

If these events cannot be found in the Windows System Protocol, no consistent snapshot using Volume Shadow Service was performed and your backup software obviously does not support the MailStore VSS writer. In that case try the API based method below.

==== Prepare Instance For Snapshot via API Commands ====
MailStore Instances can be frozen and thawed similar to using VSS by executing the corresponding API commands [[Management_API_-_Function_Reference#FreezeInstances|FreezeInstances]] and [[Management_API_-_Function_Reference#ThawInstances|ThawInstances]]. Instances also can be stopped and started by executing the API commands [[Management_API_-_Function_Reference#StopInstances|StopInstances]] and [[Management_API_-_Function_Reference#StartInstances|StartInstances]]. The easiest way of executing API commands from other applications such as backup software is by using [[Management_API_-_Command_Line_Client|MailStoreManagementCmd.exe]].

To learn how to execute commands before and after performing snapshots, please consult your backup software's documentation.

=== Full Virtual Machine Backups ===
Some backup solutions are highly integrated into virtualization solutions and allow to create and backup/replicate full snapshots of virtual machines. These type of snapshots not only contain the current state of the hard disks but also of the current main memory. Thus backups of full virtual machine snapshots can be considered as consistent.

=== Other Backup or Replication Methods ===
For questions regarding any other type of backup solutions such as block level replication, continuous backup, etc. please contact the vendor's support to find out whether their software is able to create consistent backups of whole directory structures.

== Restoring Backups ==

=== Restoring Management Database and Branding ===
To restore the management database and branding data make sure that none of the MailStore Service Provider Edition roles (Management Server, Instance Host and Client Access Server) are running. Then restore the content of the ''config'' directory back into its original location (default: <tt>C:\Program Files\MailStore Infrastructure</tt>) and finally start the Management Server role again followed by the Instance Hosts and Client Access Server role.

==== Multi-Factor Authentication enabled ====

In case the management database has been restored to a different machine from where it originates from and Multi-Factor Authentication has been enabled for some system administrators, you have to perform some manual adjustments to the management database.

* Stop the Management Server role.
* Open the folder where the management database configuration file resides, by default this is ''C:\Program Files\MailStore Infrastructure\config\''
* Create a backup of the database file MailStoreManagementDatabase.json.
* Open the management database configuration file MailStoreManagementDatabase.json with a text editor, such as notepad.
* The database is a structured JSON file, find the ''systemAdministrators'' section.
* For every administrator in that section, change the value of the ''mfaStatus'' property to ''disabled''. When the ''mfaStatus'' property is not present, do not change the section of that system adminstrator at all. Do not change anything else.
* Save the file.
* Start the Management Server role.
* [[Management_Console_-_System_Administrators|Re-enable MFA]] for all administrators that had it enabled.
* The system administrators have to finalize the MFA configuration.

=== Restoring Instances ===
As long as the instance configuration still exists in the management database on the Management Server, the restored data should be placed in the previous location which usually means in the base directory of the instance. Afterwards the instance can be started from the Management Console again.

If the instance configuration has been deleted from the management database, proceed as follows to restore an instance:

# Create a new instance as described in [[Creating Instances]]. Its name does not necessarily need to match the previous name.
# Open Windows Explorer and navigate to the base directory of the newly created instance.
# Delete all files and directories from the base directory.
# Now restore the data into the base directory of the newly created instance.
# Finally start the instance.

Moving Roles

2022-11-16T09:58:03Z

Rrommelrath:

== Single Server Mode ==
In order to retain a single server mode setup by keeping the Management Server, Instance Host and Client Access Server on a single server, follow the instructions below. If only one of the roles in a single server mode setup should to be moved to another server, refer to corresponding section under [[Moving Roles#Multi_Server_Mode|Multi Server Mode]] in this article.

* Start the MailStore Service Provider Edition Configuration tool on a server that is a Management 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'', ''Instance Host'', and ''Management Server'' services.
* Transfer your MailStore SPE license to the new server through our [https://my.mailstore.com/TransferLicense license portal].
* Install MailStore Service Provider Edition on the new server and set it up [[Single_Server_Mode_Setup|Single Server Mode]].
* Stop the ''Client Access Server'', ''Instance Host'', and ''Management Server'' services on the new server.
* Remove all MailStore SPE related certificates from the server's personal (MY) certificate store of the new server.
*: [[File:Spe-certificate-store.png|center]]
* Export the SSL certificates and private keys from the old server's certificate store and import them into the same location on the new server.
** On Windows Server 2012 R2 you can use the following PowerShell command to export all certificats stored in the computers ''MY'' store as PFX containers to the current user's desktop. That PowerShell session requires elevated privileges: <pre>(Get-ChildItem Cert:\LocalMachine\My).Thumbprint | ForEach-Object { Export-PfxCertificate -Cert ("Cert:\LocalMachine\My\{0}" -f $_) -FilePath ("$env:USERPROFILE\Desktop\{0}.pfx" -f $_) -Password (ConvertTo-SecureString -AsPlainText -Force "not_secure_234") }</pre>
** Windows Server 2012 R2 Powershell command to import the previously exported certificates from the current user's desktop into the new server's certificate store. That PowerShell sessions requires elevated privileges: <pre>Get-ChildItem -Path $env:USERPROFILE\Desktop\ -Filter *.pfx | Import-PfxCertificate -Exportable -Password (ConvertTo-SecureString -AsPlainText -Force "not_secure_234") -CertStoreLocation Cert:\LocalMachine\My</pre>
* Remove the <tt>%program files%\MailStore Infrastructure\config</tt> directory on the new server and replace it with the <tt>config</tt> directory from the old one.
* Transfer your instance data directories to the new server. If the instance data on the new server is stored in a different location than on the old one, the ''Base Directory'' of the instances must be adjusted accordingly. Refer to [[Instance_Management#Archive_Stores|Instance Management]] for further details.
* When the host name of the server has changed, also follow the instructions in [[Renaming_Servers#Renaming_the_Server|Renaming the Server]]
* Start the ''Management Server'' service followed by the ''Instance Host'' and ''Client Access Server'' service.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.

== Multi Server Mode ==
=== Moving the Management Server ===
* The following only applies if MFA has been enabled for some or all system administrators:
*:* Log in at the Management Console and [[Management_Console_-_System_Administrators|disable MFA]] for all administrators that have it enabled. The MFA secret, that is used to generate MFA codes, is stored DPAPI-protected in the management database. When the management database is transferred to a different machine, the secret cannot be decrypted on that machine and manual editing of the database would be required, which should be avoided.
* Start the MailStore Service Provider Edition Configuration tool on the server that has the Management Server role by double-clicking its 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 ''Management Server'' service.
* Transfer your MailStore SPE license through our [https://my.mailstore.com/TransferLicense license portal].
* Install the MailStore Service Provider Edition on the new server and set it up in [[Multi_Server_Mode_Setup|Multi Server Mode]]
* Add the ''Management Server'' role on the new server, but do not start it yet.
* Transfer the file <tt>MailStoreManagementDatabase.json</tt> from the old server's configuration directory to the same location on the new server. By default, this file resides in <tt>%programfiles\MailStore Infrastructure\config%</tt>.
* Start the ''Management Server'' service on the new server.
* Adjust the ''Management Server'' setting in the configuration of each ''Instance Host'' and ''Client Access Server'' by clicking on the corresponding ''Configure...'' button in the MailStore Service Provider Edition Configuration tool.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.
* [[Management_Console_-_System_Administrators|Re-enable Multi-Factor Authentication]] for system administrators that had it enabled.
* System administrator credentials of administrators, that have MFA enabled, that have been used in scripts, that connect to the Management API, need to [[Management_Console_-_Your_MFA_Settings|re-create API passwords]] and the new API passwords have to be used in these scripts.

=== Moving an Instance Host ===
* Start the MailStore Service Provider Edition Configuration tool on a server that is a Instance Host 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 ''Instance Host'' service.
* Install MailStore Service Provider Edition on the new server and set it up in [[Multi_Server_Mode_Setup|Multi Server Mode]].
* Add the ''Instance Host'' role.
* [[Multi_Server_Mode_Setup#Pairing_with_Management_Server|Pair with the Management Server]].
* Start the ''Instance Host'' service.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.
* Follow the [[Moving_Instances|Moving Instances]] guide to move the instances to the new instance host.
* Remove the ''Instance Host'' role from the old server.
* Finally [[Management_Console_-_Infrastructure#Removing_Instance_Hosts|remove the instance host]] that still exist with the old host name.

=== Moving a Client Access Server ===
* Export the certificates, including their private keys, that are visible to the end users on the old client access server. By default these are ''MailStoreClientAccessServerHttp'' and ''MailStoreClientAccessServerImap'', but '''not''' ''MailStoreClientAccessServerTcp''.
* Import these certificates into the new server's personal (MY) certificate store.
* 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'' service.
* Install MailStore Service Provider Edition on the new server and set it up in [[Multi_Server_Mode_Setup|Multi Server Mode]].
* Add the ''Client Access Server'' role.
* [[Multi_Server_Mode_Setup#Pairing_with_Management_Server|Pair with the Management Server]].
* Adjust the certificate settings in the ''Configure Client Access Server Role'' dialog to use the imported certificates.
* Start the ''Client Access Server'' service.
* [[Management Console - Logging On|Log on]] to the Management Console and check the dashboard for the connection status of servers and roles.
* Remove the ''Client Access Server'' role from the old server.
* Finally [[Management_Console_-_Infrastructure#Removing_Client_Access_Servers|remove the client access server]] that still exist with the old host name.

Management Console - Your MFA Settings

2022-11-16T09:44:19Z

Rrommelrath:

__NOTOC__

== Your MFA Settings ==
System administrators are able to manage Multi-Factor Authentication settings for their account on the ''Your MFA Settings'' page.

[[File:Msce_mfa_settings_01.png|center]]

To manage MFA for other accounts, see the [[Management_Console_-_System_Administrators|System Administrators]] documentation page.

=== General ===

==== MFA Enabled ====

The checkbox indicates whether Multi-Factor Authentication has been enabled or disabled for your own account.

==== Enable MFA ====
When MFA is disabled, the ''Enable MFA'' button enables MFA. 
A shared secret is generated and the MFA status of your account is set to ''Pending''. The MFA process needs to be finalized on the next login at the management console. 
* Logout of the Management Console using the ''Logout'' button in the upper right corner.
* Enter your username and password, click ''OK''.
[[File:Msce_console_login.png|center]]
* Scan the QR code with a TOTP compatible authenticator app on your mobile phone (or alternatively enter the token shown below the QR code manually).
[[File:Msce_console_login_mfa_pending.png|center]]
* Enter the MFA code that is shown on your mobile phone's screen in the ''Code'' field.
* Click ''OK''.

==== Active MFA ====
Once the process has been finalized, you only have to enter the code after you have entered username and password during the login process.
[[File:Msce_console_login_mfa_active.png|center]]

==== Disable MFA ====

When MFA is enabled, the ''Disable MFA'' button disables MFA. You do not have to enter MFA codes when logging in in at the Management Console.

==== Reset Secret ====

The ''Reset Secret'' button generates a new TOTP secret and sets the MFA status of your account to ''Pending''. 
You have to go through the finalization process again on the next login at the Management Console. The previously scanned QR code (and therefore the secret) is invalid, and MFA codes generated with it cannot be used to log in. 
The button is only enabled when the MFA process of your account has been finalized and the MFA status is ''active''.

=== API Password===

When MFA has been enabled for your account, you cannot use your regular password to use the Management API. You have to generate an API password that has to be used to connect to the Management API port. One API password per user account is supported.

==== Generate New API Password ====

Click the ''Generate New API Password'' button to create a new API password. The password is shown and can be copied. The API password cannot be shown again.

[[File:Msce_mfa_settings_api_password_01.png|center]]

'''Important notice:''' When your username contains a colon (:) you may not be able to connect to the Management API. The Management API uses HTTP Basic Authentication which sends the username and password, separated by a colon, as a Base64 encoded HTTP header. When the username contains a colon, the password cannot be separated correctly from the whole string.

Management Console - System Administrators

2022-11-16T09:38:19Z

Rrommelrath:

__NOTOC__

== System Administrators ==
System administrators have the ability to log on to the Management Console and therefore have full administrative privileges.

=== Listing System Administrators ===

To list system administrators, follow these steps:

* [[Management Console - Logging On|Log on]] to the Management Console.
* Click on ''Security'' > ''System Administrators''.
* The list of system administrators is shown.
*: [[File:Msce_sysadmin_overview_01.png|center]]

=== Creating System Administrators ===
To create a new system administrator, follow these steps:

* [[Management Console - Logging On|Log on]] to the Management Console.
* Click on ''Security'' > ''System Administrators''.
* Click ''Create System Administrator''.
* Fill out the ''System Administrator Configuration'' form:
*: [[File:Msce_sysadmin_add_01.png|center]]
:* '''User Name:''' User name of the system administrator used for logging on to the Management Console.
:* '''Full Name:''' Full name of the system administrator.
:* '''E-mail Address:''' E-mail address of the system administrator.
:* '''Password:''' Password of the system administrator.
:* '''Repeat Password''' Password confirmation.
:* '''Enable MFA''' Enables Multi-Factor Authentication (MFA) for the system administrator. More about MFA can be found on the [[Management_Console_-_Your_MFA_Settings|Your MFA Settings]] documentation page.
* Click ''OK'' to create the new system administrator.

=== Configuring System Administrators ===
To modify an existing system administrator, follow these steps:

* [[Management Console - Logging On|Log on]] to the Management Console.
* Click on ''Security'' > ''System Administrators''.
* Select the system administrator to modify.
* Click on ''Commands'' and select ''Configure...''.
* Fill out the ''System Administrator Configuration'' form, the username cannot be modified:
*: [[File:Msce_sysadmin_configure_01.png|center]]
:* '''Full Name:''' Full name of the system administrator.
:* '''E-mail Address:''' E-mail address of the system administrator.
:* '''Password:''' Password of the system administrator. If the password fields are not filled out, the existing password remains valid.
:* '''Repeat Password''' Password confirmation.
:* '''Enable MFA''' Enables or disables Multi-Factor Authentication (MFA) for the system administrator. More about MFA can be found on the [[Management_Console_-_Your_MFA_Settings|Your MFA Settings]] documentation page.
:* '''Reset MFA Secret''' Resets the MFA secret of the system administrator. The system administrator has to finalize the MFA process again on the next login. This button is only enabled when the MFA process of that system administrator has already been finalized.
: [[File:Msce_sysadmin_configure_02.png|center]]
* Click ''OK'' to save changes or ''Cancel'' to discard.

=== Deleting System Administrators ===
To delete an existing system administrator, proceed as follows:

* [[Management Console - Logging On|Log on]] to the Management Console.
* Click on ''Security'' > ''System Administrators''.
* Select the system administrator to delete.
* Click on ''Commands'' > ''Delete''.
* Click ''OK'' to confirm the deletion of the system administrator, or ''Cancel'' to abort.

Main Page

2022-11-15T09:49:46Z

Rrommelrath: /* Related Articles */

__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]]
* Security
** [[Management_Console_-_System_Administrators|System Administrators]]
** [[Management_Console_-_Your_MFA_Settings|Your MFA Settings]]
* [[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]]
* [https://www.mailstore.com/en/mailstore-cloud-changelog.aspx Changelog]
* [[MailStore Server to MailStore SPE Migration]]
* [https://help.mailstore.com/en/server/Changing_Archiving_from_Microsoft_Exchange_Server_to_Microsoft_365 Changing Archiving from Microsoft Exchange Server to Microsoft 365]
* [[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 ==
* [http://help.mailstore.com/manual/spe13-manual-en.pdf MailStore SPE 13 Manual]
'''Active Directory Group Policy Templates'''
* [[Media:MailStore_ADMX.zip|ADMX-Template]]
|}

Management API - Function Reference

2022-08-22T14:55:25Z

Rrommelrath: /* Arguments */

__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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
| <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,
"imapServerConnectionLogEnabled" : bool,
"vssWriterEnabled" : bool,
"vssWriterExcludeIndexes" : bool,
}
</source>

=== Config Arguments ===

{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Possible characters are a-z, 0-9 and a dash (-). Only lower-case letters are allowed. The first character has to be a letter. The minimum length is 3 characters, the maximum length is 32 characters.
|-
| <tt>startMode</tt>
| string
| Possible values are ''automatic'', ''manual'', and ''disabled''. ''Automatic'' instances are started automatically with the Instance Host. ''Manual'' instances must be started manually. ''Disabled'' instances cannot be started at all.
|}

== 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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
| <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.
|-
| <tt>includeSize</tt>
| bool (optional)
| Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.
|}

== 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">
{
"sizeThreshold" : string or null,
"baseDirectory" : string,
"contentBaseDirectory" : string,
"indexBaseDirectory" : 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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
|}

== 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.
|}

== SetProfileServerSideExecution ==
Disables or enables the automatic server-sided execution with its parameters.

=== Arguments ===
{| class="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 profile ID of the profile to be modified.
|-
| <tt>automatic</tt>
| boolean true/false
| enables (true) or disables (false) the named profile's server-side automation
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value of seconds to pause between re-executing an automatic profile
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm) for the time window where the execution should not be executed to e.g. schedule maintenance tasks instead.
|}

Use the API command [[Management_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current "serverSideExecution" section details.

The command can be executed with either the argument automatic=false and no additional parameters to disable the automation, or with automatic=true and at least the automaticPauseBetweenExecutions value given. The automaticMaintenanceWindows parameter is optional to define a maintenance window. If not given, there will be no such window.
Setting an already automated profile to automatic again, will restart the profile.

=== Argument Values ===

==== automatic ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>true</tt>
| Enables the automation for the given profile.
|-
| <tt>false</tt>
| Disables the automation for the given profile.
|}

==== automaticPauseBetweenExecutions ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>0 - 2147483647</tt>
| seconds to pause before re-executing the profile automatically, argument is not allowed when setting automatic to false, required when setting automatic to true.
|}

==== automaticMaintenanceWindows ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>(parameter not given)</tt>
| There will be no maintenance windows, so the automated profile will continue its run/pause cycle over the complete 24 hrs of the day.
|-
| <tt>00:00-23:99</tt>
| There will be a maintenance window from/to the given time in hh:mm, where the profile automation will be paused.
|}

== 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",
"recipientEmailAddresses": ["administrator@example.com", "user@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

2022-08-22T14:54:59Z

Rrommelrath: /* SetProfileServerSideExecution */

__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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
| <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,
"imapServerConnectionLogEnabled" : bool,
"vssWriterEnabled" : bool,
"vssWriterExcludeIndexes" : bool,
}
</source>

=== Config Arguments ===

{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Possible characters are a-z, 0-9 and a dash (-). Only lower-case letters are allowed. The first character has to be a letter. The minimum length is 3 characters, the maximum length is 32 characters.
|-
| <tt>startMode</tt>
| string
| Possible values are ''automatic'', ''manual'', and ''disabled''. ''Automatic'' instances are started automatically with the Instance Host. ''Manual'' instances must be started manually. ''Disabled'' instances cannot be started at all.
|}

== 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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
| <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.
|-
| <tt>includeSize</tt>
| bool (optional)
| Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.
|}

== 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">
{
"sizeThreshold" : string or null,
"baseDirectory" : string,
"contentBaseDirectory" : string,
"indexBaseDirectory" : 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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
|}

== 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.
|}

== SetProfileServerSideExecution ==
Disables or enables the automatic server-sided execution with its parameters.

=== Arguments ===
{| class="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 profile ID of the profile to be modified.
|-
| <tt>automatic</tt>
| boolean true/false
| enables (true) or disables (false) the named profile's server-side automation
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value of seconds to pause between re-executing an automatic profile
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm) for the time window where the execution should not be executed to e.g. schedule maintenance tasks instead.
|}

Use the API command [[Management_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current "serverSideExecution" section details.

The command can be executed with either the argument automatic=false and no additional parameters to disable the automation, or with automatic=true and at least the automaticPauseBetweenExecutions value given. The automaticMaintenanceWindows parameter is optional to define a maintenance window. If not given, there will be no such window.
Setting an already automated profile to automatic again, will restart the profile.

=== Argument Values ===

==== automatic ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>true</tt>
| Enables the automation for the given profile.
|-
| <tt>false</tt>
| Disables the automation for the given profile.
|}

==== automaticPauseBetweenExecutions ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>0 - 2147483647</tt>
| seconds to pause before re-executing the profile automatically, argument is not allowed when setting automatic to false, required when setting automatic to true.
|}

==== automaticMaintenanceWindows ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>(parameter not given)</tt>
| There will be no maintenance windows, so the automated profile will continue its run/pause cycle over the complete 24 hrs of the day.
|-
| <tt>00:00-23:99</tt>
| There will be a maintenance window from/to the given time in hh:mm, where the profile automation will be paused.
|}

== 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",
"recipientEmailAddresses": ["administrator@example.com", "user@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

2022-08-22T13:12:01Z

Rrommelrath: Added SetProfileServerSideExecution command

__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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
| <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,
"imapServerConnectionLogEnabled" : bool,
"vssWriterEnabled" : bool,
"vssWriterExcludeIndexes" : bool,
}
</source>

=== Config Arguments ===

{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Possible characters are a-z, 0-9 and a dash (-). Only lower-case letters are allowed. The first character has to be a letter. The minimum length is 3 characters, the maximum length is 32 characters.
|-
| <tt>startMode</tt>
| string
| Possible values are ''automatic'', ''manual'', and ''disabled''. ''Automatic'' instances are started automatically with the Instance Host. ''Manual'' instances must be started manually. ''Disabled'' instances cannot be started at all.
|}

== 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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
| <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.
|-
| <tt>includeSize</tt>
| bool (optional)
| Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.
|}

== 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">
{
"sizeThreshold" : string or null,
"baseDirectory" : string,
"contentBaseDirectory" : string,
"indexBaseDirectory" : 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>databasePath</tt>
| string
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
|-
| <tt>contentPath</tt>
| string (optional)
| Path of directory containing archive store content.
|-
| <tt>indexPath</tt>
| string (optional)
| Path of directory containing archive store index files.
|-
|}

== 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.
|}

== SetProfileServerSideExecution ==
Disables or enables the automatic server-sided execution with its parameters.

=== Arguments ===
{| class="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 profile ID of the profile to be modified.
|-
| <tt>automatic</tt>
| boolean true/false
| enables (true) or disables (false) the named profile's server-side automation
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value of seconds to pause between re-executing an automatic profile
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm) for the time window where the execution should not be executed to e.g. schedule maintenance tasks instead.
|}

Use the API command [[Administration_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current "serverSideExecution" section details.

The command can be executed with either the argument automatic=false and no additional parameters to disable the automation, or with automatic=true and at least the automaticPauseBetweenExecutions value given. The automaticMaintenanceWindows parameter is optional to define a maintenance window. If not given, there will be no such window.
=== Argument Values ===

==== automatic ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>true</tt>
| Enables the automation for the given profile.
|-
| <tt>false</tt>
| Disables the automation for the given profile.
|}

==== automaticPauseBetweenExecutions ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>0 - 2147483647</tt>
| seconds to pause before re-executing the profile automatically, argument is not allowed when setting automatic to false, required when setting automatic to true.
|}

==== automaticMaintenanceWindows ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>(parameter not given)</tt>
| There will be no maintenance windows, so the automated profile will continue its run/pause cycle over the complete 24 hrs of the day.
|-
| <tt>00:00-23:99</tt>
| There will be a maintenance window from/to the given time in hh:mm, where the profile automation will be paused.
|}

== 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",
"recipientEmailAddresses": ["administrator@example.com", "user@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.
|}