Update Notices

2026-01-12T15:05:45Z

Ltalaschus: /* Upgrading to 25.4.0 */

== General Information ==
* '''Before the installation, read the [https://go.mailstore.com?product=mailstore%20service%20provider%20edition&target=changelog&lang=en changelog] for information about all changes in the respective versions.'''
* The installation process upgrades the software automatically by uninstalling any previous version first. Administrators will be asked during setup to confirm the uninstallation. The new version must be installed in the same directory as the old version.
* Installations with version 23.4 or older must first be updated to version 24.4 and all archive stores must be updated to Firebird 4. You can then update to the latest version. Please also read the [[Update Notices for MailStore SPE to version 25.1 or newer]].
* During the installation process services are automatically stopped and restarted afterwards. Running archiving profiles will be canceled and may show up as failed. Active user sessions will be terminated. Should stopping the service fail for any reason, please stop the service manually and run the installation again.
* In a multi server environment, upgrade the components in the following order: Management Server, Instance Host, Client Access Server
* After each update, check the files in the sample branding folder to identify if new settings or template variables have been introduced.
* Updating the E-Mail Archive Client installations and/or the E-Mail Archive Outlook Add-In installations is only necessary if this is specifically stated in the version-specific notes.
* The following version specific upgrade notices are cumulative. Therefore, also read the notices regarding all version numbers between yours and the one you are going to install.
* For versions that are not explicitly listed here, the upgrade notices for preceding versions apply accordingly.

== Upgrading to 26.1.0 ==

* New Microsoft 365 mailbox archiving profiles now use the Graph API. Please ensure you have registered the app in Entra ID according to our instructions; in particular, the Mail.ReadWrite permission is now required.

== Upgrading to 25.4.0 ==
* MailStore Cloud Export profile will be supported in the coming weeks.

== Upgrading to 25.3.1 ==
The known issue of version 25.3.0 has been fixed.

== Upgrading to 25.3.0 ==
* ''' Microsoft Windows Live Mail '''
*; Support for the Microsoft Windows Live Mail email client has been removed from MailStore in this version.
* ''' SmarterMail '''
*; Support for the SmarterMail email server has been removed from MailStore in this version.
* ''' Directory Service Synchronization '''
*; After updating, check directory service settings for functionality. Support for older authentication methods has been removed from MailStore in this version (Microsoft 365 Basic authentication and Google Workspace IMAP authentication), and third-party components have been updated.
* ''' SMTP OAuth2 Authentication with Microsoft 365 '''
*; Please note the [https://help.mailstore.com/en/server/SMTP_Settings SMTP Settings] article if you would like to use your existing app registration in Entra ID to transmit emails via Microsoft 365 server.
* ''' Gateway archiving '''
*; Gateway archiving profiles that are meant for Google, generic mail servers and email clients do not extract journal reports and NDRs anymore. When archiving Microsoft 365 journal emails from a MailStore Gateway mailbox ensure you are using the proper Gateway archiving profile before updating. You can tell this because you cannot configure the target path in the archive in the archiving profile and the emails are sorted into the ''Journal Incoming'' and ''Journal Outgoing'' folders.

=== Known Issues ===
* In WebAccess, emails that contain only plain text are not displayed correctly. This bug was fixed with version 25.3.1.

== Upgrading to 25.2.0 ==

There are no notes for this version.

== Upgrading to 25.1.0 ==
* '''Only installations with versions 24.2.0 to 24.4.0 can be updated directly.'''
* '''Until all archive stores have been updated, you must not update to version 25.1.0.'''
* It is '''obligatory''' to also note the [[Update Notices for MailStore SPE to version 25.1 or newer]].

== Upgrading to 24.4.0 ==

* In order to enable the Manifest generation for the Outlook App, the [[Branding |branding]] needs to be adjusted.

== Upgrading to 24.3.0 ==
* Saved searches containing search criteria that can be interpreted as [https://help.mailstore.com/en/server/Accessing_the_Archive_with_the_MailStore_Client_software#Searching_for_Alternatives search for alternatives] will return different search results than before the update.
* Retention policies do not support [https://help.mailstore.com/en/server/Accessing_the_Archive_with_the_MailStore_Client_software#Searching_for_Alternatives searches for alternatives]. In case existing retention policies contain search criteria that can be interpreted as searches for alternatives, those have to be changed for retention policies to being able to be processed, again.

== Upgrading to 24.2.2 ==

There are no notes for this version.

== Upgrading to 24.2.1 ==
If you are upgrading from a MailStore version before 24.2.0, please also note the instructions for upgrading to version 24.2.0.

* '''Upgrading Archive Stores''' If you upgrade from MailStore 24.2.0, the archive stores need to be upgraded. To do this, proceed as follows:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Click the ''Upgrade All Stores'' button to upgrade all archive stores of that instance.
** Click on ''OK'' to start the upgrade process or click on ''Cancel''.
*;
: Until all archive stores have been upgraded, retention policies are not available.

== Upgrading to 24.2.0 ==

* '''Upgrade of Master Database''' The master database is upgraded to Firebird 4 during the first start of an instance. This process might extend the time required for the first start of the instance by several minutes.
* '''Upgrading Archive Stores''' For the update to Firebird 4 the databases of the archive stores must be upgraded. Proceed as follows to upgrade:
** Log in to the Management Console.
** Click on ''Instances''
** Select the instance to upgrade
** Open the ''Storage'' tab
** Click the ''Upgrade All Stores'' button to upgrade all archive stores of that instance.
** Click on ''OK'' to start the upgrade process or click on ''Cancel''.
*;
: Until all archive stores have been upgraded, retention policies are not available.
* ''' Python API Wrapper '''
*; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.

=== Known Issues ===
* As long as an internal, Firebird-based archive store has not been updated, no recovery records will be written for emails in this archive store. This bug was fixed with version 24.2.1.

== Upgrading to 23.4.0 ==
* '''System Requirements''' Windows Server 2012 and Windows Server 2012 R2 support has been removed from MailStore in this version. For a current list of supported operating systems, please refer to [[System Requirements]].
* ''' Python API Wrapper '''
*; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.

== Upgrading to 23.3.0 ==
* ''' Microsoft Exchange 2013 Support '''
*; Support for Microsoft Exchange 2013 has been removed from MailStore in this version.

== Upgrading to 23.2.0 ==
* ''' Outlook Add-in '''
*; Starting with version 23.2.0, MailStore SPE instances support multi-factor authentication for users with integrated authentication. To support multi-factor authentication an update of the Outlook Add-in is required.
*; The Outlook Add-In 23.2.0 is not backward compatible with older MailStore SPE versions. When updating, MailStore SPE should be updated first and then the Outlook Add-in.
* ''' Scheduled Tasks, Management API, IMAP Access ''' 
*; When multi-factor authentication is enabled for a user and that user wants to schedule client-side archiving profiles, access the Management API or access the IMAP server, an app password has to be used instead of the regular password.
* ''' Python API Wrapper '''
*; In order to be able to use the new API commands, an update of the [[Python_API_Wrapper_Tutorial|Python API wrapper library]] is required.

=== Known Issues ===
* When using the E-mail Archive client to connect to an SPE instance, the given username must not contain any upper case letters otherwise an error message will appear. This issue has been resolved in version 23.3.0.

== Upgrading to 23.1.0 ==
* '''System Requirements''' Windows Server 2008 R2 support has been removed from MailStore in this version. For a current list of supported operating systems, please refer to [[System Requirements]].

== Upgrading to 22.4.0 ==
* ''' Management API ''' Administrators have to use an API password to use the Management API when MFA is enabled for them. That API password can be generated in the Management Console.

== Upgrading to 22.3.0 ==
* ''' Outlook Add-in '''
*; Starting with version 22.3.0, failed login attempts will slow down the login process. While this process is backwards compatible to older Outlook Add-ins, we strongly recommend updating the Outlook Add-in for the best user experience.

== Upgrading to 22.2.x ==
* '''System Requirements'''
*; Starting with version 22.2 MailStore Service Provider Edition and its components require Microsoft .NET Framework version 4.8. Please refer to our [[System Requirements]]. If the framework is installed by the MailStore setup, the system might reboot without further notice.

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

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

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

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

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

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

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

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

Instance Management

2025-12-04T12:42:58Z

Ltalaschus: /* Rebuild Broken Indexes */

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:
'''Important notice: '''Since version 25.1 only archive stores with Firebird 4 databases are supported. Attaching older archive stores is not possible and will fail. The source installation must have been on version 24.2 or newer and the archive stores must also have been upgraded within that installation.

* [[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.

* In case the error ''Unable to open the archive store <name>. Unsupported Firebird Database file detected.'' appears, the archive store must be upgraded to Firebird 4 first, then it can be attached. [[File:Ms_spe_attach_unsupported_old_firebird.png|center]]Read [[Update_Notices_for_MailStore_SPE_to_version_25.1_or_newer#Updating_individual_instances_and_archive_stores|Updating individual instances and archive stores]] on how to upgrade archive stores.

=== Unlock Archive Stores ===
In case the archive store was migrated from MailStore Server 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.

=== Upgrade All Stores ===

When MailStore introduces a new archive store format, the archive stores must be upgraded manually. Create a [[Backup_and_Restore|backup]] and 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 ''Upgrade All Stores'' to start the upgrade process.
* A progress windows will appear.
* Wait until the process is completed successfully and click ''OK''.

=== 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
| When the archive store format is updated due to a necessary change or when 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. This process may take hours and should be performed in a maintenance/change window. A [[Backup_and_Restore|backup]] must be made, before this upgrade is performed.
|-
| 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.

'''Important note: '''When rebuilding search indexes, we highly recommend that you start the instance in [[Controlling Instances|Safe Mode]]. This ensures that other processes such as archiving, export operations, jobs, or user actions do not interfere with the reindexing process.Alternatively, instead of ''Safe Mode,'' all archiving profiles and jobs can be paused so that the archives are not modified during the rebuild, but users can still access their archives.

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

We recommend to start the MailStore SPE Instance in [[Controlling_Instances|Safe Mode]] to avoid interference by background tasks such as archiving profiles, exporting profiles, jobs or user interaction.

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

Management API - Function Reference

2025-12-03T12:19:51Z

Ltalaschus: /* instanceFilter */

__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>

== CreateSystemAdministratorAPIPassword==
Creates and returns the API passsword of the user that executes this API command.
Every SPE administrator has their own API password. Any previously created API password for this administrator is overwritten and therefore invalidated.

== DeactivateSystemAdministratorMFA ==
Deactivates Multi-Factor Authentication for SPE system administrator.

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

== 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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.
The list contains the name, the full name, the email address and the Multi-Factor Authentication status.

== InitializeSystemAdministratorMFA ==
Initializes Multi-Factor Authentication for SPE system administrator.
The administrator has to finalize the setup of MFA on the next login at the Management Console.

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

== 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. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

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

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

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

== TransferStores ==
Copy the content of one or more archive store into another 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>sourceStores</tt>
| string
| Comma-separated list of one or more source archive stores.
|-
| <tt>targetStore</tt>
| number (optional)
| The target store of the messages to be copied. If not given, the archive store in the "current" state will be used.
|-
| <tt>startIndex</tt>
| string (optional)
| A string in the format "archiveStoreId:messageId". The transfer process starts with the this message.
|}

== 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade an archive store from an older version to the 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.
|}

== UpgradeStores ==
Upgrade all archive stores from an older version to the 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.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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 [[#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] 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.
|-
| <tt>loginPrivileges</tt>
| string (optional)
| Comma separated list of log in privileges. If not given, all login privileges are assigned.
|}

=== Argument Values ===

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

==== loginPrivileges ====
{{Template:Management_API_User_Login_Privileges}}

== DeleteAppPasswords ==
Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the 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
| The user name of the user whose app passwords shall be deleted.
|}

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

== DisableMFA ==
Disables multi-factor authentication of a 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
| The user name of the user for whom MFA shall be disabled.
|}

[[Management_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a 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.
|}

== CreateCredential ==
Create a new credential object that can be used by directory configuration settings or profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>type</tt>
| string
| Credential type. Supported values are: 
* <tt>Office365_Modern</tt> – credential for authenticating against Entra ID (Office 365 modern authentication). 
* <tt>SignedEnvelope</tt> – credential used for an export to MailStore Cloud.
|-
| <tt>description</tt>
| string
| Human readable description of the credential.
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== DeleteCredential ==
Delete an existing credential object.

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

== GetCredential ==
Get details of a single credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential whose details should be returned.
|}

== GetCredentials ==
Get the list of all credential objects and their details.

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

== SetCredentialDescription ==
Set the description of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>description</tt>
| string
| New human readable description of the credential.
|}

== SetCredentialSettings ==
Change configuration settings of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>createNewCertificate</tt>
| bool (optional)
| Indicates whether a new certificate should be created for this credential (<tt>true</tt>) or the existing certificate settings should be kept (<tt>false</tt>).
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== 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="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneId="$Local" --jobId=1''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|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 the list of available time zones and their IDs.

The ''id'' of the output can be used as ''timeZoneId'' in [[Management_API_-_Function_Reference#CreateJob|CreateJob]], [[Management_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Management_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Management_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

=== Arguments ===
{| 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)
| If given, must be equal to the current username. Filters results by current user.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2022-01-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== GetWorkerResultReport ==
Get the details of a profile execution result.

=== Arguments ===
{| class="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 ID of the result for which the details should be fetched.
|}

Use the [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.

== InitializeMFA ==
Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.
When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a 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
| The user name of the user for whom MFA shall be initialized.
|}

[[Management_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.

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

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

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. Setting an already automated profile to automatic again, will restart the profile.

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

== SetUserLoginPrivileges ==
Set login privileges 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>loginPrivileges</tt>
| string
| Comma separated list of login privileges.
|}

=== Argument Values ===

==== loginPrivileges ====
{{Management_API_User_Login_Privileges}}

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

== SetUserPrivilegesOnAllFolders ==
Set privileges on all folder for MailStore user, except for the folders that are excluded

=== Arguments ===
{| class="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 folder privileges.
|-
| <tt>excludeFolders</tt>
| string (optional)
| Comma separated list of folders to exclude.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>read</tt>
| The user is granted read access to the specified folders.
|-
| <tt>write</tt>
| The user is granted write access to the specified folders. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folders.
|}

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

2025-12-03T12:19:22Z

Ltalaschus: /* instanceFilter */

__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>

== CreateSystemAdministratorAPIPassword==
Creates and returns the API passsword of the user that executes this API command.
Every SPE administrator has their own API password. Any previously created API password for this administrator is overwritten and therefore invalidated.

== DeactivateSystemAdministratorMFA ==
Deactivates Multi-Factor Authentication for SPE system administrator.

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

== 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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.
The list contains the name, the full name, the email address and the Multi-Factor Authentication status.

== InitializeSystemAdministratorMFA ==
Initializes Multi-Factor Authentication for SPE system administrator.
The administrator has to finalize the setup of MFA on the next login at the Management Console.

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

== 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. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

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

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

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

== TransferStores ==
Copy the content of one or more archive store into another 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>sourceStores</tt>
| string
| Comma-separated list of one or more source archive stores.
|-
| <tt>targetStore</tt>
| number (optional)
| The target store of the messages to be copied. If not given, the archive store in the "current" state will be used.
|-
| <tt>startIndex</tt>
| string (optional)
| A string in the format "archiveStoreId:messageId". The transfer process starts with the this message.
|}

== 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade an archive store from an older version to the 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.
|}

== UpgradeStores ==
Upgrade all archive stores from an older version to the 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.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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 [[#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] 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.
|-
| <tt>loginPrivileges</tt>
| string (optional)
| Comma separated list of log in privileges. If not given, all login privileges are assigned.
|}

=== Argument Values ===

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

==== loginPrivileges ====
{{Template:Management_API_User_Login_Privileges}}

== DeleteAppPasswords ==
Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the 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
| The user name of the user whose app passwords shall be deleted.
|}

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

== DisableMFA ==
Disables multi-factor authentication of a 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
| The user name of the user for whom MFA shall be disabled.
|}

[[Management_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a 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.
|}

== CreateCredential ==
Create a new credential object that can be used by directory configuration settings or profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>type</tt>
| string
| Credential type. Supported values are: 
* <tt>Office365_Modern</tt> – credential for authenticating against Entra ID (Office 365 modern authentication). 
* <tt>SignedEnvelope</tt> – credential used for an export to MailStore Cloud.
|-
| <tt>description</tt>
| string
| Human readable description of the credential.
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== DeleteCredential ==
Delete an existing credential object.

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

== GetCredential ==
Get details of a single credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential whose details should be returned.
|}

== GetCredentials ==
Get the list of all credential objects and their details.

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

== SetCredentialDescription ==
Set the description of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>description</tt>
| string
| New human readable description of the credential.
|}

== SetCredentialSettings ==
Change configuration settings of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>createNewCertificate</tt>
| bool (optional)
| Indicates whether a new certificate should be created for this credential (<tt>true</tt>) or the existing certificate settings should be kept (<tt>false</tt>).
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== 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="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneId="$Local" --jobId=1''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|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 the list of available time zones and their IDs.

The ''id'' of the output can be used as ''timeZoneId'' in [[Management_API_-_Function_Reference#CreateJob|CreateJob]], [[Management_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Management_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Management_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

=== Arguments ===
{| 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)
| If given, must be equal to the current username. Filters results by current user.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2022-01-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== GetWorkerResultReport ==
Get the details of a profile execution result.

=== Arguments ===
{| class="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 ID of the result for which the details should be fetched.
|}

Use the [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.

== InitializeMFA ==
Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.
When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a 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
| The user name of the user for whom MFA shall be initialized.
|}

[[Management_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.

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

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

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. Setting an already automated profile to automatic again, will restart the profile.

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

== SetUserLoginPrivileges ==
Set login privileges 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>loginPrivileges</tt>
| string
| Comma separated list of login privileges.
|}

=== Argument Values ===

==== loginPrivileges ====
{{Management_API_User_Login_Privileges}}

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

== SetUserPrivilegesOnAllFolders ==
Set privileges on all folder for MailStore user, except for the folders that are excluded

=== Arguments ===
{| class="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 folder privileges.
|-
| <tt>excludeFolders</tt>
| string (optional)
| Comma separated list of folders to exclude.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>read</tt>
| The user is granted read access to the specified folders.
|-
| <tt>write</tt>
| The user is granted write access to the specified folders. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folders.
|}

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

2025-12-03T12:18:57Z

Ltalaschus:

__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>

== CreateSystemAdministratorAPIPassword==
Creates and returns the API passsword of the user that executes this API command.
Every SPE administrator has their own API password. Any previously created API password for this administrator is overwritten and therefore invalidated.

== DeactivateSystemAdministratorMFA ==
Deactivates Multi-Factor Authentication for SPE system administrator.

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

== 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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.
The list contains the name, the full name, the email address and the Multi-Factor Authentication status.

== InitializeSystemAdministratorMFA ==
Initializes Multi-Factor Authentication for SPE system administrator.
The administrator has to finalize the setup of MFA on the next login at the Management Console.

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

== 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. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

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

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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>* .safeMode</tt>
| All instances running in safe mode
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

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

== TransferStores ==
Copy the content of one or more archive store into another 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>sourceStores</tt>
| string
| Comma-separated list of one or more source archive stores.
|-
| <tt>targetStore</tt>
| number (optional)
| The target store of the messages to be copied. If not given, the archive store in the "current" state will be used.
|-
| <tt>startIndex</tt>
| string (optional)
| A string in the format "archiveStoreId:messageId". The transfer process starts with the this message.
|}

== 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <tt>* .stopped</tt>
| All stopped instances
|}

== UpgradeStore ==
Upgrade an archive store from an older version to the 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.
|}

== UpgradeStores ==
Upgrade all archive stores from an older version to the 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.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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 [[#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] 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.
|-
| <tt>loginPrivileges</tt>
| string (optional)
| Comma separated list of log in privileges. If not given, all login privileges are assigned.
|}

=== Argument Values ===

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

==== loginPrivileges ====
{{Template:Management_API_User_Login_Privileges}}

== DeleteAppPasswords ==
Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the 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
| The user name of the user whose app passwords shall be deleted.
|}

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

== DisableMFA ==
Disables multi-factor authentication of a 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
| The user name of the user for whom MFA shall be disabled.
|}

[[Management_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a 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.
|}

== CreateCredential ==
Create a new credential object that can be used by directory configuration settings or profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>type</tt>
| string
| Credential type. Supported values are: 
* <tt>Office365_Modern</tt> – credential for authenticating against Entra ID (Office 365 modern authentication). 
* <tt>SignedEnvelope</tt> – credential used for an export to MailStore Cloud.
|-
| <tt>description</tt>
| string
| Human readable description of the credential.
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== DeleteCredential ==
Delete an existing credential object.

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

== GetCredential ==
Get details of a single credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential whose details should be returned.
|}

== GetCredentials ==
Get the list of all credential objects and their details.

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

== SetCredentialDescription ==
Set the description of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>description</tt>
| string
| New human readable description of the credential.
|}

== SetCredentialSettings ==
Change configuration settings of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>createNewCertificate</tt>
| bool (optional)
| Indicates whether a new certificate should be created for this credential (<tt>true</tt>) or the existing certificate settings should be kept (<tt>false</tt>).
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== 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="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneId="$Local" --jobId=1''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|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 the list of available time zones and their IDs.

The ''id'' of the output can be used as ''timeZoneId'' in [[Management_API_-_Function_Reference#CreateJob|CreateJob]], [[Management_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Management_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Management_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

=== Arguments ===
{| 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)
| If given, must be equal to the current username. Filters results by current user.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2022-01-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== GetWorkerResultReport ==
Get the details of a profile execution result.

=== Arguments ===
{| class="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 ID of the result for which the details should be fetched.
|}

Use the [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.

== InitializeMFA ==
Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.
When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a 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
| The user name of the user for whom MFA shall be initialized.
|}

[[Management_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.

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

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

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. Setting an already automated profile to automatic again, will restart the profile.

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

== SetUserLoginPrivileges ==
Set login privileges 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>loginPrivileges</tt>
| string
| Comma separated list of login privileges.
|}

=== Argument Values ===

==== loginPrivileges ====
{{Management_API_User_Login_Privileges}}

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

== SetUserPrivilegesOnAllFolders ==
Set privileges on all folder for MailStore user, except for the folders that are excluded

=== Arguments ===
{| class="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 folder privileges.
|-
| <tt>excludeFolders</tt>
| string (optional)
| Comma separated list of folders to exclude.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>read</tt>
| The user is granted read access to the specified folders.
|-
| <tt>write</tt>
| The user is granted write access to the specified folders. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folders.
|}

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

2025-12-03T12:17:15Z

Ltalaschus: /* instanceFilter */

__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>

== CreateSystemAdministratorAPIPassword==
Creates and returns the API passsword of the user that executes this API command.
Every SPE administrator has their own API password. Any previously created API password for this administrator is overwritten and therefore invalidated.

== DeactivateSystemAdministratorMFA ==
Deactivates Multi-Factor Authentication for SPE system administrator.

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

== 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>* .safeMode</tt>
| All instances running in safe mode
|-
| <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.
The list contains the name, the full name, the email address and the Multi-Factor Authentication status.

== InitializeSystemAdministratorMFA ==
Initializes Multi-Factor Authentication for SPE system administrator.
The administrator has to finalize the setup of MFA on the next login at the Management Console.

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

== 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. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

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

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] 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.

== TransferStores ==
Copy the content of one or more archive store into another 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>sourceStores</tt>
| string
| Comma-separated list of one or more source archive stores.
|-
| <tt>targetStore</tt>
| number (optional)
| The target store of the messages to be copied. If not given, the archive store in the "current" state will be used.
|-
| <tt>startIndex</tt>
| string (optional)
| A string in the format "archiveStoreId:messageId". The transfer process starts with the this message.
|}

== 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 an archive store from an older version to the 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.
|}

== UpgradeStores ==
Upgrade all archive stores from an older version to the 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.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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 [[#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] 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.
|-
| <tt>loginPrivileges</tt>
| string (optional)
| Comma separated list of log in privileges. If not given, all login privileges are assigned.
|}

=== Argument Values ===

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

==== loginPrivileges ====
{{Template:Management_API_User_Login_Privileges}}

== DeleteAppPasswords ==
Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the 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
| The user name of the user whose app passwords shall be deleted.
|}

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

== DisableMFA ==
Disables multi-factor authentication of a 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
| The user name of the user for whom MFA shall be disabled.
|}

[[Management_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a 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.
|}

== CreateCredential ==
Create a new credential object that can be used by directory configuration settings or profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>type</tt>
| string
| Credential type. Supported values are: 
* <tt>Office365_Modern</tt> – credential for authenticating against Entra ID (Office 365 modern authentication). 
* <tt>SignedEnvelope</tt> – credential used for an export to MailStore Cloud.
|-
| <tt>description</tt>
| string
| Human readable description of the credential.
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== DeleteCredential ==
Delete an existing credential object.

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

== GetCredential ==
Get details of a single credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential whose details should be returned.
|}

== GetCredentials ==
Get the list of all credential objects and their details.

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

== SetCredentialDescription ==
Set the description of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>description</tt>
| string
| New human readable description of the credential.
|}

== SetCredentialSettings ==
Change configuration settings of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>createNewCertificate</tt>
| bool (optional)
| Indicates whether a new certificate should be created for this credential (<tt>true</tt>) or the existing certificate settings should be kept (<tt>false</tt>).
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== 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="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneId="$Local" --jobId=1''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|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 the list of available time zones and their IDs.

The ''id'' of the output can be used as ''timeZoneId'' in [[Management_API_-_Function_Reference#CreateJob|CreateJob]], [[Management_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Management_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Management_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

=== Arguments ===
{| 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)
| If given, must be equal to the current username. Filters results by current user.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2022-01-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== GetWorkerResultReport ==
Get the details of a profile execution result.

=== Arguments ===
{| class="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 ID of the result for which the details should be fetched.
|}

Use the [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.

== InitializeMFA ==
Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.
When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a 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
| The user name of the user for whom MFA shall be initialized.
|}

[[Management_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.

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

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

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. Setting an already automated profile to automatic again, will restart the profile.

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

== SetUserLoginPrivileges ==
Set login privileges 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>loginPrivileges</tt>
| string
| Comma separated list of login privileges.
|}

=== Argument Values ===

==== loginPrivileges ====
{{Management_API_User_Login_Privileges}}

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

== SetUserPrivilegesOnAllFolders ==
Set privileges on all folder for MailStore user, except for the folders that are excluded

=== Arguments ===
{| class="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 folder privileges.
|-
| <tt>excludeFolders</tt>
| string (optional)
| Comma separated list of folders to exclude.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>read</tt>
| The user is granted read access to the specified folders.
|-
| <tt>write</tt>
| The user is granted write access to the specified folders. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folders.
|}

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

Update Notices for MailStore SPE to version 25.1 or newer

2025-12-03T10:55:33Z

Ltalaschus: /* Update from version 24.x */

With version 25.1, MailStore is, for the first time, not fully backwards compatible with all older versions. In order to be independent of outdated Microsoft C++ runtime libraries, support for Firebird 3 and 2.5 had to be removed. An update to version 25.1 therefore requires that all internal archive stores have previously been updated to Firebird 4.

[[Instance_Management#Archive_Stores|Archive stores]] created with version 23.4 or a previous version use Firebird 3 or Firebird 2.5 as the database system. Firebird 4 was introduced with MailStore 24.2. Newly created archive stores have since been automatically created with Firebird 4 databases. Older archive stores must be updated manually.

All other [[Update_Notices|update notices for MailStore SPE can be found here]].

= About databases in MailStore =

MailStore SPE uses Firebird Embedded as a database system for the configuration and metadata of the archived emails. The configuration is stored in the so-called master database, the email metadata is stored in the archive store databases.

If a new Firebird version is supported in MailStore, the master database is automatically updated when the new version is started for the first time. This database can be updated in a reasonable amount of time without affecting operation.

The archive store databases are not updated automatically. Since this process can be lengthy and thus affect operation, the administrator must start it manually.

In order to be able to perform these database updates, MailStore must support both the old and the new Firebird version.

= Firebird's dependencies on C++ =

Firebird 4 has dependencies on Microsoft's C++ runtime library 2015-2022.
Firebird 3 has dependencies on Microsoft's C++ runtime library 2013.
Firebird 2.5 has dependencies on Microsoft's C++ runtime library 2010.

All of these runtime libraries were automatically installed with MailStore SPE up to version 24.4.

Microsoft has discontinued support for the C++ runtime libraries of versions 2013 and 2010.

= Changes in MailStore SPE 25.1 =

This MailStore version, as well as all newer versions, is no longer able to load or update old databases.

When the instance host service starts and loading instances' databases fails, a corresponding error message is stored in the Windows Application event log.

If the client tries to connect to a MailStore SPE instance that is trying to load an incompatible database, the client displays an error message that the database format is unsupported.

= What to do next? =

Depending on the initial situation, different steps are necessary to become independent of Firebird 3 and 2.5.

== Update from version 24.x ==

If you are currently using MailStore SPE 24.2 to 24.4, you must have updated the archive stores of all instances to Firebird 4 before being able to update to MailStore SPE 25.1 or newer. The dashboard in the Management Console and the [[Instance_Management#Archive_Stores|archive stores page]] will inform you whether this step is necessary.

[[File:Ms_spe_dashboard_archive_store_needs_upgrade.png]]

[[File:Ms_spe_archive_store_needs_upgrade.png]]

* Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.
* Change the status of disabled archive stores to ''write protected''.
* Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.

If a hint is displayed that an upgrade is required, follow these steps:

* Create a [[Backup_and_Restore|backup]].
* [[Instance_Management#Upgrade_All_Stores|Update all archive stores]].
* Create another [[Backup_and_Restore|backup]].
* Download and install the current MailStore SPE version [https://my.mailstore.com/Downloads/ServiceProviderEdition].
* Read the [[Update Notices]] for the current version up to version 24.2 and follow the instructions.

== Update from version 23.x and older ==

If you have previously used MailStore SPE 23.4 or older, you must perform an '''intermediate update''' before updating to the latest version.

A direct update to the latest version is not possible.

* Create a [[Backup and Restore|data backup]].
* Download MailStore SPE 24.4 [https://my.mailstore.com/Downloads/ServiceProviderEdition/24.4.0.22517 from here].
* Read the [[Update Notices]] for version 24.2 (!) and follow the instructions. You can ignore the known problems in this version because you are installing version 24.4, in which these problems have already been resolved.
* Install version 24.4 of MailStore SPE.
* Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.
* Right-click on the disabled archive stores and change the status to ''write protected''.
* Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.
* [[Instance_Management#Upgrade_All_Stores|Update all archive stores]].
* Create another [[Backup and Restore|data backup]].
* Download the latest MailStore SPE version [https://my.mailstore.com/Downloads/ServiceProviderEdition].
* Read the [[Update Notices]] for the current version up to version 24.2 and follow the instructions.
* Install the latest version of MailStore SPE.

== Updating individual instances and archive stores ==

If you have instances or [[Instance_Management#Store_Commands|archive stores detached]] or archives stores [[Instance_Management#Store_Commands|disabled]] because you do not need permanent access to their contents, their databases must also be updated to Firebird 4 in order to be able to load them into current MailStore SPE versions.

If your MailStore SPE installation is already on version 25.1 or newer, you cannot use this installation to update the instances and archive store databases. You need a second system on which you can perform the interim update.

Contact support in case you need to upgrade individual instances on a second installation.

== Restoring a backup ==

Backups that contain Firebird 3 or Firebird 2.5 databases cannot be read by MailStore 25.1 and newer.

If you restore such a backup, you must load it once with MailStore SPE 24.4 and update all archive store databases. The backup will then also be compatible with the current MailStore version.

Contact support in case you need to restore a backup on a second installation.

Update Notices for MailStore SPE to version 25.1 or newer

2025-12-03T10:53:44Z

Ltalaschus: /* Update from version 23.x and older */

With version 25.1, MailStore is, for the first time, not fully backwards compatible with all older versions. In order to be independent of outdated Microsoft C++ runtime libraries, support for Firebird 3 and 2.5 had to be removed. An update to version 25.1 therefore requires that all internal archive stores have previously been updated to Firebird 4.

[[Instance_Management#Archive_Stores|Archive stores]] created with version 23.4 or a previous version use Firebird 3 or Firebird 2.5 as the database system. Firebird 4 was introduced with MailStore 24.2. Newly created archive stores have since been automatically created with Firebird 4 databases. Older archive stores must be updated manually.

All other [[Update_Notices|update notices for MailStore SPE can be found here]].

= About databases in MailStore =

MailStore SPE uses Firebird Embedded as a database system for the configuration and metadata of the archived emails. The configuration is stored in the so-called master database, the email metadata is stored in the archive store databases.

If a new Firebird version is supported in MailStore, the master database is automatically updated when the new version is started for the first time. This database can be updated in a reasonable amount of time without affecting operation.

The archive store databases are not updated automatically. Since this process can be lengthy and thus affect operation, the administrator must start it manually.

In order to be able to perform these database updates, MailStore must support both the old and the new Firebird version.

= Firebird's dependencies on C++ =

Firebird 4 has dependencies on Microsoft's C++ runtime library 2015-2022.
Firebird 3 has dependencies on Microsoft's C++ runtime library 2013.
Firebird 2.5 has dependencies on Microsoft's C++ runtime library 2010.

All of these runtime libraries were automatically installed with MailStore SPE up to version 24.4.

Microsoft has discontinued support for the C++ runtime libraries of versions 2013 and 2010.

= Changes in MailStore SPE 25.1 =

This MailStore version, as well as all newer versions, is no longer able to load or update old databases.

When the instance host service starts and loading instances' databases fails, a corresponding error message is stored in the Windows Application event log.

If the client tries to connect to a MailStore SPE instance that is trying to load an incompatible database, the client displays an error message that the database format is unsupported.

= What to do next? =

Depending on the initial situation, different steps are necessary to become independent of Firebird 3 and 2.5.

== Update from version 24.x ==

If you are currently using MailStore SPE 24.2 to 24.4, you must have updated the archive stores of all instances to Firebird 4 before being able to update to MailStore SPE 25.1 or newer. The dashboard in the Management Console and the [[Instance_Management#Archive_Stores|archive stores page]] will inform you whether this step is necessary.

[[File:Ms_spe_dashboard_archive_store_needs_upgrade.png]]

[[File:Ms_spe_archive_store_needs_upgrade.png]]

* Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.
* Change the status of disabled archive stores to ''write protected''.
* Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.

If a hint is displayed that an upgrade is required, follow these steps:

* Create a [[Backup_and_Restore|backup]].
* [[Instance_Management#Upgrade_All_Stores|Update all archive stores]].
* Create another [[Backup_and_Restore|backup]].
* Download and install the current MailStore SPE version [https://my.mailstore.com/downloads].
* Read the [[Update Notices]] for the current version up to version 24.2 and follow the instructions.

== Update from version 23.x and older ==

If you have previously used MailStore SPE 23.4 or older, you must perform an '''intermediate update''' before updating to the latest version.

A direct update to the latest version is not possible.

* Create a [[Backup and Restore|data backup]].
* Download MailStore SPE 24.4 [https://my.mailstore.com/Downloads/ServiceProviderEdition/24.4.0.22517 from here].
* Read the [[Update Notices]] for version 24.2 (!) and follow the instructions. You can ignore the known problems in this version because you are installing version 24.4, in which these problems have already been resolved.
* Install version 24.4 of MailStore SPE.
* Make sure that no archive store has the status ''Disabled''. MailStore cannot determine whether these archive stores need to be updated.
* Right-click on the disabled archive stores and change the status to ''write protected''.
* Detached archive stores are not listed in the list of archive stores. Therefore attach detached archive stores and set them to ''write protected'' status.
* [[Instance_Management#Upgrade_All_Stores|Update all archive stores]].
* Create another [[Backup and Restore|data backup]].
* Download the latest MailStore SPE version [https://my.mailstore.com/Downloads/ServiceProviderEdition].
* Read the [[Update Notices]] for the current version up to version 24.2 and follow the instructions.
* Install the latest version of MailStore SPE.

== Updating individual instances and archive stores ==

If you have instances or [[Instance_Management#Store_Commands|archive stores detached]] or archives stores [[Instance_Management#Store_Commands|disabled]] because you do not need permanent access to their contents, their databases must also be updated to Firebird 4 in order to be able to load them into current MailStore SPE versions.

If your MailStore SPE installation is already on version 25.1 or newer, you cannot use this installation to update the instances and archive store databases. You need a second system on which you can perform the interim update.

Contact support in case you need to upgrade individual instances on a second installation.

== Restoring a backup ==

Backups that contain Firebird 3 or Firebird 2.5 databases cannot be read by MailStore 25.1 and newer.

If you restore such a backup, you must load it once with MailStore SPE 24.4 and update all archive store databases. The backup will then also be compatible with the current MailStore version.

Contact support in case you need to restore a backup on a second installation.

Management API - Function Reference

2025-11-21T13:20:02Z

Ltalaschus: /* GetCredentials */

__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>

== CreateSystemAdministratorAPIPassword==
Creates and returns the API passsword of the user that executes this API command.
Every SPE administrator has their own API password. Any previously created API password for this administrator is overwritten and therefore invalidated.

== DeactivateSystemAdministratorMFA ==
Deactivates Multi-Factor Authentication for SPE system administrator.

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

== 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.
The list contains the name, the full name, the email address and the Multi-Factor Authentication status.

== InitializeSystemAdministratorMFA ==
Initializes Multi-Factor Authentication for SPE system administrator.
The administrator has to finalize the setup of MFA on the next login at the Management Console.

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

== 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. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

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

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] 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.

== TransferStores ==
Copy the content of one or more archive store into another 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>sourceStores</tt>
| string
| Comma-separated list of one or more source archive stores.
|-
| <tt>targetStore</tt>
| number (optional)
| The target store of the messages to be copied. If not given, the archive store in the "current" state will be used.
|-
| <tt>startIndex</tt>
| string (optional)
| A string in the format "archiveStoreId:messageId". The transfer process starts with the this message.
|}

== 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 an archive store from an older version to the 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.
|}

== UpgradeStores ==
Upgrade all archive stores from an older version to the 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.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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 [[#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] 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.
|-
| <tt>loginPrivileges</tt>
| string (optional)
| Comma separated list of log in privileges. If not given, all login privileges are assigned.
|}

=== Argument Values ===

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

==== loginPrivileges ====
{{Template:Management_API_User_Login_Privileges}}

== DeleteAppPasswords ==
Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the 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
| The user name of the user whose app passwords shall be deleted.
|}

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

== DisableMFA ==
Disables multi-factor authentication of a 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
| The user name of the user for whom MFA shall be disabled.
|}

[[Management_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a 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.
|}

== CreateCredential ==
Create a new credential object that can be used by directory configuration settings or profiles.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>type</tt>
| string
| Credential type. Supported values are: 
* <tt>Office365_Modern</tt> – credential for authenticating against Entra ID (Office 365 modern authentication). 
* <tt>SignedEnvelope</tt> – credential used for an export to MailStore Cloud.
|-
| <tt>description</tt>
| string
| Human readable description of the credential.
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== DeleteCredential ==
Delete an existing credential object.

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

== GetCredential ==
Get details of a single credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential whose details should be returned.
|}

== GetCredentials ==
Get the list of all credential objects and their details.

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

== SetCredentialDescription ==
Set the description of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>description</tt>
| string
| New human readable description of the credential.
|}

== SetCredentialSettings ==
Change configuration settings of an existing credential object.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of the MailStore instance in which this command is invoked.
|-
| <tt>id</tt>
| int
| Unique ID of the credential to modify.
|-
| <tt>createNewCertificate</tt>
| bool (optional)
| Indicates whether a new certificate should be created for this credential (<tt>true</tt>) or the existing certificate settings should be kept (<tt>false</tt>).
|-
| <tt>tenantId</tt>
| string (optional)
| Tenant identifier used for Office365_Modern type credentials.
|-
| <tt>applicationId</tt>
| string (optional)
| Application/client identifier used for Office365_Modern type credentials.
|}

== 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="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneId="$Local" --jobId=1''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|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 the list of available time zones and their IDs.

The ''id'' of the output can be used as ''timeZoneId'' in [[Management_API_-_Function_Reference#CreateJob|CreateJob]], [[Management_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Management_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Management_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

=== Arguments ===
{| 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)
| If given, must be equal to the current username. Filters results by current user.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2022-01-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== GetWorkerResultReport ==
Get the details of a profile execution result.

=== Arguments ===
{| class="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 ID of the result for which the details should be fetched.
|}

Use the [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.

== InitializeMFA ==
Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.
When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a 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
| The user name of the user for whom MFA shall be initialized.
|}

[[Management_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.

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

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

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. Setting an already automated profile to automatic again, will restart the profile.

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

== SetUserLoginPrivileges ==
Set login privileges 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>loginPrivileges</tt>
| string
| Comma separated list of login privileges.
|}

=== Argument Values ===

==== loginPrivileges ====
{{Management_API_User_Login_Privileges}}

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

== SetUserPrivilegesOnAllFolders ==
Set privileges on all folder for MailStore user, except for the folders that are excluded

=== Arguments ===
{| class="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 folder privileges.
|-
| <tt>excludeFolders</tt>
| string (optional)
| Comma separated list of folders to exclude.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>read</tt>
| The user is granted read access to the specified folders.
|-
| <tt>write</tt>
| The user is granted write access to the specified folders. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folders.
|}

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

2025-11-21T12:13:20Z

Ltalaschus: /* TestSystemSmtpConfiguration */

__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>

== CreateSystemAdministratorAPIPassword==
Creates and returns the API passsword of the user that executes this API command.
Every SPE administrator has their own API password. Any previously created API password for this administrator is overwritten and therefore invalidated.

== DeactivateSystemAdministratorMFA ==
Deactivates Multi-Factor Authentication for SPE system administrator.

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

== 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.
The list contains the name, the full name, the email address and the Multi-Factor Authentication status.

== InitializeSystemAdministratorMFA ==
Initializes Multi-Factor Authentication for SPE system administrator.
The administrator has to finalize the setup of MFA on the next login at the Management Console.

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

== 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. Must be given, when the encryption key cannot be read from the key file of the archive store.
|-
| <tt>recoverDeletedMessages</tt>
| bool (optional)
| Defines whether to recover deleted messages.
|}

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

== RecreateRecoveryRecords ==
Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] 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.

== TransferStores ==
Copy the content of one or more archive store into another 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>sourceStores</tt>
| string
| Comma-separated list of one or more source archive stores.
|-
| <tt>targetStore</tt>
| number (optional)
| The target store of the messages to be copied. If not given, the archive store in the "current" state will be used.
|-
| <tt>startIndex</tt>
| string (optional)
| A string in the format "archiveStoreId:messageId". The transfer process starts with the this message.
|}

== 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 an archive store from an older version to the 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.
|}

== UpgradeStores ==
Upgrade all archive stores from an older version to the 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.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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. Default: true. May be slow when running on slow hardware.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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 [[#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] 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.
|-
| <tt>loginPrivileges</tt>
| string (optional)
| Comma separated list of log in privileges. If not given, all login privileges are assigned.
|}

=== Argument Values ===

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

==== loginPrivileges ====
{{Template:Management_API_User_Login_Privileges}}

== DeleteAppPasswords ==
Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the 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
| The user name of the user whose app passwords shall be deleted.
|}

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

== DisableMFA ==
Disables multi-factor authentication of a 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
| The user name of the user for whom MFA shall be disabled.
|}

[[Management_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a 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.
|}

== GetCredentials ==
Get the list of credential objects and their details.

=== Arguments ===
{| 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="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneId="$Local" --jobId=1''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|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 the list of available time zones and their IDs.

The ''id'' of the output can be used as ''timeZoneId'' in [[Management_API_-_Function_Reference#CreateJob|CreateJob]], [[Management_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Management_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Management_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].

=== Arguments ===
{| 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)
| If given, must be equal to the current username. Filters results by current user.
|}

Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2022-01-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneID="$Local" --profileID=1 --userName="admin"''

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.

Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.

== GetWorkerResultReport ==
Get the details of a profile execution result.

=== Arguments ===
{| class="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 ID of the result for which the details should be fetched.
|}

Use the [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.

== InitializeMFA ==
Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.
When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a 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
| The user name of the user for whom MFA shall be initialized.
|}

[[Management_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.

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

== SendStatusReport ==
Send a status report to the given recipients.

=== Arguments ===
{| class="wikitable"
! width=150px | Name
! width=120px | Type
! Description
|-
| <tt>instanceID</tt>
| string
| Unique ID of MailStore instance in which this command is invoked.
|-
| <tt>timespan</tt>
| string
| Timespan that is covered by the status report.
|-
| <tt>timeZoneId</tt>
| string
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
|-
| <tt>recipients</tt>
| string
| Comma separated list of recipients that will receive the status report.
|}

Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
=== Argument Values ===

==== Timespan ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>today</tt>
| The day when the status report is sent.
|-
| <tt>yesterday</tt>
| The day before the status report is sent.
|-
| <tt>thisweek</tt>
| The week when the status report is sent.
|-
| <tt>lastweek</tt>
| The week before the status report is sent.
|-
| <tt>thismonth</tt>
| The month when the status report is sent.
|-
| <tt>lastmonth</tt>
| The month before the status report is sent.
|}

== 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 [[Management_API_-_Function_Reference#GetTimeZones|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>
| bool
| Enables (true) or disables (false) the profile's server-side automation.
|-
| <tt>automaticPauseBetweenExecutions</tt>
| number (optional)
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
|-
| <tt>automaticMaintenanceWindows</tt>
| string (optional)
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
|}

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. Setting an already automated profile to automatic again, will restart the profile.

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

== SetUserLoginPrivileges ==
Set login privileges 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>loginPrivileges</tt>
| string
| Comma separated list of login privileges.
|}

=== Argument Values ===

==== loginPrivileges ====
{{Management_API_User_Login_Privileges}}

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

== SetUserPrivilegesOnAllFolders ==
Set privileges on all folder for MailStore user, except for the folders that are excluded

=== Arguments ===
{| class="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 folder privileges.
|-
| <tt>excludeFolders</tt>
| string (optional)
| Comma separated list of folders to exclude.
|}

=== Argument Values ===

==== privileges ====
{| class="wikitable"
! width=270px | Name
! Description
|-
| <tt>read</tt>
| The user is granted read access to the specified folders.
|-
| <tt>write</tt>
| The user is granted write access to the specified folders. Messages can be moved within an archive.
|-
| <tt>delete</tt>
| The user is granted delete access to the specified folders.
|}

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

File:Ms spe file extensions.png

2025-10-27T10:50:58Z

Ltalaschus: Ltalaschus uploaded a new version of File:Ms spe file extensions.png

Python API Wrapper Tutorial

2025-10-01T12:38:14Z

Ltalaschus: /* Installation */

__NOTOC__
'''Important notice:''' The Python API wrapper for the MailStore Service Provider Edition Management API provided on this website, represents an example implementation of an API client. This wrapper should help system administrators and developers to quickly understand how the Management API of MailStore SPE works and how to use it in own scripts. Please understand that beyond this documentation no further support for the Python API wrapper is provided. Unless stated otherwise, the Python API wrapper as well as all related example scripts are released under the terms an conditions of the [[wikipedia:MIT_License|MIT License]].

This document explains the installation and usage of the Python API wrapper for the MailStore SPE Management API. In order to prevent loss of data, service interruption or other problems, it is highly recommended to use a non-productive test environment for this tutorial as well as for script development in general. The 30-day-trial version of MailStore Server is perfectly suited for this.

{{Template:API Service Provider Access}}

== Installation ==
The API wrapper library is tested against Python 3.7 and newer and is compatible with 32bit and 64bit versions of Python.

Python binaries for various operating systems can be downloaded from the [http://www.python.org/download/ Python download page] or installed using the package manager of most Linux distributions.

Additionally create a folder "mailstore" in the Python's site-packages directory and extract the files from the [[Media:python-api-wrapper.zip|Python API wrapper library]] into this folder.

In a UNIX like operating system the location of the site-packages directory can be found by executing the following command in a shell:

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
python3 -c "import site; print(site.getsitepackages())"
</source>

In Windows the location of the site-packages directory can be found by opening a ''cmd'', navigating in the Python3 installation directory and executing the following command:

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
python -c "import site; print(site.getsitepackages())"
</source>

== Instantiating the API Client ==
Before the API wrapper library can be used, it must first be imported with:

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
import mailstore
</source>

Now the ''mailstore.mgmt.SPEClient'' class can be instantiated as follows:

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
speClient = mailstore.mgmt.SPEClient(username="admin", password="admin", host="127.0.0.1", port=8474, instanceID="example")
</source>

Default values can be omitted. Credentials of an admin of the global SPE installation have to be used. Find a listing of all default values in the following table:

{| class="wikitable"
! width="150px" | Parameter
! width="100px" | Default Value
! Description
|-
| <tt>username</tt>
| admin
| Username used for connecting to the API.
|-
| <tt>password</tt>
| admin
| Password used for connecting to the API.
|-
| <tt>host</tt>
| 127.0.0.1
| Hostname or IP address of MailStore SPE Management Server.
|-
| <tt>port</tt>
| 8474
| TCP port on which the Management Server is listening for API requests.
|-
| <tt>autoHandleToken</tt>
| True
| If set to ''True'', the caller does not need to handle tokens of long running tasks, but instead has to wait for the result. When set to ''False'' and the ''statusCode'' is ''running'', a status token is returned and must be handled appropriately by the caller of the method. Further details about token handling is described the corresponding section [[#Automatic Token Handling|Automatic Token Handling]] of this document.
|-
| <tt>waitTime</tt>
| 1000
| Specifies the number of milliseconds the API should wait for a final result. Otherwise the process is treated as ''running'', in which case token handling as defined by the status of ''autoHandleToken'' becomes necessary.
|-
| <tt>callback</tt>
| None
| A callback function to which interim statuses of long running tasks should be passed. This allows keeping track of the tasks' progress even if ''autoHandleToken'' is enabled. This can be quite useful in order to notify users about the progress without having to deal with the token logic as a whole.
|-
| <tt>logLevel</tt>
| 2
| Has to be in the range ''0'' to ''4'', where 0 (''NONE'') has the lowest verbosity and 4 (''DEBUG'') the highest. The loglevels are defined in the following order (low to high verbosity) ''NONE'', ''ERROR'', ''WARNING'', ''INFO'' and ''DEBUG''. Log entries will always be printed to ''stdout''.
|-
| <tt>ignoreInvalidSSLCerts</tt>
| False
| Has to be set to ''True'' or ''False''. Has to be enabled if untrusted certificates are used, otherwise an error occurs when using recent Python versions (>= 3.4.3).
|-
| <tt>instanceID</tt>
| None
| The instance id of the instance for instance specific commands. Can be changed between calls by setting the ''instanceID'' variable of the instantiated ''SPEClient''.
|}

== Invoking API Method ==
After the API client has been successfully instantiated, API methods can easily be invoked. When the method call was successful, the ''statusCode'' is ''succeeded'' and the result is stored in the dictionary ''result'' as shown in the following example:

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
print(speClient.GetEnvironmentInfo()["result"])

{'userName': 'admin', 'systemProperties': {'operatingSystem': 'Microsoft Windows Server 2012 R2 Standard', 'totalPhysicalMemory': 2146942976, 'processors': ['Intel(R) Core(TM) i5-3470 CPU @ 3.20GHz']}, 'licenseeID': 10435, 'version': '9.0.3.9873', 'licenseeName': 'MailStore Software GmbH', 'copyright': 'Copyright (c) 2005-2014 MailStore Software GmbH', 'serverName': 'win-2012-r2-x64'}
</source>

If ''autoHandleToken'' was set to ''False'' and the ''statusCode'' returns ''running'', manual token handling is required as described in the [[#Auto Handle Token|Automatic Token Handling]] section.

For any other ''statusCode'' value than ''succeeded'' and ''running'' the occurrence of an error has to be assumed, in which further information such as the error message and error details are available in the dictionary ''error'' as shown below:

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">

speClient.instanceID = "example"
userInfo = speClient.GetUserInfo("john.doe")

if userInfo["statusCode"] == 'succeeded':
print(userInfo["result"]["emailAddresses"])
else:
print(userInfo["error"]["message"])
</source>

=== Examples ===
Create a list of all email addresses assigned to MailStore users.

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
speClient = mailstore.mgmt.SPEClient()
speClient.instanceID = "example"
emailAddresses = list()
for user in speClient.GetUsers()["result"]:
emailAddresses += speClient.GetUserInfo(user["userName"])["result"]["emailAddresses"]
print(emailAddresses)
</source>

Create a list of all admin users of all instances where the service provider access is enabled.

<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
speClient = mailstore.mgmt.SPEClient()

for instance in speClient.GetInstances("* .running")["result"]:
speClient.instanceID = instance["instanceID"]
if speClient.GetArchiveAdminEnabled()["result"]["value"]:
for user in speClient.GetUsers()["result"]:
if "admin" in speClient.GetUserInfo(user["userName"])["result"]["privileges"]:
print(instance["instanceID"], user["userName"])
</source>

== Long Running Tasks ==
The execution of certain API methods like ''VerifyStore'' may take several minutes or even hours until it finishes. There are different options available to deal with these long running tasks:

# [[#Automatic Token Handling|Automatic Token Handling]]
# [[#Automatic Token Handling with Callback Function|Automatic Token Handling with Callback Function]]
# [[#Manual Token Handling|Manual Token Handling]]

Generally it is recommended to expect that every method call can become a long running task, as this depends on the ''waitTime'' value, the called method but also the overall load on the server. Thus it is not advisable to globally turn off automatic token handling when instantiating the API client.

If desired, automatic token handling can be enabled or disabled for each invoked method by adding ''autoHandleToken=True/False'' to the method's argument list.

Once a method has been invoked with manual token handling or a callback function, it can be cancelled by using the ''CancelAsync'' method as described in [[#Cancelling Long Running Tasks|Cancelling Long Running Tasks]].

=== Automatic Token Handling ===
When ''autoHandleToken'' is set to ''True'' (default), the wrapper polls the status of long running tasks automatically in the background and will return the final result when the process has ended.

==== Code ====
<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
import mailstore

speClient = mailstore.mgmt.SPEClient(autoHandleToken=True)
speClient.instanceID = "example"
storeID = 1
print(speClient.VerifyStore(storeID))
</source>

==== Output ====
<source lang="text" smart-tabs="true" toolbar="false" gutter="false">
{'logOutput': None, 'statusText': None, 'error': None, 'percentProgress': 100, 'token': 'd242d822a59bd4db308eef8b85af7d2a', 'result': None, 'statusVersion': 71, 'statusCode': 'succeeded'}
</source>

=== Automatic Token Handling with Callback Function ===
If a caller wants to keep track of the progress of a long running task (i.e. to inform the user about the progress), although automatic token handling was enabled, he could pass a function as ''callback'' argument to the instance of the API client.

==== Code ====
<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
import mailstore

def showProgress(progress):
print(progress["logOutput"], end="", flush=True)

speClient = mailstore.mgmt.SPEClient(autoHandleToken=True, callback=showProgress, instanceID="example")
storeID = 2
print(speClient.VerifyStore(storeID))
</source>

==== Output ====
<source lang="text" smart-tabs="true" toolbar="false" gutter="false">
Verifying file group #3...
Creating a list of messages to be verified...
1249 messages are about to be verified.
Verifying...
100 messages verified...
200 messages verified...
300 messages verified...
400 messages verified...
500 messages verified...
600 messages verified...
700 messages verified...
800 messages verified...
900 messages verified...
1000 messages verified...
1100 messages verified...
1200 messages verified...
1249 messages verified.
Finished. No errors have been found.
{'error': None, 'result': None, 'logOutput': ' 1000 messages verified...\r\n 1100 messages verified...\r\n 1200 messages verified...\r\n 1249 messages verified.\r\nFinished. No errors have been found.\r\n', 'token': 'c56f032d9db263133c1a413f79744b84', 'statusVersion': 71, 'statusText': None, 'percentProgress': 100, 'statusCode': 'succeeded'}
</source>

=== Manual Token Handling ===
If ''autoHandleToken'' is set to ''False'' the caller must handle long running tasks and the corresponding tokens all by itself. To poll for status updates, the ''GetStatus'' method must be called periodically passing the last returned result as parameter. ''GetStatus'' will extract the status token itself, poll for the latest update and return the received data to the caller again. The main call has finished when the ''statusCode'' changes to something different than ''running''. Calling ''GetStatus'' without passing a status token will result in an exception.

==== Code ====
<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
import mailstore
import time

speClient = mailstore.mgmt.SPEClient(autoHandleToken=False)
speClient.instanceID = "example"
storeID = 3
status = speClient.VerifyStore(storeID)

while True:
if status["statusCode"] != "running":
break
print(status["logOutput"], end="", flush=True)
status = speClient.GetStatus(status)
time.sleep(1)
</source>

==== Output ====
<source lang="text" smart-tabs="true" toolbar="false" gutter="false">
Verifying file group #3...
Creating a list of messages to be verified...
1249 messages are about to be verified.
Verifying...
100 messages verified...
200 messages verified...
300 messages verified...
400 messages verified...
500 messages verified...
600 messages verified...
700 messages verified...
800 messages verified...
900 messages verified...
1000 messages verified...
1100 messages verified...
1200 messages verified...
1249 messages verified.
Finished. No errors have been found.
</source>

=== Cancelling Long Running Tasks ===
Tasks invoked by using the callback method or manual token handling, can be canceled at any time by using the ''CancelAsync'' method. Please notice that the API does not acknowledge the success of the cancellation request. Instead the caller must continue to monitor the ''statusCode'' of the canceled method.

==== Code ====
<source lang="python" smart-tabs="true" toolbar="false" gutter="false">
import mailstore
import time

speClient = mailstore.mgmt.SPEClient(autoHandleToken=False)
speClient.instanceID = "example"
storeID = 3
status = speClient.VerifyStore(storeID)

while True:
if status["statusCode"] != "running":
break
print(status["logOutput"], end="", flush=True)
status = speClient.GetStatus(status)
time.sleep(1)
speClient.CancelAsync(status)
</source>

==== Output ====
<source lang="text" smart-tabs="true" toolbar="false" gutter="false">
Verifying file group #3...
Creating a list of messages to be verified...
1249 messages are about to be verified.
Verifying...
100 messages verified...
200 messages verified...
300 messages verified...
400 messages verified...
500 messages verified...
600 messages verified...
700 messages verified...
800 messages verified...
900 messages verified...
1000 messages verified...
1100 messages verified...
</source>

== Methods Overview ==
All methods listed in the [[Management API - Function Reference|function reference]] are implemented in the Python API library. Use

pydoc3 mailstore.mgmt.SPEClient

to access the build in documentation, which also includes an overview of all methods and their parameters.

Ltalaschus: